pax_global_header00006660000000000000000000000064150740416130014513gustar00rootroot0000000000000052 comment=9cd989100e33623b0acd44c2edc14b6c8c89229b ntfsprogs-plus-1.0.0/000077500000000000000000000000001507404161300145175ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/.github/000077500000000000000000000000001507404161300160575ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/.github/workflows/000077500000000000000000000000001507404161300201145ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/.github/workflows/c-cpp.yml000066400000000000000000000010711507404161300216400ustar00rootroot00000000000000name: ntfsprogs-plus test CI on: push: branches: - main - next pull_request: branches: - main - next jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: install packages run: | sudo apt-get install libgcrypt20-dev sudo apt-get remove libntfs-3g89 - name: build ntfsprogs run: | ./autogen.sh ./configure make sudo make install - name: check ntfs test images run: | cd tests ./test_all_images.sh ntfsprogs-plus-1.0.0/AUTHORS000066400000000000000000000006161507404161300155720ustar00rootroot00000000000000ntfsprogs-plus Authors in alphabetical order: Namjae Jeon JaeHoon Sim Present authors of ntfs-3g in alphabetical order: Jean-Pierre Andre Alon Bar-Lev Martin Bene Dominique L Bouix Csaba Henk Bernhard Kaindl Erik Larsson Alejandro Pulver Szabolcs Szakacsits Miklos Szeredi Past authors in alphabetical order: Anton Altaparmakov Mario Emmenlauer Yuval Fledel Yura Pakhuchiy Richard Russon ntfsprogs-plus-1.0.0/COPYING000066400000000000000000000431221507404161300155540ustar00rootroot00000000000000 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. ntfsprogs-plus-1.0.0/COPYING.LIB000066400000000000000000000613031507404161300161620ustar00rootroot00000000000000 GNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 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. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, 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 library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, 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 companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. GNU LIBRARY GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, 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 library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete 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 distribute a copy of this License along with the Library. 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 Library or any portion of it, thus forming a work based on the Library, 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) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, 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 Library, 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 Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you 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. If distribution of 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 satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. 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. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library 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. 9. 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 Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library 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. 11. 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 Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library 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 Library. 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. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library 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. 13. The Free Software Foundation may publish revised and/or new versions of the Library 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 Library 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 Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, 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 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. 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 LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. 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 library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library 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 Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; 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. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! ntfsprogs-plus-1.0.0/CREDITS000066400000000000000000000017631507404161300155460ustar00rootroot00000000000000The following people have contributed directly or indirectly to the ntfs-3g project. Please let ntfs-3g-devel@lists.sf.net know if you believe someone is missing, or if you prefer not to be listed. Dominique L Bouix Csaba Henk Max Khon Auri Hautamäki Gergely Erdelyi Anton Altaparmakov Peter Boross Don Bright Mario Emmenlauer Yuval Fledel Kano from Kanotix Roland Kletzing Maarten Lankhorst Gergely Madarasz Patrick McLean Florent Mertens Yura Pakhuchiy Miklos Szeredi Bartosz Taudul Zhanglinbao Wade Fitzpatrick Carsten Einig Adam Cecile Bruno Damour Ales Fruman Curt McDowell Thomas Franken Jonatan Lambert Klaus Knopper Zhanglinbao Ismail Donmez Laszlo Dvornik Pallaghy Ajtony Szabolcs Szakacsits Alexei Alexandrov Albert D. Cahalan Russ Christensen Pete Curran Andras Erdei Matthew J. Fanto Marcin GibuƂa Christophe Grenier Ian Jackson Carmelo Kintana Jan Kratochvil Lode Leroy David MartĂ­nez Moreno Giang Nguyen Leonard NorrgĂ„rd Holger Ohmacht Per Olofsson Yuri Per Richard Russon Erik Sűrnes ntfsprogs-plus-1.0.0/ChangeLog000066400000000000000000000067041507404161300163000ustar00rootroot00000000000000CHANGE NOTES for ntfsprogs-plus v0.9.15 Fix checking adjustment of hole file length. Fix checking system directory like $Deleted. Mitigate check condition about orphan candidates. Downgrade mkfs error message to debug. v0.9.14 Fix comparison of wrong index block position for > 4k cluster size. Fix checking size and maximum bits of $BITMAP (index bitmap). The issue where corrupted lost+found directory could not be repaired has been fixed. Fix inproper checking for orphan inode. (Fix side effect of a44e83dd3b60cf1b9d854396d53c89ca51c9f520 patch) ETC Remove "Fix it" statement from print definitions. Move corrupted images for tests to separated repository. v0.9.13 Fix checking fsck lcnbmp over the maximum cluster number. Adjust maximum fsck bitmap buffer index count. Add checking cluster number of runlist which exceeds maximum cluster number. Add checking base mft record when open inode. Fix checking index entry length boundary condition. Do not delete system files when initialize root directory. ETC Fix static analysis issues. Restore ntfsresize utility. Rename ntfs-3g to ntfs Add progress bar and related option. Change output of error message to standard out(STDOUT) stream. Fix print condition on interactive mode. v0.9.12 Check and repair duplicate clusters problem. Fix some bugs. v0.9.11 Add support less than 4K cluster sizes. Fix lcnbitmap leakage when initialize index blocks. Improve index bitmap checking. v0.9.10 validate corrupted index entries in ntfsck_validate_index_blocks(). v0.9.9 Improve fsck performance(about 20%). Fix heap corruption when running fsck against 4K native HDD. Fix fsck mount failure if FILENAME attribute of $MFT is located in extent entry. v0.9.8 Add more exception handling if ictx->actx is NULL. Fix a crash by reinitializing 'icx' if icx->entry is the index end. v0.9.7 Fix segfault by accessing freed ->actx when ntfs_index_rm fail. v0.9.6 Change $MFT/$MFTMirror check logic. If $MFT is normal, then use it. And if $MFT is corrupted and $MFTMirr is normal, then use $MFTMirr. v0.9.5 Add more information in ntfsinfo. Other utils don't need to check Mirr and MFT. Add the check for index entry belongs to index block. Improve btree lookup performance to skip FILE_NAME_DOS entry. Avoid unneeded STD info attribute update. v0.9.4 * Fix nidata cache memory leak * Handle IO error when USB/HDD unplugged during fsck v0.9.3 * Modify index block check Re-lookup $INDEX_ROOT after calling ntfsck_validate_index_blocks() check $BITMAP size and $INDEX_ALLOCATION block check index block buffer overflow with $BITMAP * Consider multiple $FILE_NAME or multiple attribute check parent directory of $FILE_NAME and parent MFT number check multiple $FILE_NAME in orphaned file handling check comparing size of first(start VCN is zero) attribute's * Add checking return error of some functions check return error of ntfs_inode_attach_all_extents(), ntfs_inode_close() check base_mft_record value of MFT record * Modify inode index block bitmap check * Other fixes Fix mismatch of fsck error count and fixed count Do not initialize directory entry when modified size is zero Fix return value check of test script * Resolve static analysis issues v0.9.2 Mark the MFT record as not in use if it wasn't marked in bitmap. Recover MFT if MFT and MFTMirr is different using memcmp. Handle MFT bitmap free, but MFT record is in-use. Add missing checks for MFT Record fields. Add file flags check same as kernel does Check return value of ntfs_attrs_walk() ntfsprogs-plus-1.0.0/Makefile.am000066400000000000000000000017321507404161300165560ustar00rootroot00000000000000 AUTOMAKE_OPTIONS = gnu ACLOCAL_AMFLAGS = -I m4 EXTRA_DIST = AUTHORS CREDITS COPYING autogen.sh MAINTAINERCLEANFILES=\ $(srcdir)/configure \ $(srcdir)/Makefile.in \ $(srcdir)/aclocal.m4 \ $(srcdir)/compile \ $(srcdir)/depcomp \ $(srcdir)/install-sh \ $(srcdir)/ltmain.sh \ $(srcdir)/missing \ $(srcdir)/config.guess \ $(srcdir)/config.sub \ $(srcdir)/config.h.in \ $(srcdir)/config.h.in~ \ $(srcdir)/INSTALL \ $(srcdir)/m4/ltsugar.m4 \ $(srcdir)/m4/libtool.m4 \ $(srcdir)/m4/ltversion.m4 \ $(srcdir)/m4/lt~obsolete.m4 \ $(srcdir)/m4/ltoptions.m4 SUBDIRS = include libntfs src doc_DATA = README.md dist-hook: $(MKDIR_P) "$(distdir)/m4" libtool: $(LIBTOOL_DEPS) $(SHELL) ./config.status --recheck libs: (cd libntfs && $(MAKE) libs) || exit 1; libntfs: (cd libntfs && $(MAKE) libs) || exit 1; ntfsprogs: libntfs (cd src && $(MAKE)) || exit 1; strip: (cd src && $(MAKE) strip) || exit 1; extra: extras extras: libs (cd src && $(MAKE) extras) || exit 1; ntfsprogs-plus-1.0.0/NEWS000066400000000000000000000000001507404161300152040ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/README.md000066400000000000000000000116301507404161300157770ustar00rootroot00000000000000# Overview ntfsprogs-plus project focus on filesystem utilities based on ntfs-3g project to support kernel ntfs filesystem. ntfsprogs-plus takes some utilities from ntfs-3g only what it need. (ntfs-3g consist of several useful utilities and user-level filesystem code using FUSE) ntfs-3g was the only solution to support ntfs for free in linux. They also support several tools to manage and debug ntfs filesystem like ntfsclone, ntfsinfo, ntfscluster. Those utilities are very useful, but ntfs-3g does not support filesystem check utility. They just support ntfsfix which is a utility that only fixes boot sector with mirror boot sector, and a rare bug case of Windows XP (called by self-located MFT), reset journal. So, ntfsprogs-plus try to implement checking filesystem utility which is named ntfsck. You may think ntfsck is a linux version of chkdsk of Windows. ntfsprogs-plus use a little modified ntfs-3g library for fsck. ntfs-3g have some memory bugs and restriction. ntfsprogs-plus also try to remove memory bug and restriction. At first release, ntfsck fully check filesystem and repair it. And not yet support journal replay. # Build and Install You can configure and set up build environment according to your condition. You should have GNU Build system (autoconf, automake, libtool) and some libraries to build ntfsprogs-plus. If you don't have them, you should install them. For ubuntu ``` sudo apt install build-essential automake autoconf libtool sudo apt install libgcrypt20-dev libasan8 ``` For redhat ``` yum install automake autoconf libtool yum install libgcrypt20-dev libasan8 ``` If packages have the version number like as libgcrypt20-dev / libasan8, you'd better to use 'search' command to find proper version of your system. ``` sudo apt search libgcrypt // For ubuntu series sudo yum search libasan // For redhat series ``` If you're the first time to build ntfsprogs-plus, then you'd better to run 'autogen.sh' ``` $ ./autogen.sh ``` After that, you can build with make, if not configured, 'make' will execute configure command automatically. ``` $ make clean; make $ make install ``` You can configure ntfsprogs-plus with address sanitizer like below. ``` $ CFLAGS="-fsanitize=address -fno-omit-frame-pointer -g -pg" LDFLAGS="-fsanitize=address -ldl" ./configure ``` And you may enable debug ``` $ configure --enable-debug ``` If you want to compile with arm cross compiler, you can also configure. ``` $ ./configure --host=arm-linux-gnueabi --target=arm-linux-gnueabi ``` # Test You can test corrupted images in *tests* directory. Just execute script *test_all_images.sh* to test images like below. ``` $ cd tests $ ./test_all_images.sh ``` Script will download images and script from *https://github.com/ntfsprogs-plus/ntfs_corrupted_images* repository and test them. Default test branch is *main* branch, if you test other branch of corrupted image repository, you may execute script with branch name. ``` $ cd tests $ ./test_all_images.sh ``` During test, script will request your *sudo* previleges because of *mount* command. If your system need to get *sudo* previleges for executing *mount*, *unmount*, you should have it to test. # Utilities Usage ## ntfsck ntfs filesystem check utility. You can show with '--help' option to view detail options. Normally you may use '-a' option for automatic repair. '-n' option represent that do check but not repair. '-C' option return if the volume is dirty or clean. ``` ntfsck -a ntfsck -n ntfsck -C ``` ntfsck include basic filesystem checking features, like as below: - Boot sector check - Meta system files check - Inode and LCN Bitmap consistency check - Inode structure check - Essential attribute check - Runlist check - Attribute list check - Directory structure check - All checks for inode strcuture above - Directory index check - Directory index bitmap check - Cluster duplication check : If found cluster duplication. it copied to new clusters. ## ntfsclone ntfs disk dump utility. It can clone NTFS to a sparse file, special ntfsclone image or standard output. You may clone ntfs as an "image_file" with a ntfsclone image that clone only metadata of "device" by below command. ``` ntfsclone -s -O -m --ignore-fs-check ``` After cloning, you may restore dump file("dump_file") from ntfsclone image("image_file"). ``` ntfsclone -r -O ``` Now, you can check and analyze ntfs filesystem with "dump_file" ## ntfscluster ntfs utiliy that find inodes that contains a specific clusters. You can find inodes list that contains cluster described by "cluster range". You can also specify only one cluster to find inode include it. ``` ntfscluster -c ``` ## ntfsinfo ntfsinfo show all attributes of specified inode. You can look into more detail information of inode that consist of inode: ``` ntfsinfo -i ``` # License ntfsprogs-plus is published under GPLv2 license. ntfsprogs-plus-1.0.0/autogen.sh000077500000000000000000000015601507404161300165220ustar00rootroot00000000000000#!/bin/sh # Run this to generate configure, Makefile.in's, etc (autoreconf --version) < /dev/null > /dev/null 2>&1 || { (autoconf --version) < /dev/null > /dev/null 2>&1 || { echo echo "**Error**: You must have the GNU Build System (autoconf, automake, " echo "libtool, etc) to update the ntfsprogs-plus build system. Download the " echo "appropriate packages for your distribution, or get the source " echo "tar balls from ftp://ftp.gnu.org/pub/gnu/." exit 1 } echo echo "**Error**: Your version of autoconf is too old (you need at least 2.57)" echo "to update the ntfsprogs-plus build system. Download the appropriate " echo "updated package for your distribution, or get the source tar ball " echo "from ftp://ftp.gnu.org/pub/gnu/." exit 1 } echo Running autoreconf --verbose --install --force autoreconf --verbose --install --force ntfsprogs-plus-1.0.0/configure.ac000066400000000000000000000360061507404161300170120ustar00rootroot00000000000000# -*- Autoconf -*- # Process this file with autoconf to produce a configure script. # configure.ac - Source file to generate "./configure" to prepare package for # compilation. # # Copyright (c) 2000-2013 Anton Altaparmakov # Copyright (c) 2003 Jan Kratochvil # Copyright (c) 2005-2009 Szabolcs Szakacsits # Copyright (C) 2007-2008 Alon Bar-Lev # Copyright (C) 2023-2024 LG Electronics # # This program/include file 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/include file 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 (in the main directory of the ntfsprogs-plus # distribution in the file COPYING); if not, write to the Free Software # Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # Autoconf AC_PREREQ([2.59]) AC_INIT([ntfsprogs-plus],[1.0.0],[linkinjeon@kernel.org]) AC_CONFIG_SRCDIR([config.h.in]) LIBNTFS_VERSION="90" # Environment AC_CANONICAL_HOST AC_CANONICAL_TARGET # Automake AM_INIT_AUTOMAKE([]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIR([m4]) AM_MAINTAINER_MODE # Options AC_ARG_ENABLE( [debug], [AS_HELP_STRING([--enable-debug],[enable debugging code and output])], , [enable_debug="no"] ) AC_ARG_ENABLE( [warnings], [AS_HELP_STRING([--enable-warnings],[enable lots of compiler warnings])], , [enable_warnings="no"] ) AC_ARG_ENABLE( [pedantic], [AS_HELP_STRING([--enable-pedantic],[enable compile pedantic mode])], , [enable_pedantic="no"] ) AC_ARG_ENABLE( [really-static], [AS_HELP_STRING([--enable-really-static],[create fully static binaries])], , [enable_really_static="no"] ) AC_ARG_ENABLE( [ldscript], [AS_HELP_STRING([--enable-ldscript],[use ldscript instead of .so symlink])], , [enable_ldscript="no"] ) AC_ARG_ENABLE( [ldconfig], [AS_HELP_STRING([--disable-ldconfig],[do not update dynamic linker cache using ldconfig])], , [enable_ldconfig="yes"] ) AC_ARG_ENABLE( [library], [AS_HELP_STRING([--disable-library],[do not install libntfs but link it into ntfs])], , [enable_library="yes"] ) AC_ARG_ENABLE( [mtab], [AS_HELP_STRING([--disable-mtab],[disable and ignore usage of /etc/mtab])], , [enable_mtab="yes"] ) AC_ARG_ENABLE( [posix-acls], [AS_HELP_STRING([--enable-posix-acls],[enable POSIX ACL support])], , [enable_posix_acls="no"] ) AC_ARG_ENABLE( [xattr-mappings], [AS_HELP_STRING([--enable-xattr-mappings],[enable system extended attributes mappings])], , [enable_xattr_mappings="no"] ) AC_ARG_ENABLE( [device-default-io-ops], [AS_HELP_STRING([--disable-device-default-io-ops],[install default IO ops])], , [enable_device_default_io_ops="yes"] ) AC_ARG_ENABLE( [nfconv], [AS_HELP_STRING([--disable-nfconv],[disable the 'nfconv' patch, which adds support for Unicode normalization form conversion when built on Mac OS X @<:@default=enabled for Mac OS X@:>@])], [enable_nfconv="no"], [ case "${target_os}" in darwin*) enable_nfconv="yes" ;; *) enable_nfconv="no" ;; esac ] ) # pthread_rwlock_t requires _GNU_SOURCE #AC_GNU_SOURCE # Programs AC_PROG_CC(gcc cc) AC_PROG_LN_S AM_PROG_CC_C_O ifdef( [LT_INIT], [LT_INIT], [AC_PROG_LIBTOOL] ) # Checks for programs. #AC_PROG_CXX #AC_PROG_AWK #AC_PROG_CC #AC_PROG_CPP AC_PROG_INSTALL #AC_PROG_LN_S #AC_PROG_MAKE_SET #AC_PROG_RANLIB PKG_PROG_PKG_CONFIG AC_PATH_PROG([MV], [mv]) AC_PATH_PROG([RM], [rm]) AC_PATH_PROG([SED], [sed]) AC_ARG_VAR([LDCONFIG], [ldconfig utility]) AC_PATH_PROG([LDCONFIG], [ldconfig], [true], [/sbin /usr/sbin $PATH]) # Environment AC_MSG_CHECKING([Windows OS]) case "${target}" in *-mingw32*|*-winnt*|*-cygwin*) AC_MSG_RESULT([yes]) WINDOWS="yes" AC_DEFINE( [WINDOWS], [1], [Define to 1 if this is a Windows OS] ) ;; *) AC_MSG_RESULT([no]) WINDOWS="no" ;; esac if test "${enable_ldscript}" = "yes"; then AC_MSG_CHECKING([Output format]) OUTPUT_FORMAT="$(${CC} ${CFLAGS} ${LDFLAGS} -Wl,--verbose 2>&1 | ${SED} -n 's/^OUTPUT_FORMAT("\([[^"]]*\)",.*/\1/p')" if test -z "${OUTPUT_FORMAT}"; then AC_MSG_RESULT([None]) else AC_MSG_RESULT([${OUTPUT_FORMAT}]) OUTPUT_FORMAT="OUTPUT_FORMAT ( ${OUTPUT_FORMAT} )" fi fi # Libraries # Autodetect whether we can build crypto stuff or not. compile_crypto=false if test "$enable_crypto" != "no"; then have_libgcrypt=false AM_PATH_LIBGCRYPT(1.2.2, [ have_libgcrypt=true ], [ if test "$enable_crypto" = "yes"; then AC_MSG_ERROR([ntfsprogs-plus crypto code requires the gcrypt library.]) else AC_MSG_WARN([ntfsprogs-plus crypto code requires the gcrypt library.]) fi ]) have_libgnutls=false PKG_CHECK_MODULES(GNUTLS, gnutls >= 1.4.4, [ have_libgnutls=true ], if test "$enable_crypto" = "yes"; then AC_MSG_ERROR([ntfsprogs-plus crypto code requires the gnutls library.]) else AC_MSG_WARN([ntfsprogs-plus crypto code requires the gnutls library.]) fi ) if test "$have_libgcrypt" = "true"; then if test "$have_libgnutls" = "true"; then compile_crypto=true AC_DEFINE([ENABLE_CRYPTO], 1, [Define this to 1 if you want to enable support of encrypted files in libntfs and utilities.]) fi fi fi AM_CONDITIONAL(ENABLE_CRYPTO, $compile_crypto) # add --with-extra-includes and --with-extra-libs switch to ./configure all_libraries="$all_libraries $USER_LDFLAGS" all_includes="$all_includes $USER_INCLUDES" AC_SUBST(all_includes) AC_SUBST(all_libraries) # Specify support for generating DCE compliant UUIDs (aka GUIDs). We check if # uuid/uuid.h header is present and the uuid library is present that goes with # it and then check if uuid_generate() is present and usable. # # DCE UUIDs are enabled by default and can be disabled with the --disable-uuid # option to the configure script. AC_ARG_WITH(uuid, [ --with-uuid@<:@=PFX@:>@ generate DCE compliant UUIDs, with optional prefix to uuid library and headers @<:@default=detect@:>@ --without-uuid do not generate DCE compliant UUIDs], if test "$with_uuid" = "yes"; then extrapath=default elif test "$with_uuid" = "no"; then extrapath= else extrapath=$with_uuid fi, extrapath=default ) if test "x$extrapath" != "x"; then if test "x$extrapath" != "xdefault"; then MKNTFS_CPPFLAGS="$MKNTFS_CPPFLAGS -I$extrapath/include" MKNTFS_LIBS="$MKNTFS_LIBS -L$extrapath/lib" fi search_for_luuid="yes" AC_CHECK_HEADER([uuid/uuid.h], [], [ AC_MSG_WARN([ntfsprogs-plus DCE compliant UUID generation code requires the uuid library.]) search_for_luuid="no" ], ) if test "x$search_for_luuid" != "xno"; then # Look for uuid_generate in the standard C library. AC_CHECK_FUNC([uuid_generate], [ AC_DEFINE([ENABLE_UUID], 1, [Define this to 1 if you want to enable generation of DCE compliant UUIDs.]) search_for_luuid="no" ], [], ) fi if test "x$search_for_luuid" != "xno"; then # Look for uuid_generate in the 'uuid' library. AC_CHECK_LIB([uuid], [uuid_generate], [ AC_DEFINE([ENABLE_UUID], 1, [Define this to 1 if you want to enable generation of DCE compliant UUIDs.]) MKNTFS_LIBS="$MKNTFS_LIBS -luuid" search_for_luuid="no" ], [], ) fi if test "x$search_for_luuid" != "xno"; then AC_MSG_WARN([ntfsprogs-plus DCE compliant UUID generation code requires the uuid library.]) fi fi # Specify support for obtaining the correct BIOS legacy geometry needed for # Windows to boot in CHS mode. We check if hd.h header is present and the hd # library is present that goes with it and then check if the hd_list() function # is present and usable. # # Using the hd library is enabled by default and can be disabled with the # --disable-hd option to the configure script. AC_ARG_WITH(hd, [ --with-hd@<:@=PFX@:>@ use Windows compliant disk geometry, with optional prefix to hd library and headers @<:@default=detect@:>@ --without-hd do not use Windows compliant disk geometry], if test "$with_hd" = "yes"; then extrapath2=default elif test "$with_hd" = "no"; then extrapath2= else extrapath2=$with_hd fi, extrapath2=default ) if test "x$extrapath2" != "x"; then if test "x$extrapath2" != "xdefault"; then LIBNTFS_CPPFLAGS="$LIBNTFS_CPPFLAGS -I$extrapath2/include" LIBNTFS_LIBS="$LIBNTFS_LIBS -L$extrapath2/lib" fi AC_CHECK_HEADER([hd.h], AC_CHECK_LIB([hd], [hd_list], AC_DEFINE([ENABLE_HD], 1, [Define this to 1 if you want to enable use of Windows compliant disk geometry.]) LIBNTFS_LIBS="$LIBNTFS_LIBS -lhd" NTFSPROGS_STATIC_LIBS="$NTFSPROGS_STATIC_LIBS -lhd", AC_MSG_WARN([ntfsprogs-plus Windows compliant geometry code requires the hd library.]), ), AC_MSG_WARN([ntfsprogs-plus Windows compliant geometry code requires the hd library.]), ) fi # Checks for header files. AC_HEADER_MAJOR AC_CHECK_HEADERS([ctype.h fcntl.h libgen.h libintl.h limits.h locale.h \ mntent.h stddef.h stdint.h stdlib.h stdio.h stdarg.h string.h \ strings.h errno.h time.h unistd.h utime.h wchar.h getopt.h features.h \ regex.h endian.h byteswap.h sys/byteorder.h sys/disk.h sys/endian.h \ sys/param.h sys/ioctl.h sys/mount.h sys/stat.h sys/types.h \ sys/vfs.h sys/statvfs.h linux/major.h linux/fd.h \ linux/fs.h inttypes.h linux/hdreg.h \ machine/endian.h windows.h syslog.h pwd.h malloc.h]) # Checks for typedefs, structures, and compiler characteristics. AC_HEADER_STDBOOL AC_TYPE_UID_T AC_C_BIGENDIAN( , [ AC_DEFINE( [WORDS_LITTLEENDIAN], [1], [Define to 1 if your processor stores words with the least significant byte first (like Intel and VAX, unlike Motorola and SPARC).] ) ] , ) AC_C_CONST AC_C_INLINE AC_TYPE_INT16_T AC_TYPE_INT32_T AC_TYPE_INT64_T AC_TYPE_INT8_T AC_TYPE_MODE_T AC_TYPE_OFF_T AC_TYPE_PID_T AC_TYPE_SIZE_T AC_TYPE_SSIZE_T AC_STRUCT_ST_BLOCKS AC_CHECK_MEMBERS([struct stat.st_rdev]) AC_TYPE_UINT16_T AC_TYPE_UINT32_T AC_TYPE_UINT64_T AC_TYPE_UINT8_T AC_CHECK_TYPES([ptrdiff_t]) # For the 'nfconv' patch (Mac OS X only): case "${target_os}" in darwin*) if test "${enable_nfconv}" = "yes"; then AC_CHECK_HEADER( [CoreFoundation/CoreFoundation.h], [ LDFLAGS="${LDFLAGS} -framework CoreFoundation" AC_DEFINE( [ENABLE_NFCONV], [1], [Define to 1 if the nfconv patch should be enabled] ) ], AC_MSG_ERROR([[Cannot find CoreFoundation required for 'nfconv' functionality Mac OS X. You may use the --disable-nfconv 'configure' option to avoid this error.]]) ) fi ;; esac # Checks for library functions. #AC_FUNC_FORK AC_FUNC_GETMNTENT #AC_FUNC_LSTAT_FOLLOWS_SLASHED_SYMLINK #AC_FUNC_MALLOC AC_FUNC_MBRTOWC AC_FUNC_MEMCMP AC_FUNC_STAT AC_FUNC_STRFTIME AC_FUNC_UTIME_NULL AC_FUNC_VPRINTF #AC_FUNC_REALLOC #AC_FUNC_STRNLEN AC_CHECK_FUNCS([ \ atexit basename daemon dup2 fdatasync ffs getopt_long hasmntopt \ mbsinit memmove memset realpath regcomp setlocale setxattr \ strcasecmp strchr strdup strerror strnlen strsep strtol strtoul \ sysconf utime utimensat gettimeofday clock_gettime fork memcpy random snprintf \ ]) AC_SYS_LARGEFILE # The dlopen API might be in libc or in libdl. Check libc first, then # fall back to libdl. LIBDL="" if test "x${disable_plugins}" = "xno"; then AC_CHECK_LIB(c, dlopen, , [AC_CHECK_LIB(dl, dlopen, [LIBDL="-ldl"], [AC_MSG_ERROR(["Unable to find libdl (required for external plugin support)"])])]) fi AC_SUBST([LIBDL]) if test "$GCC" = "yes" ; then # We add -Wall to enable some compiler warnings. CFLAGS="${CFLAGS} -Wall" fi if test "${enable_pedantic}" = "yes"; then enable_warnings="yes" CFLAGS="${CFLAGS} -pedantic" fi if test "${enable_warnings}" = "yes"; then CFLAGS="${CFLAGS} -W -Wall -Waggregate-return -Wbad-function-cast -Wcast-align -Wcast-qual -Wdisabled-optimization -Wdiv-by-zero -Wfloat-equal -Winline -Wmissing-declarations -Wmissing-format-attribute -Wmissing-noreturn -Wmissing-prototypes -Wmultichar -Wnested-externs -Wpointer-arith -Wredundant-decls -Wshadow -Wsign-compare -Wstrict-prototypes -Wundef -Wwrite-strings -Wformat -Wformat-security -Wuninitialized" fi if test "${enable_debug}" = "yes"; then CFLAGS="${CFLAGS} -ggdb3 -DDEBUG" AC_DEFINE( [ENABLE_DEBUG], [1], [Define to 1 if debug should be enabled] ) fi test "${enable_device_default_io_ops}" = "no" && AC_DEFINE( [NO_NTFS_DEVICE_DEFAULT_IO_OPS], [1], [Don't use default IO ops] ) test "${enable_mtab}" = "no" && AC_DEFINE([IGNORE_MTAB], [1], [Don't update /etc/mtab]) test "${enable_posix_acls}" != "no" && AC_DEFINE([POSIXACLS], [1], [POSIX ACL support]) test "${enable_xattr_mappings}" != "no" && AC_DEFINE([XATTR_MAPPINGS], [1], [system extended attributes mappings]) test "${disable_plugins}" != "no" && AC_DEFINE([DISABLE_PLUGINS], [1], [Define to 1 for disabling reparse plugins]) test "${enable_really_static}" = "yes" && enable_library="no" test "${enable_library}" = "no" && enable_ldconfig="no" if test "x${DISTCHECK_HACK}" != "x"; then enable_mount_helper="no" enable_ldconfig="no" fi # Settings pkgconfigdir="\$(libdir)/pkgconfig" ntfsincludedir="\$(includedir)" # Executables should be installed to the root filesystem, otherwise # automounting NTFS volumes can fail during boot if the driver binaries # and their dependencies are on an unmounted partition. Use --exec-prefix # to override this. if test "x${exec_prefix}" = "xNONE"; then rootbindir="/bin" rootsbindir="/sbin" rootlibdir="/lib${libdir##*/lib}" else rootbindir="\$(bindir)" rootsbindir="\$(sbindir)" rootlibdir="\$(libdir)" fi AC_SUBST([pkgconfigdir]) AC_SUBST([ntfsincludedir]) AC_SUBST([rootbindir]) AC_SUBST([rootsbindir]) AC_SUBST([rootlibdir]) AC_SUBST([LIBNTFS_VERSION]) AC_SUBST([MKNTFS_CPPFLAGS]) AC_SUBST([MKNTFS_LIBS]) AC_SUBST([LIBNTFS_CPPFLAGS]) AC_SUBST([LIBNTFS_LIBS]) AC_SUBST([NTFSPROGS_STATIC_LIBS]) AC_SUBST([OUTPUT_FORMAT]) AM_CONDITIONAL([GENERATE_LDSCRIPT], [test "${enable_ldscript}" = "yes"]) AM_CONDITIONAL([WINDOWS], [test "${WINDOWS}" = "yes"]) AM_CONDITIONAL([NTFS_DEVICE_DEFAULT_IO_OPS], [test "${enable_device_default_io_ops}" = "yes"]) AM_CONDITIONAL([RUN_LDCONFIG], [test "${enable_ldconfig}" = "yes"]) AM_CONDITIONAL([REALLYSTATIC], [test "${enable_really_static}" = "yes"]) AM_CONDITIONAL([INSTALL_LIBRARY], [test "${enable_library}" = "yes"]) AM_CONDITIONAL([ENABLE_EXTRAS], [test "${enable_extras}" = "yes"]) AM_CONDITIONAL([ENABLE_QUARANTINED], [test "${enable_quarantined}" = "yes"]) AM_CONDITIONAL([DISABLE_PLUGINS], [test "${disable_plugins}" != "no"]) # workaround for attr; * // attr now contains the next attribute. Do whatever you want * // with it and then just continue with the while loop. * } * if (err && errno != ENOENT) * // Ooops. An error occurred! You should handle this case. * // Now finished with all attributes in the inode. */ static __inline__ int ntfs_attrs_walk(ntfs_attr_search_ctx *ctx) { return ntfs_attr_lookup(AT_UNUSED, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx); } /** * struct ntfs_attr - ntfs in memory non-resident attribute structure * @rl: if not NULL, the decompressed runlist * @ni: base ntfs inode to which this attribute belongs * @type: attribute type * @name: Unicode name of the attribute * @name_len: length of @name in Unicode characters * @state: NTFS attribute specific flags describing this attribute * @allocated_size: copy from the attribute record * @data_size: copy from the attribute record * @initialized_size: copy from the attribute record * @compressed_size: copy from the attribute record * @compression_block_size: size of a compression block (cb) * @compression_block_size_bits: log2 of the size of a cb * @compression_block_clusters: number of clusters per cb * * This structure exists purely to provide a mechanism of caching the runlist * of an attribute. If you want to operate on a particular attribute extent, * you should not be using this structure at all. If you want to work with a * resident attribute, you should not be using this structure at all. As a * fail-safe check make sure to test NAttrNonResident() and if it is false, you * know you shouldn't be using this structure. * * If you want to work on a resident attribute or on a specific attribute * extent, you should use ntfs_lookup_attr() to retrieve the attribute (extent) * record, edit that, and then write back the mft record (or set the * corresponding ntfs inode dirty for delayed write back). * * @rl is the decompressed runlist of the attribute described by this * structure. Obviously this only makes sense if the attribute is not resident, * i.e. NAttrNonResident() is true. If the runlist hasn't been decompressed yet * @rl is NULL, so be prepared to cope with @rl == NULL. * * @ni is the base ntfs inode of the attribute described by this structure. * * @type is the attribute type (see layout.h for the definition of ATTR_TYPES), * @name and @name_len are the little endian Unicode name and the name length * in Unicode characters of the attribute, respectively. * * @state contains NTFS attribute specific flags describing this attribute * structure. See ntfs_attr_state_bits above. */ struct _ntfs_attr { runlist_element *rl; ntfs_inode *ni; ATTR_TYPES type; ATTR_FLAGS data_flags; ntfschar *name; u32 name_len; unsigned long state; s64 allocated_size; s64 data_size; s64 initialized_size; s64 compressed_size; u32 compression_block_size; u8 compression_block_size_bits; u8 compression_block_clusters; s8 unused_runs; /* pre-reserved entries available */ }; /** * enum ntfs_attr_state_bits - bits for the state field in the ntfs_attr * structure */ typedef enum { NA_Initialized, /* 1: structure is initialized. */ NA_NonResident, /* 1: Attribute is not resident. */ NA_BeingNonResident, /* 1: Attribute is being made not resident. */ NA_FullyMapped, /* 1: Attribute has been fully mapped */ NA_DataAppending, /* 1: Attribute is being appended to */ NA_ComprClosing, /* 1: Compressed attribute is being closed */ NA_RunlistDirty, /* 1: Runlist has been updated */ } ntfs_attr_state_bits; #define test_nattr_flag(na, flag) test_bit(NA_##flag, (na)->state) #define set_nattr_flag(na, flag) set_bit(NA_##flag, (na)->state) #define clear_nattr_flag(na, flag) clear_bit(NA_##flag, (na)->state) #define NAttrInitialized(na) test_nattr_flag(na, Initialized) #define NAttrSetInitialized(na) set_nattr_flag(na, Initialized) #define NAttrClearInitialized(na) clear_nattr_flag(na, Initialized) #define NAttrNonResident(na) test_nattr_flag(na, NonResident) #define NAttrSetNonResident(na) set_nattr_flag(na, NonResident) #define NAttrClearNonResident(na) clear_nattr_flag(na, NonResident) #define NAttrBeingNonResident(na) test_nattr_flag(na, BeingNonResident) #define NAttrSetBeingNonResident(na) set_nattr_flag(na, BeingNonResident) #define NAttrClearBeingNonResident(na) clear_nattr_flag(na, BeingNonResident) #define NAttrFullyMapped(na) test_nattr_flag(na, FullyMapped) #define NAttrSetFullyMapped(na) set_nattr_flag(na, FullyMapped) #define NAttrClearFullyMapped(na) clear_nattr_flag(na, FullyMapped) #define NAttrDataAppending(na) test_nattr_flag(na, DataAppending) #define NAttrSetDataAppending(na) set_nattr_flag(na, DataAppending) #define NAttrClearDataAppending(na) clear_nattr_flag(na, DataAppending) #define NAttrRunlistDirty(na) test_nattr_flag(na, RunlistDirty) #define NAttrSetRunlistDirty(na) set_nattr_flag(na, RunlistDirty) #define NAttrClearRunlistDirty(na) clear_nattr_flag(na, RunlistDirty) #define NAttrComprClosing(na) test_nattr_flag(na, ComprClosing) #define NAttrSetComprClosing(na) set_nattr_flag(na, ComprClosing) #define NAttrClearComprClosing(na) clear_nattr_flag(na, ComprClosing) #define GenNAttrIno(func_name, flag) \ extern int NAttr##func_name(ntfs_attr *na); \ extern void NAttrSet##func_name(ntfs_attr *na); \ extern void NAttrClear##func_name(ntfs_attr *na); GenNAttrIno(Compressed, FILE_ATTR_COMPRESSED) GenNAttrIno(Encrypted, FILE_ATTR_ENCRYPTED) GenNAttrIno(Sparse, FILE_ATTR_SPARSE_FILE) #undef GenNAttrIno /** * union attr_val - Union of all known attribute values * * For convenience. Used in the attr structure. */ typedef union { u8 _default; /* Unnamed u8 to serve as default when just using a_val without specifying any of the below. */ STANDARD_INFORMATION std_inf; ATTR_LIST_ENTRY al_entry; FILE_NAME_ATTR filename; OBJECT_ID_ATTR obj_id; SECURITY_DESCRIPTOR_ATTR sec_desc; VOLUME_NAME vol_name; VOLUME_INFORMATION vol_inf; DATA_ATTR data; INDEX_ROOT index_root; INDEX_BLOCK index_blk; BITMAP_ATTR bmp; REPARSE_POINT reparse; EA_INFORMATION ea_inf; EA_ATTR ea; PROPERTY_SET property_set; LOGGED_UTILITY_STREAM logged_util_stream; EFS_ATTR_HEADER efs; } attr_val; extern void ntfs_attr_init(ntfs_attr *na, const BOOL non_resident, const ATTR_FLAGS data_flags, const BOOL encrypted, const BOOL sparse, const s64 allocated_size, const s64 data_size, const s64 initialized_size, const s64 compressed_size, const u8 compression_unit); /* warning : in the following "name" has to be freeable */ /* or one of constants AT_UNNAMED, NTFS_INDEX_I30 or STREAM_SDS */ extern ntfs_attr *ntfs_attr_open(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len); extern void ntfs_attr_close(ntfs_attr *na); extern s64 ntfs_attr_pread(ntfs_attr *na, const s64 pos, s64 count, void *b); extern s64 ntfs_attr_pwrite(ntfs_attr *na, const s64 pos, s64 count, const void *b); extern int ntfs_attr_pclose(ntfs_attr *na); extern void *ntfs_attr_readall(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len, s64 *data_size); extern s64 ntfs_attr_mst_pread(ntfs_attr *na, const s64 pos, const s64 bk_cnt, const u32 bk_size, void *dst); extern s64 ntfs_attr_mst_pwrite(ntfs_attr *na, const s64 pos, s64 bk_cnt, const u32 bk_size, void *src); extern int ntfs_attr_map_runlist(ntfs_attr *na, VCN vcn); extern int ntfs_attr_map_whole_runlist(ntfs_attr *na); extern LCN ntfs_attr_vcn_to_lcn(ntfs_attr *na, const VCN vcn); extern runlist_element *ntfs_attr_find_vcn(ntfs_attr *na, const VCN vcn); extern int ntfs_attr_size_bounds_check(const ntfs_volume *vol, const ATTR_TYPES type, const s64 size); extern int ntfs_attr_can_be_resident(const ntfs_volume *vol, const ATTR_TYPES type); int ntfs_attr_make_non_resident(ntfs_attr *na, ntfs_attr_search_ctx *ctx); int ntfs_attr_force_non_resident(ntfs_attr *na); extern int ntfs_make_room_for_attr(MFT_RECORD *m, u8 *pos, u32 size); extern int ntfs_resident_attr_record_add(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, const u8 *val, u32 size, ATTR_FLAGS flags); extern int ntfs_non_resident_attr_record_add(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, VCN lowest_vcn, int dataruns_size, ATTR_FLAGS flags); extern int ntfs_attr_record_rm(ntfs_attr_search_ctx *ctx); extern int ntfs_attr_add(ntfs_inode *ni, ATTR_TYPES type, ntfschar *name, u8 name_len, const u8 *val, s64 size); extern int ntfs_attr_set_flags(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, ATTR_FLAGS flags, ATTR_FLAGS mask); extern int ntfs_attr_rm(ntfs_attr *na); extern int ntfs_attr_record_resize(MFT_RECORD *m, ATTR_RECORD *a, u32 new_size); extern int ntfs_resident_attr_value_resize(MFT_RECORD *m, ATTR_RECORD *a, const u32 new_size); extern int ntfs_attr_record_move_to(ntfs_attr_search_ctx *ctx, ntfs_inode *ni); extern int ntfs_attr_record_move_away(ntfs_attr_search_ctx *ctx, int extra); extern int ntfs_attr_update_mapping_pairs(ntfs_attr *na, VCN from_vcn); extern int ntfs_attr_truncate(ntfs_attr *na, const s64 newsize); extern int ntfs_attr_truncate_solid(ntfs_attr *na, const s64 newsize); /** * get_attribute_value_length - return the length of the value of an attribute * @a: pointer to a buffer containing the attribute record * * Return the byte size of the attribute value of the attribute @a (as it * would be after eventual decompression and filling in of holes if sparse). * If we return 0, check errno. If errno is 0 the actual length was 0, * otherwise errno describes the error. * * FIXME: Describe possible errnos. */ extern s64 ntfs_get_attribute_value_length(const ATTR_RECORD *a); /** * set_attribute_value_length - set the length of attribute * @a : pointer to a buffer containing the attribute reocrd * @length : length to set */ extern void ntfs_set_attribute_value_length(ATTR_RECORD *a, s64 length); /** * get_attribute_value - return the attribute value of an attribute * @vol: volume on which the attribute is present * @a: attribute to get the value of * @b: destination buffer for the attribute value * * Make a copy of the attribute value of the attribute @a into the destination * buffer @b. Note, that the size of @b has to be at least equal to the value * returned by get_attribute_value_length(@a). * * Return number of bytes copied. If this is zero check errno. If errno is 0 * then nothing was read due to a zero-length attribute value, otherwise * errno describes the error. */ extern s64 ntfs_get_attribute_value(const ntfs_volume *vol, const ATTR_RECORD *a, u8 *b); extern BOOL ntfs_is_valid_attr_type(const ATTR_RECORD *a); extern void ntfs_attr_name_free(char **name); extern char *ntfs_attr_name_get(const ntfschar *uname, const int uname_len); extern int ntfs_attr_exist(ntfs_inode *ni, const ATTR_TYPES type, const ntfschar *name, u32 name_len); extern int ntfs_attr_remove(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len); extern s64 ntfs_attr_get_free_bits(ntfs_attr *na); extern int ntfs_attr_data_read(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, char *buf, size_t size, off_t offset); extern int ntfs_attr_data_write(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, const char *buf, size_t size, off_t offset); extern int ntfs_attr_shrink_size(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, off_t offset); extern int ntfs_attr_inconsistent(ntfs_volume *vol, ATTR_RECORD *a, const MFT_REF mref, BOOL *fixed); extern int ntfs_attr_make_resident(ntfs_attr *na, ntfs_attr_search_ctx *ctx); extern int ntfs_non_resident_attr_shrink(ntfs_attr *na, const s64 newsize); #endif /* defined _NTFS_ATTRIB_H */ ntfsprogs-plus-1.0.0/include/attrlist.h000066400000000000000000000033211507404161300201600ustar00rootroot00000000000000/* * attrlist.h - Exports for attribute list attribute handling. * Originated from Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2004 Yura Pakhuchiy * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_ATTRLIST_H #define _NTFS_ATTRLIST_H #include "attrib.h" extern int ntfs_attrlist_need(ntfs_inode *ni); extern int ntfs_attrlist_entry_add(ntfs_inode *ni, ATTR_RECORD *attr); extern int ntfs_attrlist_entry_rm(ntfs_attr_search_ctx *ctx); /** * ntfs_attrlist_mark_dirty - set the attribute list dirty * @ni: ntfs inode which base inode contain dirty attribute list * * Set the attribute list dirty so it is written out later (at the latest at * ntfs_inode_close() time). * * This function cannot fail. */ static __inline__ void ntfs_attrlist_mark_dirty(ntfs_inode *ni) { if (ni->nr_extents == -1) NInoAttrListSetDirty(ni->base_ni); else NInoAttrListSetDirty(ni); } #endif /* defined _NTFS_ATTRLIST_H */ ntfsprogs-plus-1.0.0/include/bitmap.h000066400000000000000000000060361507404161300175740ustar00rootroot00000000000000/* * bitmap.h - Exports for bitmap handling. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_BITMAP_H #define _NTFS_BITMAP_H #include "types.h" #include "attrib.h" /* * NOTES: * * - Operations are 8-bit only to ensure the functions work both on little * and big endian machines! So don't make them 32-bit ops! * - bitmap starts at bit = 0 and ends at bit = bitmap size - 1. * - _Caller_ has to make sure that the bit to operate on is less than the * size of the bitmap. */ extern void ntfs_bit_set(u8 *bitmap, const u64 bit, const u8 new_value); extern char ntfs_bit_get(const u8 *bitmap, const u64 bit); extern char ntfs_bit_get_and_set(u8 *bitmap, const u64 bit, const u8 new_value); extern int ntfs_bitmap_set_run(ntfs_attr *na, s64 start_bit, s64 count); extern int ntfs_bitmap_clear_run(ntfs_attr *na, s64 start_bit, s64 count); #define BITS_PER_BYTE 8 #define BITS_PER_LONG (sizeof(unsigned long) * BITS_PER_BYTE) /** * ntfs_bitmap_set_bit - set a bit in a bitmap * @na: attribute containing the bitmap * @bit: bit to set * * Set the @bit in the bitmap described by the attribute @na. * * On success return 0 and on error return -1 with errno set to the error code. */ static __inline__ int ntfs_bitmap_set_bit(ntfs_attr *na, s64 bit) { return ntfs_bitmap_set_run(na, bit, 1); } /** * ntfs_bitmap_clear_bit - clear a bit in a bitmap * @na: attribute containing the bitmap * @bit: bit to clear * * Clear @bit in the bitmap described by the attribute @na. * * On success return 0 and on error return -1 with errno set to the error code. */ static __inline__ int ntfs_bitmap_clear_bit(ntfs_attr *na, s64 bit) { return ntfs_bitmap_clear_run(na, bit, 1); } /* * rol32 - rotate a 32-bit value left * * @word: value to rotate * @shift: bits to roll */ static __inline__ u32 ntfs_rol32(u32 word, unsigned int shift) { return (word << shift) | (word >> (32 - shift)); } /* * ror32 - rotate a 32-bit value right * * @word: value to rotate * @shift: bits to roll */ static __inline__ u32 ntfs_ror32(u32 word, unsigned int shift) { return (word >> shift) | (word << (32 - shift)); } #endif /* defined _NTFS_BITMAP_H */ ntfsprogs-plus-1.0.0/include/bootsect.h000066400000000000000000000030671507404161300201430ustar00rootroot00000000000000/* * bootsect.h - Exports for bootsector record handling. * Originated from the Linux-NTFS project. * * Copyright (c) 2000-2002 Anton Altaparmakov * Copyright (c) 2006 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_BOOTSECT_H #define _NTFS_BOOTSECT_H #include "types.h" #include "volume.h" #include "layout.h" /** * ntfs_boot_sector_is_ntfs - check a boot sector for describing an ntfs volume * @b: buffer containing the boot sector * * This function checks the boot sector in @b for describing a valid ntfs * volume. Return TRUE if @b is a valid NTFS boot sector or FALSE otherwise. */ extern BOOL ntfs_boot_sector_is_ntfs(NTFS_BOOT_SECTOR *b); extern int ntfs_boot_sector_parse(ntfs_volume *vol, const NTFS_BOOT_SECTOR *bs); #endif /* defined _NTFS_BOOTSECT_H */ ntfsprogs-plus-1.0.0/include/cache.h000066400000000000000000000064521507404161300173650ustar00rootroot00000000000000/* * cache.h : deal with indexed LRU caches * * Copyright (c) 2008-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_CACHE_H_ #define _NTFS_CACHE_H_ #include "volume.h" struct CACHED_GENERIC { struct CACHED_GENERIC *next; struct CACHED_GENERIC *previous; void *variable; size_t varsize; union ALIGNMENT payload[0]; } ; struct CACHED_INODE { struct CACHED_INODE *next; struct CACHED_INODE *previous; const char *pathname; size_t varsize; union ALIGNMENT payload[0]; /* above fields must match "struct CACHED_GENERIC" */ u64 inum; } ; struct CACHED_NIDATA { struct CACHED_NIDATA *next; struct CACHED_NIDATA *previous; const char *pathname; /* not used */ size_t varsize; /* not used */ union ALIGNMENT payload[0]; /* above fields must match "struct CACHED_GENERIC" */ u64 inum; ntfs_inode *ni; } ; struct CACHED_LOOKUP { struct CACHED_LOOKUP *next; struct CACHED_LOOKUP *previous; const char *name; size_t namesize; union ALIGNMENT payload[0]; /* above fields must match "struct CACHED_GENERIC" */ u64 parent; u64 inum; } ; enum { CACHE_FREE = 1, CACHE_NOHASH = 2 } ; typedef int (*cache_compare)(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *item); typedef void (*cache_free)(const struct CACHED_GENERIC *cached); typedef int (*cache_hash)(const struct CACHED_GENERIC *cached); struct HASH_ENTRY { struct HASH_ENTRY *next; struct CACHED_GENERIC *entry; } ; struct CACHE_HEADER { const char *name; struct CACHED_GENERIC *most_recent_entry; struct CACHED_GENERIC *oldest_entry; struct CACHED_GENERIC *free_entry; struct HASH_ENTRY *free_hash; struct HASH_ENTRY **first_hash; cache_free dofree; cache_hash dohash; unsigned long reads; unsigned long writes; unsigned long hits; int fixed_size; int max_hash; struct CACHED_GENERIC entry[0]; } ; /* cast to generic, avoiding gcc warnings */ #define GENERIC(pstr) ((const struct CACHED_GENERIC*)(const void*)(pstr)) struct CACHED_GENERIC *ntfs_fetch_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *wanted, cache_compare compare); struct CACHED_GENERIC *ntfs_enter_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *item, cache_compare compare); int ntfs_invalidate_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *item, cache_compare compare, int flags); int ntfs_remove_cache(struct CACHE_HEADER *cache, struct CACHED_GENERIC *item, int flags); void ntfs_create_lru_caches(ntfs_volume *vol); void ntfs_free_lru_caches(ntfs_volume *vol); #endif /* _NTFS_CACHE_H_ */ ntfsprogs-plus-1.0.0/include/collate.h000066400000000000000000000023101507404161300177320ustar00rootroot00000000000000/* * collate.h - Defines for NTFS collation handling. Originated from the Linux-NTFS * project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2005 Yura Pakhuchiy * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_COLLATE_H #define _NTFS_COLLATE_H #include "types.h" #include "volume.h" #define NTFS_COLLATION_ERROR -2 extern COLLATE ntfs_get_collate_function(COLLATION_RULES); #endif /* _NTFS_COLLATE_H */ ntfsprogs-plus-1.0.0/include/compat.h000066400000000000000000000046231507404161300176030ustar00rootroot00000000000000/* * compat.h - Tweaks for compatibility with non-Linux systems. * * Copyright (c) 2002 Richard Russon * Copyright (c) 2002-2004 Anton Altaparmakov * Copyright (c) 2008-2009 Szabolcs Szakacsits * Copyright (c) 2019 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_COMPAT_H #define _NTFS_COMPAT_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_SYS_PARAM_H #include #endif #include /* ENODATA */ #ifndef ENODATA #define ENODATA ENOENT #endif #ifndef ELIBBAD #define ELIBBAD ENOEXEC #endif #ifndef ELIBACC #define ELIBACC ENOENT #endif /* xattr APIs in macOS differs from Linux ones in that they expect the special * error code ENOATTR to be returned when an attribute cannot be found. So * define NTFS_NOXATTR_ERRNO to the appropriate "no xattr found" errno value for * the platform. */ #if defined(__APPLE__) || defined(__DARWIN__) #define NTFS_NOXATTR_ERRNO ENOATTR #else #define NTFS_NOXATTR_ERRNO ENODATA #endif #ifndef PATH_MAX #define PATH_MAX 4096 #endif #ifndef HAVE_FFS extern int ffs(int i); #endif /* HAVE_FFS */ #ifndef HAVE_DAEMON extern int daemon(int nochdir, int noclose); #endif /* HAVE_DAEMON */ #ifndef HAVE_STRSEP extern char *strsep(char **stringp, const char *delim); #endif /* HAVE_STRSEP */ #ifdef WINDOWS #define HAVE_STDIO_H /* mimic config.h */ #define HAVE_STDARG_H #define atoll _atoi64 #define fdatasync commit #define __inline__ inline #define __attribute__(X) /*nothing*/ #else /* !defined WINDOWS */ #ifndef O_BINARY #define O_BINARY 0 /* unix is binary by default */ #endif #endif /* defined WINDOWS */ #endif /* defined _NTFS_COMPAT_H */ ntfsprogs-plus-1.0.0/include/compress.h000066400000000000000000000027071507404161300201540ustar00rootroot00000000000000/* * compress.h - Exports for compressed attribute handling. * Originated from the Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_COMPRESS_H #define _NTFS_COMPRESS_H #include "types.h" #include "attrib.h" extern s64 ntfs_compressed_attr_pread(ntfs_attr *na, s64 pos, s64 count, void *b); extern s64 ntfs_compressed_pwrite(ntfs_attr *na, runlist_element *brl, s64 wpos, s64 offs, s64 to_write, s64 rounded, const void *b, int compressed_part, VCN *update_from); extern int ntfs_compressed_close(ntfs_attr *na, runlist_element *brl, s64 offs, VCN *update_from); #endif /* defined _NTFS_COMPRESS_H */ ntfsprogs-plus-1.0.0/include/debug.h000066400000000000000000000030231507404161300173770ustar00rootroot00000000000000/* * debug.h - Debugging output functions. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_DEBUG_H #define _NTFS_DEBUG_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "logging.h" struct _runlist_element; #ifdef DEBUG extern void ntfs_debug_runlist_dump(const struct _runlist_element *rl); #else static __inline__ void ntfs_debug_runlist_dump(const struct _runlist_element *rl __attribute__((unused))) {} #endif #define NTFS_BUG(msg) \ { \ int ___i = 1; \ ntfs_log_critical("Bug in %s(): %s\n", __FUNCTION__, msg); \ ntfs_log_debug("Forcing segmentation fault!"); \ ___i = ((int*)NULL)[___i]; \ } #endif /* defined _NTFS_DEBUG_H */ ntfsprogs-plus-1.0.0/include/device.h000066400000000000000000000126571507404161300175650ustar00rootroot00000000000000/* * device.h - Exports for low level device io. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2013 Anton Altaparmakov * Copyright (c) 2008-2013 Tuxera Inc. * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_DEVICE_H #define _NTFS_DEVICE_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "device_io.h" #include "types.h" #include "support.h" #include "volume.h" /** * enum ntfs_device_state_bits - * * Defined bits for the state field in the ntfs_device structure. */ typedef enum { ND_Open, /* 1: Device is open. */ ND_ReadOnly, /* 1: Device is read-only. */ ND_Dirty, /* 1: Device is dirty, needs sync. */ ND_Block, /* 1: Device is a block device. */ ND_Sync, /* 1: Device is mounted with "-o sync" */ } ntfs_device_state_bits; #define test_ndev_flag(nd, flag) test_bit(ND_##flag, (nd)->d_state) #define set_ndev_flag(nd, flag) set_bit(ND_##flag, (nd)->d_state) #define clear_ndev_flag(nd, flag) clear_bit(ND_##flag, (nd)->d_state) #define NDevOpen(nd) test_ndev_flag(nd, Open) #define NDevSetOpen(nd) set_ndev_flag(nd, Open) #define NDevClearOpen(nd) clear_ndev_flag(nd, Open) #define NDevReadOnly(nd) test_ndev_flag(nd, ReadOnly) #define NDevSetReadOnly(nd) set_ndev_flag(nd, ReadOnly) #define NDevClearReadOnly(nd) clear_ndev_flag(nd, ReadOnly) #define NDevDirty(nd) test_ndev_flag(nd, Dirty) #define NDevSetDirty(nd) set_ndev_flag(nd, Dirty) #define NDevClearDirty(nd) clear_ndev_flag(nd, Dirty) #define NDevBlock(nd) test_ndev_flag(nd, Block) #define NDevSetBlock(nd) set_ndev_flag(nd, Block) #define NDevClearBlock(nd) clear_ndev_flag(nd, Block) #define NDevSync(nd) test_ndev_flag(nd, Sync) #define NDevSetSync(nd) set_ndev_flag(nd, Sync) #define NDevClearSync(nd) clear_ndev_flag(nd, Sync) /** * struct ntfs_device - * * The ntfs device structure defining all operations needed to access the low * level device underlying the ntfs volume. * * Note d_heads and d_sectors_per_track are only set as a result of a call to * either ntfs_device_heads_get() or ntfs_device_sectors_per_track_get() (both * calls will set up both fields or if getting them failed they will be left at * -1). */ struct ntfs_device { struct ntfs_device_operations *d_ops; /* Device operations. */ unsigned long d_state; /* State of the device. */ char *d_name; /* Name of device. */ void *d_private; /* Private data used by the device operations. */ int d_heads; /* Disk geometry: number of heads or -1. */ int d_sectors_per_track; /* Disk geometry: number of sectors per track or -1. */ }; struct stat; /** * struct ntfs_device_operations - * * The ntfs device operations defining all operations that can be performed on * the low level device described by an ntfs device structure. */ struct ntfs_device_operations { int (*open)(struct ntfs_device *dev, int flags); int (*close)(struct ntfs_device *dev); s64 (*seek)(struct ntfs_device *dev, s64 offset, int whence); s64 (*read)(struct ntfs_device *dev, void *buf, s64 count); s64 (*write)(struct ntfs_device *dev, const void *buf, s64 count); s64 (*pread)(struct ntfs_device *dev, void *buf, s64 count, s64 offset); s64 (*pwrite)(struct ntfs_device *dev, const void *buf, s64 count, s64 offset); int (*sync)(struct ntfs_device *dev); int (*stat)(struct ntfs_device *dev, struct stat *buf); int (*ioctl)(struct ntfs_device *dev, unsigned long request, void *argp); }; extern struct ntfs_device *ntfs_device_alloc(const char *name, const long state, struct ntfs_device_operations *dops, void *priv_data); extern int ntfs_device_free(struct ntfs_device *dev); extern int ntfs_device_sync(struct ntfs_device *dev); extern s64 ntfs_pread(struct ntfs_device *dev, const s64 pos, s64 count, void *b); extern s64 ntfs_pwrite(struct ntfs_device *dev, const s64 pos, s64 count, const void *b); extern s64 ntfs_mst_pread(struct ntfs_device *dev, const s64 pos, s64 count, const u32 bksize, void *b); extern s64 ntfs_mst_pwrite(struct ntfs_device *dev, const s64 pos, s64 count, const u32 bksize, void *b); extern s64 ntfs_cluster_read(const ntfs_volume *vol, const s64 lcn, const s64 count, void *b); extern s64 ntfs_cluster_write(const ntfs_volume *vol, const s64 lcn, const s64 count, const void *b); extern s64 ntfs_device_size_get(struct ntfs_device *dev, int block_size); extern s64 ntfs_device_partition_start_sector_get(struct ntfs_device *dev); extern int ntfs_device_heads_get(struct ntfs_device *dev); extern int ntfs_device_sectors_per_track_get(struct ntfs_device *dev); extern int ntfs_device_sector_size_get(struct ntfs_device *dev); extern int ntfs_device_block_size_set(struct ntfs_device *dev, int block_size); #endif /* defined _NTFS_DEVICE_H */ ntfsprogs-plus-1.0.0/include/device_io.h000066400000000000000000000046411507404161300202460ustar00rootroot00000000000000/* * device_io.h - Exports for default device io. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2006 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_DEVICE_IO_H #define _NTFS_DEVICE_IO_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifndef NO_NTFS_DEVICE_DEFAULT_IO_OPS #if defined(linux) || defined(__uClinux__) || defined(__sun) \ || defined(__APPLE__) || defined(__DARWIN__) /* Make sure the presence of means compiling for Windows */ #undef HAVE_WINDOWS_H #endif #ifndef HAVE_WINDOWS_H /* Not for Windows use standard Unix style low level device operations. */ #define ntfs_device_default_io_ops ntfs_device_unix_io_ops #else /* HAVE_WINDOWS_H */ #ifndef HDIO_GETGEO # define HDIO_GETGEO 0x301 /** * struct hd_geometry - */ struct hd_geometry { unsigned char heads; unsigned char sectors; unsigned short cylinders; unsigned long start; }; #endif #ifndef BLKGETSIZE # define BLKGETSIZE 0x1260 #endif #ifndef BLKSSZGET # define BLKSSZGET 0x1268 #endif #ifndef BLKGETSIZE64 # define BLKGETSIZE64 0x80041272 #endif #ifndef BLKBSZSET # define BLKBSZSET 0x40041271 #endif /* On Windows (and Cygwin) : use Win32 low level device operations. */ #define ntfs_device_default_io_ops ntfs_device_win32_io_ops /* A few useful functions */ int ntfs_win32_set_sparse(int); int ntfs_win32_ftruncate(int fd, s64 size); int ntfs_device_win32_ftruncate(struct ntfs_device*, s64); #endif /* HAVE_WINDOWS_H */ /* Forward declaration. */ struct ntfs_device_operations; extern struct ntfs_device_operations ntfs_device_default_io_ops; #endif /* NO_NTFS_DEVICE_DEFAULT_IO_OPS */ #endif /* defined _NTFS_DEVICE_IO_H */ ntfsprogs-plus-1.0.0/include/dir.h000066400000000000000000000106621507404161300170760ustar00rootroot00000000000000/* * dir.h - Exports for directory handling. Originated from the Linux-NTFS project. * * Copyright (c) 2002 Anton Altaparmakov * Copyright (c) 2005-2006 Yura Pakhuchiy * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2005-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_DIR_H #define _NTFS_DIR_H #include "types.h" #define PATH_SEP '/' /* * We do not have these under DJGPP, so define our version that do not conflict * with other S_IFs defined under DJGPP. */ #ifdef DJGPP #ifndef S_IFLNK #define S_IFLNK 0120000 #endif #ifndef S_ISLNK #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK) #endif #ifndef S_IFSOCK #define S_IFSOCK 0140000 #endif #ifndef S_ISSOCK #define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK) #endif #endif /* * The little endian Unicode strings $I30, $SII, $SDH, $O, $Q, $R * as a global constant. */ extern ntfschar NTFS_INDEX_I30[5]; extern ntfschar NTFS_INDEX_SII[5]; extern ntfschar NTFS_INDEX_SDH[5]; extern ntfschar NTFS_INDEX_O[3]; extern ntfschar NTFS_INDEX_Q[3]; extern ntfschar NTFS_INDEX_R[3]; extern u64 ntfs_inode_lookup_by_name(ntfs_inode *dir_ni, const ntfschar *uname, const int uname_len); extern INDEX_ENTRY * __ntfs_inode_lookup_by_name(ntfs_inode *dir_ni, const ntfschar *uname, const int uname_len); extern u64 ntfs_inode_lookup_by_mbsname(ntfs_inode *dir_ni, const char *name); extern void ntfs_inode_update_mbsname(ntfs_inode *dir_ni, const char *name, u64 inum); extern ntfs_inode *ntfs_pathname_to_inode(ntfs_volume *vol, ntfs_inode *parent, const char *pathname); extern ntfs_inode *ntfs_create(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, mode_t type); extern ntfs_inode *ntfs_create_device(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, mode_t type, dev_t dev); extern ntfs_inode *ntfs_create_symlink(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, const ntfschar *target, int target_len); extern int ntfs_check_empty_dir(ntfs_inode *ni); extern int ntfs_delete(ntfs_volume *vol, const char *path, ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, u8 name_len); extern int ntfs_link(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, u8 name_len); /* * File types (adapted from include ) */ #define NTFS_DT_UNKNOWN 0 #define NTFS_DT_FIFO 1 #define NTFS_DT_CHR 2 #define NTFS_DT_DIR 4 #define NTFS_DT_BLK 6 #define NTFS_DT_REG 8 #define NTFS_DT_LNK 10 #define NTFS_DT_SOCK 12 #define NTFS_DT_WHT 14 #define NTFS_DT_REPARSE 32 /* * This is the "ntfs_filldir" function type, used by ntfs_readdir() to let * the caller specify what kind of dirent layout it wants to have. * This allows the caller to read directories into their application or * to have different dirent layouts depending on the binary type. */ typedef int (*ntfs_filldir_t)(void *dirent, const ntfschar *name, const int name_len, const int name_type, const s64 pos, const MFT_REF mref, const unsigned dt_type); extern int ntfs_readdir(ntfs_inode *dir_ni, s64 *pos, void *dirent, ntfs_filldir_t filldir); ntfs_inode *ntfs_dir_parent_inode(ntfs_inode *ni); u32 ntfs_interix_types(ntfs_inode *ni); int ntfs_get_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni, char *value, size_t size); int ntfs_set_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni, const char *value, size_t size, int flags); int ntfs_remove_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni); int ntfs_dir_link_cnt(ntfs_inode *ni); #if CACHE_INODE_SIZE struct CACHED_GENERIC; extern int ntfs_dir_inode_hash(const struct CACHED_GENERIC *cached); extern int ntfs_dir_lookup_hash(const struct CACHED_GENERIC *cached); #endif #endif /* defined _NTFS_DIR_H */ ntfsprogs-plus-1.0.0/include/ea.h000066400000000000000000000023041507404161300166770ustar00rootroot00000000000000/* * * Copyright (c) 2014-2021 Jean-Pierre Andre * */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef EA_H #define EA_H int ntfs_ea_check_wsldev(ntfs_inode *ni, dev_t *rdevp); int ntfs_ea_set_wsl_not_symlink(ntfs_inode *ni, mode_t mode, dev_t dev); int ntfs_get_ntfs_ea(ntfs_inode *ni, char *value, size_t size); int ntfs_set_ntfs_ea(ntfs_inode *ni, const char *value, size_t size, int flags); int ntfs_remove_ntfs_ea(ntfs_inode *ni); #endif /* EA_H */ ntfsprogs-plus-1.0.0/include/efs.h000066400000000000000000000021551507404161300170730ustar00rootroot00000000000000/* * * Copyright (c) 2009 Martin Bene * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef EFS_H #define EFS_H int ntfs_get_efs_info(ntfs_inode *ni, char *value, size_t size); int ntfs_set_efs_info(ntfs_inode *ni, const char *value, size_t size, int flags); int ntfs_efs_fixup_attribute(ntfs_attr_search_ctx *ctx, ntfs_attr *na); #endif /* EFS_H */ ntfsprogs-plus-1.0.0/include/endians.h000066400000000000000000000251571507404161300177460ustar00rootroot00000000000000/* * endians.h - Definitions related to handling of byte ordering. * Originated from the Linux-NTFS project. * * Copyright (c) 2000-2005 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_ENDIANS_H #define _NTFS_ENDIANS_H #ifdef HAVE_CONFIG_H #include "config.h" #endif /* * Notes: * We define the conversion functions including typecasts since the * defaults don't necessarily perform appropriate typecasts. * Also, using our own functions means that we can change them if it * turns out that we do need to use the unaligned access macros on * architectures requiring aligned memory accesses... */ #ifdef HAVE_ENDIAN_H #include #endif #ifdef HAVE_SYS_ENDIAN_H #include #endif #ifdef HAVE_MACHINE_ENDIAN_H #include #endif #ifdef HAVE_SYS_BYTEORDER_H #include #endif #ifdef HAVE_SYS_PARAM_H #include #endif #ifndef __BYTE_ORDER # if defined(_BYTE_ORDER) # define __BYTE_ORDER _BYTE_ORDER # define __LITTLE_ENDIAN _LITTLE_ENDIAN # define __BIG_ENDIAN _BIG_ENDIAN # elif defined(BYTE_ORDER) # define __BYTE_ORDER BYTE_ORDER # define __LITTLE_ENDIAN LITTLE_ENDIAN # define __BIG_ENDIAN BIG_ENDIAN # elif defined(__BYTE_ORDER__) && defined(__LITTLE_ENDIAN__) && \ defined(__BIG_ENDIAN__) # define __BYTE_ORDER __BYTE_ORDER__ # define __LITTLE_ENDIAN __LITTLE_ENDIAN__ # define __BIG_ENDIAN __BIG_ENDIAN__ # elif defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && \ defined(__ORDER_BIG_ENDIAN__) # define __BYTE_ORDER __BYTE_ORDER__ # define __LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__ # define __BIG_ENDIAN __ORDER_BIG_ENDIAN__ # elif (defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)) || \ defined(WORDS_LITTLEENDIAN) # define __BYTE_ORDER 1 # define __LITTLE_ENDIAN 1 # define __BIG_ENDIAN 0 # elif (!defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN)) || \ defined(WORDS_BIGENDIAN) # define __BYTE_ORDER 0 # define __LITTLE_ENDIAN 1 # define __BIG_ENDIAN 0 # else # error "__BYTE_ORDER is not defined." # endif #endif #define __ntfs_bswap_constant_16(x) \ (u16)((((u16)(x) & 0xff00) >> 8) | \ (((u16)(x) & 0x00ff) << 8)) #define __ntfs_bswap_constant_32(x) \ (u32)((((u32)(x) & 0xff000000u) >> 24) | \ (((u32)(x) & 0x00ff0000u) >> 8) | \ (((u32)(x) & 0x0000ff00u) << 8) | \ (((u32)(x) & 0x000000ffu) << 24)) #define __ntfs_bswap_constant_64(x) \ (u64)((((u64)(x) & 0xff00000000000000ull) >> 56) | \ (((u64)(x) & 0x00ff000000000000ull) >> 40) | \ (((u64)(x) & 0x0000ff0000000000ull) >> 24) | \ (((u64)(x) & 0x000000ff00000000ull) >> 8) | \ (((u64)(x) & 0x00000000ff000000ull) << 8) | \ (((u64)(x) & 0x0000000000ff0000ull) << 24) | \ (((u64)(x) & 0x000000000000ff00ull) << 40) | \ (((u64)(x) & 0x00000000000000ffull) << 56)) #ifdef HAVE_BYTESWAP_H # include #else # define bswap_16(x) __ntfs_bswap_constant_16(x) # define bswap_32(x) __ntfs_bswap_constant_32(x) # define bswap_64(x) __ntfs_bswap_constant_64(x) #endif #if defined(__LITTLE_ENDIAN) && (__BYTE_ORDER == __LITTLE_ENDIAN) #define __le16_to_cpu(x) (x) #define __le32_to_cpu(x) (x) #define __le64_to_cpu(x) (x) #define __cpu_to_le16(x) (x) #define __cpu_to_le32(x) (x) #define __cpu_to_le64(x) (x) #define __constant_le16_to_cpu(x) (x) #define __constant_le32_to_cpu(x) (x) #define __constant_le64_to_cpu(x) (x) #define __constant_cpu_to_le16(x) (x) #define __constant_cpu_to_le32(x) (x) #define __constant_cpu_to_le64(x) (x) #define __be16_to_cpu(x) bswap_16(x) #define __be32_to_cpu(x) bswap_32(x) #define __be64_to_cpu(x) bswap_64(x) #define __cpu_to_be16(x) bswap_16(x) #define __cpu_to_be32(x) bswap_32(x) #define __cpu_to_be64(x) bswap_64(x) #define __constant_be16_to_cpu(x) __ntfs_bswap_constant_16((u16)(x)) #define __constant_be32_to_cpu(x) __ntfs_bswap_constant_32((u32)(x)) #define __constant_be64_to_cpu(x) __ntfs_bswap_constant_64((u64)(x)) #define __constant_cpu_to_be16(x) __ntfs_bswap_constant_16((u16)(x)) #define __constant_cpu_to_be32(x) __ntfs_bswap_constant_32((u32)(x)) #define __constant_cpu_to_be64(x) __ntfs_bswap_constant_64((u64)(x)) #elif defined(__BIG_ENDIAN) && (__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) #define __constant_le16_to_cpu(x) __ntfs_bswap_constant_16((u16)(x)) #define __constant_le32_to_cpu(x) __ntfs_bswap_constant_32((u32)(x)) #define __constant_le64_to_cpu(x) __ntfs_bswap_constant_64((u64)(x)) #define __constant_cpu_to_le16(x) __ntfs_bswap_constant_16((u16)(x)) #define __constant_cpu_to_le32(x) __ntfs_bswap_constant_32((u32)(x)) #define __constant_cpu_to_le64(x) __ntfs_bswap_constant_64((u64)(x)) #define __be16_to_cpu(x) (x) #define __be32_to_cpu(x) (x) #define __be64_to_cpu(x) (x) #define __cpu_to_be16(x) (x) #define __cpu_to_be32(x) (x) #define __cpu_to_be64(x) (x) #define __constant_be16_to_cpu(x) (x) #define __constant_be32_to_cpu(x) (x) #define __constant_be64_to_cpu(x) (x) #define __constant_cpu_to_be16(x) (x) #define __constant_cpu_to_be32(x) (x) #define __constant_cpu_to_be64(x) (x) #else #error "You must define __BYTE_ORDER to be __LITTLE_ENDIAN or __BIG_ENDIAN." #endif /* Unsigned from LE to CPU conversion. */ #define le16_to_cpu(x) (u16)__le16_to_cpu((u16)(x)) #define le32_to_cpu(x) (u32)__le32_to_cpu((u32)(x)) #define le64_to_cpu(x) (u64)__le64_to_cpu((u64)(x)) #define le16_to_cpup(x) (u16)__le16_to_cpu(*(const u16*)(x)) #define le32_to_cpup(x) (u32)__le32_to_cpu(*(const u32*)(x)) #define le64_to_cpup(x) (u64)__le64_to_cpu(*(const u64*)(x)) /* Signed from LE to CPU conversion. */ #define sle16_to_cpu(x) (s16)__le16_to_cpu((s16)(x)) #define sle32_to_cpu(x) (s32)__le32_to_cpu((s32)(x)) #define sle64_to_cpu(x) (s64)__le64_to_cpu((s64)(x)) #define sle16_to_cpup(x) (s16)__le16_to_cpu(*(s16*)(x)) #define sle32_to_cpup(x) (s32)__le32_to_cpu(*(s32*)(x)) #define sle64_to_cpup(x) (s64)__le64_to_cpu(*(s64*)(x)) /* Unsigned from CPU to LE conversion. */ #define cpu_to_le16(x) (u16)__cpu_to_le16((u16)(x)) #define cpu_to_le32(x) (u32)__cpu_to_le32((u32)(x)) #define cpu_to_le64(x) (u64)__cpu_to_le64((u64)(x)) #define cpu_to_le16p(x) (u16)__cpu_to_le16(*(u16*)(x)) #define cpu_to_le32p(x) (u32)__cpu_to_le32(*(u32*)(x)) #define cpu_to_le64p(x) (u64)__cpu_to_le64(*(u64*)(x)) /* Signed from CPU to LE conversion. */ #define cpu_to_sle16(x) (s16)__cpu_to_le16((s16)(x)) #define cpu_to_sle32(x) (s32)__cpu_to_le32((s32)(x)) #define cpu_to_sle64(x) (s64)__cpu_to_le64((s64)(x)) #define cpu_to_sle16p(x) (s16)__cpu_to_le16(*(s16*)(x)) #define cpu_to_sle32p(x) (s32)__cpu_to_le32(*(s32*)(x)) #define cpu_to_sle64p(x) (s64)__cpu_to_le64(*(s64*)(x)) /* Unsigned from BE to CPU conversion. */ #define be16_to_cpu(x) (u16)__be16_to_cpu((u16)(x)) #define be32_to_cpu(x) (u32)__be32_to_cpu((u32)(x)) #define be64_to_cpu(x) (u64)__be64_to_cpu((u64)(x)) #define be16_to_cpup(x) (u16)__be16_to_cpu(*(const u16*)(x)) #define be32_to_cpup(x) (u32)__be32_to_cpu(*(const u32*)(x)) #define be64_to_cpup(x) (u64)__be64_to_cpu(*(const u64*)(x)) /* Signed from BE to CPU conversion. */ #define sbe16_to_cpu(x) (s16)__be16_to_cpu((s16)(x)) #define sbe32_to_cpu(x) (s32)__be32_to_cpu((s32)(x)) #define sbe64_to_cpu(x) (s64)__be64_to_cpu((s64)(x)) #define sbe16_to_cpup(x) (s16)__be16_to_cpu(*(s16*)(x)) #define sbe32_to_cpup(x) (s32)__be32_to_cpu(*(s32*)(x)) #define sbe64_to_cpup(x) (s64)__be64_to_cpu(*(s64*)(x)) /* Unsigned from CPU to BE conversion. */ #define cpu_to_be16(x) (u16)__cpu_to_be16((u16)(x)) #define cpu_to_be32(x) (u32)__cpu_to_be32((u32)(x)) #define cpu_to_be64(x) (u64)__cpu_to_be64((u64)(x)) #define cpu_to_be16p(x) (u16)__cpu_to_be16(*(u16*)(x)) #define cpu_to_be32p(x) (u32)__cpu_to_be32(*(u32*)(x)) #define cpu_to_be64p(x) (u64)__cpu_to_be64(*(u64*)(x)) /* Signed from CPU to BE conversion. */ #define cpu_to_sbe16(x) (s16)__cpu_to_be16((s16)(x)) #define cpu_to_sbe32(x) (s32)__cpu_to_be32((s32)(x)) #define cpu_to_sbe64(x) (s64)__cpu_to_be64((s64)(x)) #define cpu_to_sbe16p(x) (s16)__cpu_to_be16(*(s16*)(x)) #define cpu_to_sbe32p(x) (s32)__cpu_to_be32(*(s32*)(x)) #define cpu_to_sbe64p(x) (s64)__cpu_to_be64(*(s64*)(x)) /* Constant endianness conversion defines. */ #define const_le16_to_cpu(x) ((u16) __constant_le16_to_cpu(x)) #define const_le32_to_cpu(x) ((u32) __constant_le32_to_cpu(x)) #define const_le64_to_cpu(x) ((u64) __constant_le64_to_cpu(x)) #define const_cpu_to_le16(x) ((le16) __constant_cpu_to_le16(x)) #define const_cpu_to_le32(x) ((le32) __constant_cpu_to_le32(x)) #define const_cpu_to_le64(x) ((le64) __constant_cpu_to_le64(x)) #define const_sle16_to_cpu(x) ((s16) __constant_le16_to_cpu((le16) x)) #define const_sle32_to_cpu(x) ((s32) __constant_le32_to_cpu((le32) x)) #define const_sle64_to_cpu(x) ((s64) __constant_le64_to_cpu((le64) x)) #define const_cpu_to_sle16(x) ((sle16) __constant_cpu_to_le16((u16) x)) #define const_cpu_to_sle32(x) ((sle32) __constant_cpu_to_le32((u32) x)) #define const_cpu_to_sle64(x) ((sle64) __constant_cpu_to_le64((u64) x)) #define const_be16_to_cpu(x) ((u16) __constant_be16_to_cpu(x))) #define const_be32_to_cpu(x) ((u32) __constant_be32_to_cpu(x))) #define const_be64_to_cpu(x) ((u64) __constant_be64_to_cpu(x))) #define const_cpu_to_be16(x) ((be16) __constant_cpu_to_be16(x)) #define const_cpu_to_be32(x) ((be32) __constant_cpu_to_be32(x)) #define const_cpu_to_be64(x) ((be64) __constant_cpu_to_be64(x)) #define const_sbe16_to_cpu(x) ((s16) __constant_be16_to_cpu((be16) x)) #define const_sbe32_to_cpu(x) ((s32) __constant_be32_to_cpu((be32) x)) #define const_sbe64_to_cpu(x) ((s64) __constant_be64_to_cpu((be64) x)) #define const_cpu_to_sbe16(x) ((sbe16) __constant_cpu_to_be16((u16) x)) #define const_cpu_to_sbe32(x) ((sbe32) __constant_cpu_to_be32((u32) x)) #define const_cpu_to_sbe64(x) ((sbe64) __constant_cpu_to_be64((u64) x)) #endif /* defined _NTFS_ENDIANS_H */ ntfsprogs-plus-1.0.0/include/fsck.h000066400000000000000000000034341507404161300172450ustar00rootroot00000000000000/* SPDX-License-Identifier : GPL-2.0 */ #ifndef _NTFS_FSCK_H #define _NTFS_FSCK_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_SYS_PARAM_H #include #endif /* Do not #include here : conflicts with */ #ifdef HAVE_MNTENT_H #include #endif #include "volume.h" #include "problem.h" #define NTFS_BUF_SIZE_BITS (13) #define NTFSCK_BYTE_TO_BITS (3) #define NTFSCK_BM_BITS_SIZE (NTFS_BUF_SIZE << 3) #define FB_ROUND_UP(x) (((x) + ((NTFS_BUF_SIZE << 3) - 1)) & ~((NTFS_BUF_SIZE << 3) - 1)) #define FB_ROUND_DOWN(x) (((x) & ~(NTFS_BUF_SIZE - 1)) >> NTFS_BUF_SIZE_BITS) enum { FSCK_BMP_INITIAL = 1, FSCK_BMP_FINAL = 0, }; int ntfs_fsck_set_mftbmp_value(ntfs_volume *vol, u64 mft_no, int value); char ntfs_fsck_mftbmp_get(ntfs_volume *vol, const u64 bit); int ntfs_fsck_mftbmp_clear(ntfs_volume *vol, u64 mft_no); int ntfs_fsck_mftbmp_set(ntfs_volume *vol, u64 mft_no); void ntfs_fsck_set_bitmap_range(u8 *bm, s64 pos, s64 length, u8 bit); u8 *ntfs_fsck_find_lcnbmp_block(ntfs_volume *vol, s64 pos); u8 *ntfs_fsck_find_mftbmp_block(ntfs_volume *vol, s64 pos); int ntfs_fsck_set_lcnbmp_range(ntfs_volume *vol, s64 lcn, s64 length, u8 bit); runlist *ntfs_fsck_check_and_set_lcnbmp(ntfs_volume *vol, ntfs_attr *na, int rl_idx, u8 set_bit, runlist *dup_rl); runlist_element *ntfs_rl_append(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc); int ntfs_fsck_repair_cluster_dup(ntfs_attr *na, runlist *dup_rl); void ntfs_fsck_fill_unused_lcnbmp(ntfs_volume *vol, s64 last_idx, u8 *buf); ntfs_volume *ntfs_fsck_mount(const char *path __attribute__((unused)), ntfs_mount_flags flags __attribute__((unused))); void ntfs_fsck_umount(ntfs_volume *vol); #endif /* _NTFS_FSCK_H */ ntfsprogs-plus-1.0.0/include/index.h000066400000000000000000000155741507404161300174360ustar00rootroot00000000000000/* * index.h - Defines for NTFS index handling. Originated from the Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2006-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_INDEX_H #define _NTFS_INDEX_H /* Convenience macros to test the versions of gcc. * Use them like this: * #if __GNUC_PREREQ (2,8) * ... code requiring gcc 2.8 or later ... * #endif * Note - they won't work for gcc1 or glibc1, since the _MINOR macros * were not defined then. */ #ifndef __GNUC_PREREQ # if defined __GNUC__ && defined __GNUC_MINOR__ # define __GNUC_PREREQ(maj, min) \ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min)) # else # define __GNUC_PREREQ(maj, min) 0 # endif #endif /* allows us to warn about unused results of certain function calls */ #ifndef __attribute_warn_unused_result__ # if __GNUC_PREREQ (3,4) # define __attribute_warn_unused_result__ \ __attribute__ ((__warn_unused_result__)) # else # define __attribute_warn_unused_result__ /* empty */ # endif #endif #include "attrib.h" #include "types.h" #include "layout.h" #include "inode.h" #include "mft.h" #define VCN_INDEX_ROOT_PARENT ((VCN)-2) #define MAX_PARENT_VCN 64 typedef int (*COLLATE)(ntfs_volume *vol, const void *data1, int len1, const void *data2, int len2); /** * struct ntfs_index_context - * @ni: inode containing the @entry described by this context * @name: name of the index described by this context * @name_len: length of the index name * @entry: index entry (points into @ir or @ib) * @data: index entry data (points into @entry) * @data_len: length in bytes of @data * @is_in_root: TRUE if @entry is in @ir or FALSE if it is in @ib * @ir: index root if @is_in_root or NULL otherwise * @actx: attribute search context if in root or NULL otherwise * @ib: index block if @is_in_root is FALSE or NULL otherwise * @ia_na: opened INDEX_ALLOCATION attribute * @parent_pos: parent entries' positions in the index block * @parent_vcn: entry's parent node or VCN_INDEX_ROOT_PARENT * @new_vcn: new VCN if we need to create a new index block * @median: move to the parent if splitting index blocks * @ib_dirty: TRUE if index block was changed * @block_size: index block size * @vcn_size_bits: VCN size bits for this index block * * @ni is the inode this context belongs to. * * @entry is the index entry described by this context. @data and @data_len * are the index entry data and its length in bytes, respectively. @data * simply points into @entry. This is probably what the user is interested in. * * If @is_in_root is TRUE, @entry is in the index root attribute @ir described * by the attribute search context @actx and inode @ni. @ia and * @ib_dirty are undefined in this case. * * If @is_in_root is FALSE, @entry is in the index allocation attribute and @ia * point to the index allocation block and VCN where it's placed, * respectively. @ir and @actx are NULL in this case. @ia_na is opened * INDEX_ALLOCATION attribute. @ib_dirty is TRUE if index block was changed and * FALSE otherwise. * * To obtain a context call ntfs_index_ctx_get(). * * When finished with the @entry and its @data, call ntfs_index_ctx_put() to * free the context and other associated resources. * * If the index entry was modified, call ntfs_index_entry_mark_dirty() before * the call to ntfs_index_ctx_put() to ensure that the changes are written * to disk. */ typedef struct { ntfs_inode *ni; ntfschar *name; u32 name_len; INDEX_ENTRY *entry; void *data; u16 data_len; COLLATE collate; BOOL is_in_root; INDEX_ROOT *ir; ntfs_attr_search_ctx *actx; INDEX_BLOCK *ib; ntfs_attr *ia_na; int parent_pos[MAX_PARENT_VCN]; /* parent entries' positions */ VCN parent_vcn[MAX_PARENT_VCN]; /* entry's parent nodes */ int pindex; /* maximum it's the number of the parent nodes */ BOOL ib_dirty; BOOL bad_index; u32 block_size; u8 vcn_size_bits; } ntfs_index_context; extern ntfs_index_context *ntfs_index_ctx_get(ntfs_inode *ni, ntfschar *name, u32 name_len); extern void ntfs_index_ctx_put(ntfs_index_context *ictx); extern void ntfs_index_ctx_reinit(ntfs_index_context *ictx); extern int ntfs_index_block_inconsistent(ntfs_volume *vol, ntfs_attr *ia_na, INDEX_BLOCK *ib, u32 block_size, u64 inum, VCN vcn); extern int ntfs_index_entry_inconsistent(ntfs_volume *vol, INDEX_ENTRY *ie, COLLATION_RULES collation_rule, u64 inum, ntfs_index_context *ictx); extern int ntfs_index_lookup(const void *key, const int key_len, ntfs_index_context *ictx) __attribute_warn_unused_result__; extern INDEX_ENTRY *ntfs_index_next(INDEX_ENTRY *ie, ntfs_index_context *ictx); extern int ntfs_index_add_filename(ntfs_inode *ni, FILE_NAME_ATTR *fn, MFT_REF mref); extern int ntfs_index_remove(ntfs_inode *dir_ni, ntfs_inode *ni, const void *key, const int keylen); extern INDEX_ROOT *ntfs_index_root_get(ntfs_inode *ni, ATTR_RECORD *attr); extern VCN ntfs_ie_get_vcn(INDEX_ENTRY *ie); INDEX_ENTRY *ntfs_index_walk_down(INDEX_ENTRY *ie, ntfs_index_context *ictx); INDEX_ENTRY *ntfs_index_walk_up(INDEX_ENTRY *ie, ntfs_index_context *ictx); extern void ntfs_index_entry_mark_dirty(ntfs_index_context *ictx); extern char *ntfs_ie_filename_get(INDEX_ENTRY *ie); extern void ntfs_ie_filename_dump(INDEX_ENTRY *ie); extern void ntfs_ih_filename_dump(INDEX_HEADER *ih); /* the following was added by JPA for use in security.c */ extern int ntfs_ie_add(ntfs_index_context *icx, INDEX_ENTRY *ie); extern int ntfs_index_rm(ntfs_index_context *icx); int ntfs_ib_read(ntfs_index_context *icx, VCN vcn, INDEX_BLOCK *ib); int ntfs_ib_write(ntfs_index_context *icx, INDEX_BLOCK *ib); int ntfsck_update_index_entry(ntfs_index_context *ictx); int ntfs_ibm_modify(ntfs_index_context *icx, VCN vcn, int set); INDEX_ROOT *ntfs_ir_lookup(ntfs_inode *ni, ntfschar *name, u32 name_len, ntfs_attr_search_ctx **ctx); INDEX_ROOT *ntfs_ir_lookup2(ntfs_inode *ni, ntfschar *name, u32 len); s64 ntfs_ib_vcn_to_pos(ntfs_index_context *icx, VCN vcn); INDEX_ENTRY *ntfs_ie_dup(INDEX_ENTRY *ie); #endif /* _NTFS_INDEX_H */ ntfsprogs-plus-1.0.0/include/inode.h000066400000000000000000000205671507404161300174230ustar00rootroot00000000000000/* * inode.h - Defines for NTFS inode handling. Originated from the Linux-NTFS project. * * Copyright (c) 2001-2004 Anton Altaparmakov * Copyright (c) 2004-2007 Yura Pakhuchiy * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2006-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_INODE_H #define _NTFS_INODE_H /* Forward declaration */ typedef struct _ntfs_inode ntfs_inode; #include "types.h" #include "layout.h" #include "support.h" #include "volume.h" #include "ntfstime.h" /** * enum ntfs_inode_state_bits - * * Defined bits for the state field in the ntfs_inode structure. * (f) = files only, (d) = directories only */ typedef enum { NI_Dirty, /* 1: Mft record needs to be written to disk. */ /* The NI_AttrList* tests only make sense for base inodes. */ NI_AttrList, /* 1: Mft record contains an attribute list. */ NI_AttrListDirty, /* 1: Attribute list needs to be written to the mft record and then to disk. */ NI_FileNameDirty, /* 1: FILE_NAME attributes need to be updated in the index. */ NI_v3_Extensions, /* 1: JPA v3.x extensions present. */ NI_TimesSet, /* 1: Use times which were set */ NI_KnownSize, /* 1: Set if sizes are meaningful */ } ntfs_inode_state_bits; #define test_nino_flag(ni, flag) test_bit(NI_##flag, (ni)->state) #define set_nino_flag(ni, flag) set_bit(NI_##flag, (ni)->state) #define clear_nino_flag(ni, flag) clear_bit(NI_##flag, (ni)->state) #define test_and_set_nino_flag(ni, flag) \ test_and_set_bit(NI_##flag, (ni)->state) #define test_and_clear_nino_flag(ni, flag) \ test_and_clear_bit(NI_##flag, (ni)->state) #define NInoDirty(ni) test_nino_flag(ni, Dirty) #define NInoSetDirty(ni) set_nino_flag(ni, Dirty) #define NInoClearDirty(ni) clear_nino_flag(ni, Dirty) #define NInoTestAndSetDirty(ni) test_and_set_nino_flag(ni, Dirty) #define NInoTestAndClearDirty(ni) test_and_clear_nino_flag(ni, Dirty) #define NInoAttrList(ni) test_nino_flag(ni, AttrList) #define NInoSetAttrList(ni) set_nino_flag(ni, AttrList) #define NInoClearAttrList(ni) clear_nino_flag(ni, AttrList) #define test_nino_al_flag(ni, flag) test_nino_flag(ni, AttrList##flag) #define set_nino_al_flag(ni, flag) set_nino_flag(ni, AttrList##flag) #define clear_nino_al_flag(ni, flag) clear_nino_flag(ni, AttrList##flag) #define test_and_set_nino_al_flag(ni, flag) \ test_and_set_nino_flag(ni, AttrList##flag) #define test_and_clear_nino_al_flag(ni, flag) \ test_and_clear_nino_flag(ni, AttrList##flag) #define NInoAttrListDirty(ni) test_nino_al_flag(ni, Dirty) #define NInoAttrListSetDirty(ni) set_nino_al_flag(ni, Dirty) #define NInoAttrListClearDirty(ni) clear_nino_al_flag(ni, Dirty) #define NInoAttrListTestAndSetDirty(ni) test_and_set_nino_al_flag(ni, Dirty) #define NInoAttrListTestAndClearDirty(ni) test_and_clear_nino_al_flag(ni, Dirty) #define NInoFileNameDirty(ni) test_nino_flag(ni, FileNameDirty) #define NInoFileNameSetDirty(ni) set_nino_flag(ni, FileNameDirty) #define NInoFileNameClearDirty(ni) clear_nino_flag(ni, FileNameDirty) #define NInoFileNameTestAndSetDirty(ni) \ test_and_set_nino_flag(ni, FileNameDirty) #define NInoFileNameTestAndClearDirty(ni) \ test_and_clear_nino_flag(ni, FileNameDirty) /** * struct _ntfs_inode - The NTFS in-memory inode structure. * * It is just used as an extension to the fields already provided in the VFS * inode. */ struct _ntfs_inode { u64 mft_no; /* Inode / mft record number. */ MFT_RECORD *mrec; /* The actual mft record of the inode. */ ntfs_volume *vol; /* Pointer to the ntfs volume of this inode. */ unsigned long state; /* NTFS specific flags describing this inode. See ntfs_inode_state_bits above. */ FILE_ATTR_FLAGS flags; /* Flags describing the file. (Copy from STANDARD_INFORMATION) */ /* * Attribute list support (for use by the attribute lookup functions). * Setup during ntfs_open_inode() for all inodes with attribute lists. * Only valid if NI_AttrList is set in state. */ u32 attr_list_size; /* Length of attribute list value in bytes. */ u8 *attr_list; /* Attribute list value itself. */ /* Below fields are always valid. */ s32 nr_extents; /* For a base mft record, the number of attached extent inodes (0 if none), for extent records this is -1. */ union { /* This union is only used if nr_extents != 0. */ ntfs_inode **extent_nis;/* For nr_extents > 0, array of the ntfs inodes of the extent mft records belonging to this base inode which have been loaded. */ ntfs_inode *base_ni; /* For nr_extents == -1, the ntfs inode of the base mft record. */ }; /* Below fields are valid only for base inode. */ /* * These two fields are used to sync filename index and guaranteed to be * correct, however value in index itself maybe wrong (windows itself * do not update them properly). * For directories, they hold the index size, provided the * flag KnownSize is set. */ s64 data_size; /* Data size of unnamed DATA attribute (or INDEX_ROOT for directories) */ s64 allocated_size; /* Allocated size stored in the filename index. (NOTE: Equal to allocated size of the unnamed data attribute for normal or encrypted files and to compressed size of the unnamed data attribute for sparse or compressed files.) */ /* * These four fields are copy of relevant fields from * STANDARD_INFORMATION attribute and used to sync it and FILE_NAME * attribute in the index. */ ntfs_time creation_time; ntfs_time last_data_change_time; ntfs_time last_mft_change_time; ntfs_time last_access_time; /* NTFS 3.x extensions added by JPA */ /* only if NI_v3_Extensions is set in state */ le32 owner_id; le32 security_id; le64 quota_charged; le64 usn; void *fsck_ibm; /* for bitmap tracking in fsck */ u32 fsck_ibm_size; /* fsck bitmap size */ }; typedef enum { NTFS_UPDATE_ATIME = 1 << 0, NTFS_UPDATE_MTIME = 1 << 1, NTFS_UPDATE_CTIME = 1 << 2, } ntfs_time_update_flags; #define NTFS_UPDATE_MCTIME (NTFS_UPDATE_MTIME | NTFS_UPDATE_CTIME) #define NTFS_UPDATE_AMCTIME (NTFS_UPDATE_ATIME | NTFS_UPDATE_MCTIME) extern ntfs_inode *ntfs_inode_base(ntfs_inode *ni); extern ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol); extern ntfs_inode *ntfs_inode_open(ntfs_volume *vol, const MFT_REF mref); extern int ntfs_inode_close(ntfs_inode *ni); extern int ntfs_inode_close_in_dir(ntfs_inode *ni, ntfs_inode *dir_ni); extern int ntfs_inode_sync_in_dir(ntfs_inode *ni, ntfs_inode *dir_ni); #if CACHE_NIDATA_SIZE struct CACHED_GENERIC; extern int ntfs_inode_real_close(ntfs_inode *ni); extern void ntfs_inode_invalidate(ntfs_volume *vol, const MFT_REF mref); extern void ntfs_inode_nidata_free(const struct CACHED_GENERIC *cached); extern int ntfs_inode_nidata_hash(const struct CACHED_GENERIC *item); #endif extern ntfs_inode *ntfs_extent_inode_open(ntfs_inode *base_ni, const leMFT_REF mref); extern int ntfs_inode_attach_all_extents(ntfs_inode *ni); extern void ntfs_inode_mark_dirty(ntfs_inode *ni); extern void ntfs_inode_update_times(ntfs_inode *ni, ntfs_time_update_flags mask); extern int ntfs_inode_sync(ntfs_inode *ni); extern int ntfs_inode_add_attrlist(ntfs_inode *ni); extern int ntfs_inode_free_space(ntfs_inode *ni, int size); extern int ntfs_inode_badclus_bad(u64 mft_no, ATTR_RECORD *a); extern int ntfs_inode_get_times(ntfs_inode *ni, char *value, size_t size); extern int ntfs_inode_set_times(ntfs_inode *ni, const char *value, size_t size, int flags); /* debugging */ #define debug_double_inode(num, type) #define debug_cached_inode(ni) #endif /* defined _NTFS_INODE_H */ ntfsprogs-plus-1.0.0/include/ioctl.h000066400000000000000000000023271507404161300174310ustar00rootroot00000000000000/* * * Copyright (c) 2014 Jean-Pierre Andre * */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef IOCTL_H #define IOCTL_H /* * Using an "unsigned long cmd" internally, like in for Linux * Note however that fuse truncates the arg to 32 bits, and that * some commands (e.g. FITRIM) do not fit in a signed 32 bit field. */ int ntfs_ioctl(ntfs_inode *ni, unsigned long cmd, void *arg, unsigned int flags, void *data); #endif /* IOCTL_H */ ntfsprogs-plus-1.0.0/include/layout.h000066400000000000000000003320621507404161300176360ustar00rootroot00000000000000/* * layout.h - Ntfs on-disk layout structures. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2005 Anton Altaparmakov * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2005-2006 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_LAYOUT_H #define _NTFS_LAYOUT_H #include "types.h" #include "endians.h" #include "support.h" /* The NTFS oem_id */ #define magicNTFS const_cpu_to_le64(0x202020205346544e) /* "NTFS " */ #define NTFS_SB_MAGIC 0x5346544e /* 'NTFS' */ /* * Location of bootsector on partition: * The standard NTFS_BOOT_SECTOR is on sector 0 of the partition. * On NT4 and above there is one backup copy of the boot sector to * be found on the last sector of the partition (not normally accessible * from within Windows as the bootsector contained number of sectors * value is one less than the actual value!). * On versions of NT 3.51 and earlier, the backup copy was located at * number of sectors/2 (integer divide), i.e. in the middle of the volume. */ /** * struct BIOS_PARAMETER_BLOCK - BIOS parameter block (bpb) structure. */ typedef struct { le16 bytes_per_sector; /* Size of a sector in bytes. */ u8 sectors_per_cluster; /* Size of a cluster in sectors. */ le16 reserved_sectors; /* zero */ u8 fats; /* zero */ le16 root_entries; /* zero */ le16 sectors; /* zero */ u8 media_type; /* 0xf8 = hard disk */ le16 sectors_per_fat; /* zero */ /*0x0d*/le16 sectors_per_track; /* Required to boot Windows. */ /*0x0f*/le16 heads; /* Required to boot Windows. */ /*0x11*/le32 hidden_sectors; /* Offset to the start of the partition relative to the disk in sectors. Required to boot Windows. */ /*0x15*/le32 large_sectors; /* zero */ /* sizeof() = 25 (0x19) bytes */ } __attribute__((__packed__)) BIOS_PARAMETER_BLOCK; /** * struct NTFS_BOOT_SECTOR - NTFS boot sector structure. */ typedef struct { u8 jump[3]; /* Irrelevant (jump to boot up code).*/ le64 oem_id; /* Magic "NTFS ". */ /*0x0b*/BIOS_PARAMETER_BLOCK bpb; /* See BIOS_PARAMETER_BLOCK. */ u8 physical_drive; /* 0x00 floppy, 0x80 hard disk */ u8 current_head; /* zero */ u8 extended_boot_signature; /* 0x80 */ u8 reserved2; /* zero */ /*0x28*/sle64 number_of_sectors; /* Number of sectors in volume. Gives maximum volume size of 2^63 sectors. Assuming standard sector size of 512 bytes, the maximum byte size is approx. 4.7x10^21 bytes. (-; */ sle64 mft_lcn; /* Cluster location of mft data. */ sle64 mftmirr_lcn; /* Cluster location of copy of mft. */ s8 clusters_per_mft_record; /* Mft record size in clusters. */ u8 reserved0[3]; /* zero */ s8 clusters_per_index_record; /* Index block size in clusters. */ u8 reserved1[3]; /* zero */ le64 volume_serial_number; /* Irrelevant (serial number). */ le32 checksum; /* Boot sector checksum. */ /*0x54*/u8 bootstrap[426]; /* Irrelevant (boot up code). */ le16 end_of_sector_marker; /* End of bootsector magic. Always is 0xaa55 in little endian. */ /* sizeof() = 512 (0x200) bytes */ } __attribute__((__packed__)) NTFS_BOOT_SECTOR; /** * enum NTFS_RECORD_TYPES - * * Magic identifiers present at the beginning of all ntfs record containing * records (like mft records for example). */ typedef enum { /* Found in $MFT/$DATA. */ magic_FILE = const_cpu_to_le32(0x454c4946), /* Mft entry. */ magic_INDX = const_cpu_to_le32(0x58444e49), /* Index buffer. */ magic_HOLE = const_cpu_to_le32(0x454c4f48), /* ? (NTFS 3.0+?) */ /* Found in $LogFile/$DATA. */ magic_RSTR = const_cpu_to_le32(0x52545352), /* Restart page. */ magic_RCRD = const_cpu_to_le32(0x44524352), /* Log record page. */ /* Found in $LogFile/$DATA. (May be found in $MFT/$DATA, also?) */ magic_CHKD = const_cpu_to_le32(0x444b4843), /* Modified by chkdsk. */ /* Found in all ntfs record containing records. */ magic_BAAD = const_cpu_to_le32(0x44414142), /* Failed multi sector transfer was detected. */ /* * Found in $LogFile/$DATA when a page is full or 0xff bytes and is * thus not initialized. User has to initialize the page before using * it. */ magic_empty = const_cpu_to_le32(0xffffffff),/* Record is empty and has to be initialized before it can be used. */ } NTFS_RECORD_TYPES; /* * Generic magic comparison macros. Finally found a use for the ## preprocessor * operator! (-8 */ #define ntfs_is_magic(x, m) ( (u32)(x) == (u32)magic_##m ) #define ntfs_is_magicp(p, m) ( *(u32*)(p) == (u32)magic_##m ) /* * Specialised magic comparison macros for the NTFS_RECORD_TYPES defined above. */ #define ntfs_is_file_record(x) ( ntfs_is_magic (x, FILE) ) #define ntfs_is_file_recordp(p) ( ntfs_is_magicp(p, FILE) ) #define ntfs_is_mft_record(x) ( ntfs_is_file_record(x) ) #define ntfs_is_mft_recordp(p) ( ntfs_is_file_recordp(p) ) #define ntfs_is_indx_record(x) ( ntfs_is_magic (x, INDX) ) #define ntfs_is_indx_recordp(p) ( ntfs_is_magicp(p, INDX) ) #define ntfs_is_hole_record(x) ( ntfs_is_magic (x, HOLE) ) #define ntfs_is_hole_recordp(p) ( ntfs_is_magicp(p, HOLE) ) #define ntfs_is_rstr_record(x) ( ntfs_is_magic (x, RSTR) ) #define ntfs_is_rstr_recordp(p) ( ntfs_is_magicp(p, RSTR) ) #define ntfs_is_rcrd_record(x) ( ntfs_is_magic (x, RCRD) ) #define ntfs_is_rcrd_recordp(p) ( ntfs_is_magicp(p, RCRD) ) #define ntfs_is_chkd_record(x) ( ntfs_is_magic (x, CHKD) ) #define ntfs_is_chkd_recordp(p) ( ntfs_is_magicp(p, CHKD) ) #define ntfs_is_baad_record(x) ( ntfs_is_magic (x, BAAD) ) #define ntfs_is_baad_recordp(p) ( ntfs_is_magicp(p, BAAD) ) #define ntfs_is_empty_record(x) ( ntfs_is_magic (x, empty) ) #define ntfs_is_empty_recordp(p) ( ntfs_is_magicp(p, empty) ) /* * The size of a logical sector in bytes, used as the sequence number stride for * multi-sector transfers. This is intended to be less than or equal to the * physical sector size, since if this were greater than the physical sector * size, then incomplete multi-sector transfers may not be detected. */ #define NTFS_BLOCK_SIZE 512 #define NTFS_BLOCK_SIZE_BITS 9 /** * struct NTFS_RECORD - * * The Update Sequence Array (usa) is an array of the le16 values which belong * to the end of each sector protected by the update sequence record in which * this array is contained. Note that the first entry is the Update Sequence * Number (usn), a cyclic counter of how many times the protected record has * been written to disk. The values 0 and -1 (ie. 0xffff) are not used. All * last le16's of each sector have to be equal to the usn (during reading) or * are set to it (during writing). If they are not, an incomplete multi sector * transfer has occurred when the data was written. * The maximum size for the update sequence array is fixed to: * maximum size = usa_ofs + (usa_count * 2) = 510 bytes * The 510 bytes comes from the fact that the last le16 in the array has to * (obviously) finish before the last le16 of the first 512-byte sector. * This formula can be used as a consistency check in that usa_ofs + * (usa_count * 2) has to be less than or equal to 510. */ typedef struct { NTFS_RECORD_TYPES magic;/* A four-byte magic identifying the record type and/or status. */ le16 usa_ofs; /* Offset to the Update Sequence Array (usa) from the start of the ntfs record. */ le16 usa_count; /* Number of le16 sized entries in the usa including the Update Sequence Number (usn), thus the number of fixups is the usa_count minus 1. */ } __attribute__((__packed__)) NTFS_RECORD; /** * enum NTFS_SYSTEM_FILES - System files mft record numbers. * * All these files are always marked as used in the bitmap attribute of the * mft; presumably in order to avoid accidental allocation for random other * mft records. Also, the sequence number for each of the system files is * always equal to their mft record number and it is never modified. */ typedef enum { FILE_MFT = 0, /* Master file table (mft). Data attribute contains the entries and bitmap attribute records which ones are in use (bit==1). */ FILE_MFTMirr = 1, /* Mft mirror: copy of first four mft records in data attribute. If cluster size > 4kiB, copy of first N mft records, with N = cluster_size / mft_record_size. */ FILE_LogFile = 2, /* Journalling log in data attribute. */ FILE_Volume = 3, /* Volume name attribute and volume information attribute (flags and ntfs version). Windows refers to this file as volume DASD (Direct Access Storage Device). */ FILE_AttrDef = 4, /* Array of attribute definitions in data attribute. */ FILE_root = 5, /* Root directory. */ FILE_Bitmap = 6, /* Allocation bitmap of all clusters (lcns) in data attribute. */ FILE_Boot = 7, /* Boot sector (always at cluster 0) in data attribute. */ FILE_BadClus = 8, /* Contains all bad clusters in the non-resident data attribute. */ FILE_Secure = 9, /* Shared security descriptors in data attribute and two indexes into the descriptors. Appeared in Windows 2000. Before that, this file was named $Quota but was unused. */ FILE_UpCase = 10, /* Uppercase equivalents of all 65536 Unicode characters in data attribute. */ FILE_Extend = 11, /* Directory containing other system files (eg. $ObjId, $Quota, $Reparse and $UsnJrnl). This is new to NTFS3.0. */ FILE_reserved12 = 12, /* Reserved for future use (records 12-15). */ FILE_reserved13 = 13, FILE_reserved14 = 14, FILE_mft_data = 15, /* Reserved for first extent of $MFT:$DATA */ FILE_first_user = 16, /* First user file, used as test limit for whether to allow opening a file or not. */ } NTFS_SYSTEM_FILES; /** * enum MFT_RECORD_FLAGS - * * These are the so far known MFT_RECORD_* flags (16-bit) which contain * information about the mft record in which they are present. * * MFT_RECORD_IS_4 exists on all $Extend sub-files. * It seems that it marks it is a metadata file with MFT record >24, however, * it is unknown if it is limited to metadata files only. * PS) above commens is wrong, sub-files of $Extend which is formatted * in Windows 10 does not have MFT_RECORD_IS_4 flag. * * MFT_RECORD_IS_VIEW_INDEX exists on every metafile with a non directory * index, that means an INDEX_ROOT and an INDEX_ALLOCATION with a name other * than "$I30". It is unknown if it is limited to metadata files only. */ typedef enum { MFT_RECORD_IN_USE = const_cpu_to_le16(0x0001), MFT_RECORD_IS_DIRECTORY = const_cpu_to_le16(0x0002), MFT_RECORD_IS_4 = const_cpu_to_le16(0x0004), MFT_RECORD_IS_VIEW_INDEX = const_cpu_to_le16(0x0008), MFT_REC_SPACE_FILLER = 0xffff, /* Just to make flags 16-bit. */ } __attribute__((__packed__)) MFT_RECORD_FLAGS; /* * mft references (aka file references or file record segment references) are * used whenever a structure needs to refer to a record in the mft. * * A reference consists of a 48-bit index into the mft and a 16-bit sequence * number used to detect stale references. * * For error reporting purposes we treat the 48-bit index as a signed quantity. * * The sequence number is a circular counter (skipping 0) describing how many * times the referenced mft record has been (re)used. This has to match the * sequence number of the mft record being referenced, otherwise the reference * is considered stale and removed (FIXME: only ntfsck or the driver itself?). * * If the sequence number is zero it is assumed that no sequence number * consistency checking should be performed. * * FIXME: Since inodes are 32-bit as of now, the driver needs to always check * for high_part being 0 and if not either BUG(), cause a panic() or handle * the situation in some other way. This shouldn't be a problem as a volume has * to become HUGE in order to need more than 32-bits worth of mft records. * Assuming the standard mft record size of 1kb only the records (never mind * the non-resident attributes, etc.) would require 4Tb of space on their own * for the first 32 bits worth of records. This is only if some strange person * doesn't decide to foul play and make the mft sparse which would be a really * horrible thing to do as it would trash our current driver implementation. )-: * Do I hear screams "we want 64-bit inodes!" ?!? (-; * * FIXME: The mft zone is defined as the first 12% of the volume. This space is * reserved so that the mft can grow contiguously and hence doesn't become * fragmented. Volume free space includes the empty part of the mft zone and * when the volume's free 88% are used up, the mft zone is shrunk by a factor * of 2, thus making more space available for more files/data. This process is * repeated every time there is no more free space except for the mft zone until * there really is no more free space. */ /* * Typedef the MFT_REF as a 64-bit value for easier handling. * Also define two unpacking macros to get to the reference (MREF) and * sequence number (MSEQNO) respectively. * The _LE versions are to be applied on little endian MFT_REFs. * Note: The _LE versions will return a CPU endian formatted value! */ #define MFT_REF_MASK_CPU 0x0000ffffffffffffULL #define MFT_REF_MASK_LE const_cpu_to_le64(MFT_REF_MASK_CPU) typedef u64 MFT_REF; typedef le64 leMFT_REF; /* a little-endian MFT_MREF */ #define MK_MREF(m, s) ((MFT_REF)(((MFT_REF)(s) << 48) | \ ((MFT_REF)(m) & MFT_REF_MASK_CPU))) #define MK_LE_MREF(m, s) const_cpu_to_le64(((MFT_REF)(((MFT_REF)(s) << 48) | \ ((MFT_REF)(m) & MFT_REF_MASK_CPU)))) #define MREF(x) ((u64)((x) & MFT_REF_MASK_CPU)) #define MSEQNO(x) ((u16)(((x) >> 48) & 0xffff)) #define MREF_LE(x) ((u64)(const_le64_to_cpu(x) & MFT_REF_MASK_CPU)) #define MSEQNO_LE(x) ((u16)((const_le64_to_cpu(x) >> 48) & 0xffff)) #define IS_ERR_MREF(x) (((x) & 0x0000800000000000ULL) ? 1 : 0) #define ERR_MREF(x) ((u64)((s64)(x))) #define MREF_ERR(x) ((int)((s64)(x))) /** * struct MFT_RECORD - An MFT record layout (NTFS 3.1+) * * The mft record header present at the beginning of every record in the mft. * This is followed by a sequence of variable length attribute records which * is terminated by an attribute of type AT_END which is a truncated attribute * in that it only consists of the attribute type code AT_END and none of the * other members of the attribute structure are present. */ typedef struct { /*Ofs*/ /* 0 NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */ NTFS_RECORD_TYPES magic;/* Usually the magic is "FILE". */ le16 usa_ofs; /* See NTFS_RECORD definition above. */ le16 usa_count; /* See NTFS_RECORD definition above. */ /* 8*/ leLSN lsn; /* $LogFile sequence number for this record. Changed every time the record is modified. */ /* 16*/ le16 sequence_number; /* Number of times this mft record has been reused. (See description for MFT_REF above.) NOTE: The increment (skipping zero) is done when the file is deleted. NOTE: If this is zero it is left zero. */ /* 18*/ le16 link_count; /* Number of hard links, i.e. the number of directory entries referencing this record. NOTE: Only used in mft base records. NOTE: When deleting a directory entry we check the link_count and if it is 1 we delete the file. Otherwise we delete the FILE_NAME_ATTR being referenced by the directory entry from the mft record and decrement the link_count. FIXME: Careful with Win32 + DOS names! */ /* 20*/ le16 attrs_offset; /* Byte offset to the first attribute in this mft record from the start of the mft record. NOTE: Must be aligned to 8-byte boundary. */ /* 22*/ MFT_RECORD_FLAGS flags; /* Bit array of MFT_RECORD_FLAGS. When a file is deleted, the MFT_RECORD_IN_USE flag is set to zero. */ /* 24*/ le32 bytes_in_use; /* Number of bytes used in this mft record. NOTE: Must be aligned to 8-byte boundary. */ /* 28*/ le32 bytes_allocated; /* Number of bytes allocated for this mft record. This should be equal to the mft record size. */ /* 32*/ leMFT_REF base_mft_record; /* This is zero for base mft records. When it is not zero it is a mft reference pointing to the base mft record to which this record belongs (this is then used to locate the attribute list attribute present in the base record which describes this extension record and hence might need modification when the extension record itself is modified, also locating the attribute list also means finding the other potential extents, belonging to the non-base mft record). */ /* 40*/ le16 next_attr_instance; /* The instance number that will be assigned to the next attribute added to this mft record. NOTE: Incremented each time after it is used. NOTE: Every time the mft record is reused this number is set to zero. NOTE: The first instance number is always 0. */ /* The below fields are specific to NTFS 3.1+ (Windows XP and above): */ /* 42*/ le16 reserved; /* Reserved/alignment. */ /* 44*/ le32 mft_record_number; /* Number of this mft record. */ /* sizeof() = 48 bytes */ /* * When (re)using the mft record, we place the update sequence array at this * offset, i.e. before we start with the attributes. This also makes sense, * otherwise we could run into problems with the update sequence array * containing in itself the last two bytes of a sector which would mean that * multi sector transfer protection wouldn't work. As you can't protect data * by overwriting it since you then can't get it back... * When reading we obviously use the data from the ntfs record header. */ } __attribute__((__packed__)) MFT_RECORD; /** * struct MFT_RECORD_OLD - An MFT record layout (NTFS <=3.0) * * This is the version without the NTFS 3.1+ specific fields. */ typedef struct { /*Ofs*/ /* 0 NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */ NTFS_RECORD_TYPES magic;/* Usually the magic is "FILE". */ le16 usa_ofs; /* See NTFS_RECORD definition above. */ le16 usa_count; /* See NTFS_RECORD definition above. */ /* 8*/ leLSN lsn; /* $LogFile sequence number for this record. Changed every time the record is modified. */ /* 16*/ le16 sequence_number; /* Number of times this mft record has been reused. (See description for MFT_REF above.) NOTE: The increment (skipping zero) is done when the file is deleted. NOTE: If this is zero it is left zero. */ /* 18*/ le16 link_count; /* Number of hard links, i.e. the number of directory entries referencing this record. NOTE: Only used in mft base records. NOTE: When deleting a directory entry we check the link_count and if it is 1 we delete the file. Otherwise we delete the FILE_NAME_ATTR being referenced by the directory entry from the mft record and decrement the link_count. FIXME: Careful with Win32 + DOS names! */ /* 20*/ le16 attrs_offset; /* Byte offset to the first attribute in this mft record from the start of the mft record. NOTE: Must be aligned to 8-byte boundary. */ /* 22*/ MFT_RECORD_FLAGS flags; /* Bit array of MFT_RECORD_FLAGS. When a file is deleted, the MFT_RECORD_IN_USE flag is set to zero. */ /* 24*/ le32 bytes_in_use; /* Number of bytes used in this mft record. NOTE: Must be aligned to 8-byte boundary. */ /* 28*/ le32 bytes_allocated; /* Number of bytes allocated for this mft record. This should be equal to the mft record size. */ /* 32*/ leMFT_REF base_mft_record; /* This is zero for base mft records. When it is not zero it is a mft reference pointing to the base mft record to which this record belongs (this is then used to locate the attribute list attribute present in the base record which describes this extension record and hence might need modification when the extension record itself is modified, also locating the attribute list also means finding the other potential extents, belonging to the non-base mft record). */ /* 40*/ le16 next_attr_instance; /* The instance number that will be assigned to the next attribute added to this mft record. NOTE: Incremented each time after it is used. NOTE: Every time the mft record is reused this number is set to zero. NOTE: The first instance number is always 0. */ /* sizeof() = 42 bytes */ /* * When (re)using the mft record, we place the update sequence array at this * offset, i.e. before we start with the attributes. This also makes sense, * otherwise we could run into problems with the update sequence array * containing in itself the last two bytes of a sector which would mean that * multi sector transfer protection wouldn't work. As you can't protect data * by overwriting it since you then can't get it back... * When reading we obviously use the data from the ntfs record header. */ } __attribute__((__packed__)) MFT_RECORD_OLD; /** * enum ATTR_TYPES - System defined attributes (32-bit). * * Each attribute type has a corresponding attribute name (Unicode string of * maximum 64 character length) as described by the attribute definitions * present in the data attribute of the $AttrDef system file. * * On NTFS 3.0 volumes the names are just as the types are named in the below * enum exchanging AT_ for the dollar sign ($). If that isn't a revealing * choice of symbol... (-; */ typedef enum { AT_UNUSED = const_cpu_to_le32( 0), AT_STANDARD_INFORMATION = const_cpu_to_le32( 0x10), AT_ATTRIBUTE_LIST = const_cpu_to_le32( 0x20), AT_FILE_NAME = const_cpu_to_le32( 0x30), AT_OBJECT_ID = const_cpu_to_le32( 0x40), AT_SECURITY_DESCRIPTOR = const_cpu_to_le32( 0x50), AT_VOLUME_NAME = const_cpu_to_le32( 0x60), AT_VOLUME_INFORMATION = const_cpu_to_le32( 0x70), AT_DATA = const_cpu_to_le32( 0x80), AT_INDEX_ROOT = const_cpu_to_le32( 0x90), AT_INDEX_ALLOCATION = const_cpu_to_le32( 0xa0), AT_BITMAP = const_cpu_to_le32( 0xb0), AT_REPARSE_POINT = const_cpu_to_le32( 0xc0), AT_EA_INFORMATION = const_cpu_to_le32( 0xd0), AT_EA = const_cpu_to_le32( 0xe0), AT_PROPERTY_SET = const_cpu_to_le32( 0xf0), AT_LOGGED_UTILITY_STREAM = const_cpu_to_le32( 0x100), AT_FIRST_USER_DEFINED_ATTRIBUTE = const_cpu_to_le32( 0x1000), AT_END = const_cpu_to_le32(0xffffffff), } ATTR_TYPES; /** * enum COLLATION_RULES - The collation rules for sorting views/indexes/etc * (32-bit). * * COLLATION_BINARY - Collate by binary compare where the first byte is most * significant. * COLLATION_FILE_NAME - Collate Unicode strings by comparing their 16-bit * coding units, primarily ignoring case using the volume's $UpCase table, * but falling back to a case-sensitive comparison if the names are equal * ignoring case. * COLLATION_UNICODE_STRING - TODO: this is not yet implemented and still needs * to be properly documented --- is it really the same as * COLLATION_FILE_NAME? * COLLATION_NTOFS_ULONG - Sorting is done according to ascending le32 key * values. E.g. used for $SII index in FILE_Secure, which sorts by * security_id (le32). * COLLATION_NTOFS_SID - Sorting is done according to ascending SID values. * E.g. used for $O index in FILE_Extend/$Quota. * COLLATION_NTOFS_SECURITY_HASH - Sorting is done first by ascending hash * values and second by ascending security_id values. E.g. used for $SDH * index in FILE_Secure. * COLLATION_NTOFS_ULONGS - Sorting is done according to a sequence of ascending * le32 key values. E.g. used for $O index in FILE_Extend/$ObjId, which * sorts by object_id (16-byte), by splitting up the object_id in four * le32 values and using them as individual keys. E.g. take the following * two security_ids, stored as follows on disk: * 1st: a1 61 65 b7 65 7b d4 11 9e 3d 00 e0 81 10 42 59 * 2nd: 38 14 37 d2 d2 f3 d4 11 a5 21 c8 6b 79 b1 97 45 * To compare them, they are split into four le32 values each, like so: * 1st: 0xb76561a1 0x11d47b65 0xe0003d9e 0x59421081 * 2nd: 0xd2371438 0x11d4f3d2 0x6bc821a5 0x4597b179 * Now, it is apparent why the 2nd object_id collates after the 1st: the * first le32 value of the 1st object_id is less than the first le32 of * the 2nd object_id. If the first le32 values of both object_ids were * equal then the second le32 values would be compared, etc. */ typedef enum { COLLATION_BINARY = const_cpu_to_le32(0), COLLATION_FILE_NAME = const_cpu_to_le32(1), COLLATION_UNICODE_STRING = const_cpu_to_le32(2), COLLATION_NTOFS_ULONG = const_cpu_to_le32(16), COLLATION_NTOFS_SID = const_cpu_to_le32(17), COLLATION_NTOFS_SECURITY_HASH = const_cpu_to_le32(18), COLLATION_NTOFS_ULONGS = const_cpu_to_le32(19), } COLLATION_RULES; /** * enum ATTR_DEF_FLAGS - * * The flags (32-bit) describing attribute properties in the attribute * definition structure. FIXME: This information is based on Regis's * information and, according to him, it is not certain and probably * incomplete. The INDEXABLE flag is fairly certainly correct as only the file * name attribute has this flag set and this is the only attribute indexed in * NT4. */ typedef enum { ATTR_DEF_INDEXABLE = const_cpu_to_le32(0x02), /* Attribute can be indexed. */ ATTR_DEF_MULTIPLE = const_cpu_to_le32(0x04), /* Attribute type can be present multiple times in the mft records of an inode. */ ATTR_DEF_NOT_ZERO = const_cpu_to_le32(0x08), /* Attribute value must contain at least one non-zero byte. */ ATTR_DEF_INDEXED_UNIQUE = const_cpu_to_le32(0x10), /* Attribute must be indexed and the attribute value must be unique for the attribute type in all of the mft records of an inode. */ ATTR_DEF_NAMED_UNIQUE = const_cpu_to_le32(0x20), /* Attribute must be named and the name must be unique for the attribute type in all of the mft records of an inode. */ ATTR_DEF_RESIDENT = const_cpu_to_le32(0x40), /* Attribute must be resident. */ ATTR_DEF_ALWAYS_LOG = const_cpu_to_le32(0x80), /* Always log modifications to this attribute, regardless of whether it is resident or non-resident. Without this, only log modifications if the attribute is resident. */ } ATTR_DEF_FLAGS; /** * struct ATTR_DEF - * * The data attribute of FILE_AttrDef contains a sequence of attribute * definitions for the NTFS volume. With this, it is supposed to be safe for an * older NTFS driver to mount a volume containing a newer NTFS version without * damaging it (that's the theory. In practice it's: not damaging it too much). * Entries are sorted by attribute type. The flags describe whether the * attribute can be resident/non-resident and possibly other things, but the * actual bits are unknown. */ typedef struct { /*hex ofs*/ /* 0*/ ntfschar name[0x40]; /* Unicode name of the attribute. Zero terminated. */ /* 80*/ ATTR_TYPES type; /* Type of the attribute. */ /* 84*/ le32 display_rule; /* Default display rule. FIXME: What does it mean? (AIA) */ /* 88*/ COLLATION_RULES collation_rule; /* Default collation rule. */ /* 8c*/ ATTR_DEF_FLAGS flags; /* Flags describing the attribute. */ /* 90*/ sle64 min_size; /* Optional minimum attribute size. */ /* 98*/ sle64 max_size; /* Maximum size of attribute. */ /* sizeof() = 0xa0 or 160 bytes */ } __attribute__((__packed__)) ATTR_DEF; /** * enum ATTR_FLAGS - Attribute flags (16-bit). */ typedef enum { ATTR_IS_COMPRESSED = const_cpu_to_le16(0x0001), ATTR_COMPRESSION_MASK = const_cpu_to_le16(0x00ff), /* Compression method mask. Also, first illegal value. */ ATTR_IS_ENCRYPTED = const_cpu_to_le16(0x4000), ATTR_IS_SPARSE = const_cpu_to_le16(0x8000), } __attribute__((__packed__)) ATTR_FLAGS; /* * Attribute compression. * * Only the data attribute is ever compressed in the current ntfs driver in * Windows. Further, compression is only applied when the data attribute is * non-resident. Finally, to use compression, the maximum allowed cluster size * on a volume is 4kib. * * The compression method is based on independently compressing blocks of X * clusters, where X is determined from the compression_unit value found in the * non-resident attribute record header (more precisely: X = 2^compression_unit * clusters). On Windows NT/2k, X always is 16 clusters (compression_unit = 4). * * There are three different cases of how a compression block of X clusters * can be stored: * * 1) The data in the block is all zero (a sparse block): * This is stored as a sparse block in the runlist, i.e. the runlist * entry has length = X and lcn = -1. The mapping pairs array actually * uses a delta_lcn value length of 0, i.e. delta_lcn is not present at * all, which is then interpreted by the driver as lcn = -1. * NOTE: Even uncompressed files can be sparse on NTFS 3.0 volumes, then * the same principles apply as above, except that the length is not * restricted to being any particular value. * * 2) The data in the block is not compressed: * This happens when compression doesn't reduce the size of the block * in clusters. I.e. if compression has a small effect so that the * compressed data still occupies X clusters, then the uncompressed data * is stored in the block. * This case is recognised by the fact that the runlist entry has * length = X and lcn >= 0. The mapping pairs array stores this as * normal with a run length of X and some specific delta_lcn, i.e. * delta_lcn has to be present. * * 3) The data in the block is compressed: * The common case. This case is recognised by the fact that the run * list entry has length L < X and lcn >= 0. The mapping pairs array * stores this as normal with a run length of X and some specific * delta_lcn, i.e. delta_lcn has to be present. This runlist entry is * immediately followed by a sparse entry with length = X - L and * lcn = -1. The latter entry is to make up the vcn counting to the * full compression block size X. * * In fact, life is more complicated because adjacent entries of the same type * can be coalesced. This means that one has to keep track of the number of * clusters handled and work on a basis of X clusters at a time being one * block. An example: if length L > X this means that this particular runlist * entry contains a block of length X and part of one or more blocks of length * L - X. Another example: if length L < X, this does not necessarily mean that * the block is compressed as it might be that the lcn changes inside the block * and hence the following runlist entry describes the continuation of the * potentially compressed block. The block would be compressed if the * following runlist entry describes at least X - L sparse clusters, thus * making up the compression block length as described in point 3 above. (Of * course, there can be several runlist entries with small lengths so that the * sparse entry does not follow the first data containing entry with * length < X.) * * NOTE: At the end of the compressed attribute value, there most likely is not * just the right amount of data to make up a compression block, thus this data * is not even attempted to be compressed. It is just stored as is, unless * the number of clusters it occupies is reduced when compressed in which case * it is stored as a compressed compression block, complete with sparse * clusters at the end. */ /** * enum RESIDENT_ATTR_FLAGS - Flags of resident attributes (8-bit). */ typedef enum { RESIDENT_ATTR_IS_INDEXED = 0x01, /* Attribute is referenced in an index (has implications for deleting and modifying the attribute). */ } __attribute__((__packed__)) RESIDENT_ATTR_FLAGS; /** * struct ATTR_RECORD - Attribute record header. * * Always aligned to 8-byte boundary. */ typedef struct { /*Ofs*/ /* 0*/ ATTR_TYPES type; /* The (32-bit) type of the attribute. */ /* 4*/ le32 length; /* Byte size of the resident part of the attribute (aligned to 8-byte boundary). Used to get to the next attribute. */ /* 8*/ u8 non_resident; /* If 0, attribute is resident. If 1, attribute is non-resident. */ /* 9*/ u8 name_length; /* Unicode character size of name of attribute. 0 if unnamed. */ /* 10*/ le16 name_offset; /* If name_length != 0, the byte offset to the beginning of the name from the attribute record. Note that the name is stored as a Unicode string. When creating, place offset just at the end of the record header. Then, follow with attribute value or mapping pairs array, resident and non-resident attributes respectively, aligning to an 8-byte boundary. */ /* 12*/ ATTR_FLAGS flags; /* Flags describing the attribute. */ /* 14*/ le16 instance; /* The instance of this attribute record. This number is unique within this mft record (see MFT_RECORD/next_attr_instance notes above for more details). */ /* 16*/ union { /* Resident attributes. */ struct { /* 16 */ le32 value_length; /* Byte size of attribute value. */ /* 20 */ le16 value_offset; /* Byte offset of the attribute value from the start of the attribute record. When creating, align to 8-byte boundary if we have a name present as this might not have a length of a multiple of 8-bytes. */ /* 22 */ RESIDENT_ATTR_FLAGS resident_flags; /* See above. */ /* 23 */ s8 reservedR; /* Reserved/alignment to 8-byte boundary. */ /* 24 */ void *resident_end[0]; /* Use offsetof(ATTR_RECORD, resident_end) to get size of a resident attribute. */ } __attribute__((__packed__)); /* Non-resident attributes. */ struct { /* 16*/ leVCN lowest_vcn; /* Lowest valid virtual cluster number for this portion of the attribute value or 0 if this is the only extent (usually the case). - Only when an attribute list is used does lowest_vcn != 0 ever occur. */ /* 24*/ leVCN highest_vcn; /* Highest valid vcn of this extent of the attribute value. - Usually there is only one portion, so this usually equals the attribute value size in clusters minus 1. Can be -1 for zero length files. Can be 0 for "single extent" attributes. */ /* 32*/ le16 mapping_pairs_offset; /* Byte offset from the beginning of the structure to the mapping pairs array which contains the mappings between the vcns and the logical cluster numbers (lcns). When creating, place this at the end of this record header aligned to 8-byte boundary. */ /* 34*/ u8 compression_unit; /* The compression unit expressed as the log to the base 2 of the number of clusters in a compression unit. 0 means not compressed. (This effectively limits the compression unit size to be a power of two clusters.) WinNT4 only uses a value of 4. */ /* 35*/ u8 reserved1[5]; /* Align to 8-byte boundary. */ /* The sizes below are only used when lowest_vcn is zero, as otherwise it would be difficult to keep them up-to-date.*/ /* 40*/ sle64 allocated_size; /* Byte size of disk space allocated to hold the attribute value. Always is a multiple of the cluster size. When a file is compressed, this field is a multiple of the compression block size (2^compression_unit) and it represents the logically allocated space rather than the actual on disk usage. For this use the compressed_size (see below). */ /* 48*/ sle64 data_size; /* Byte size of the attribute value. Can be larger than allocated_size if attribute value is compressed or sparse. */ /* 56*/ sle64 initialized_size; /* Byte size of initialized portion of the attribute value. Usually equals data_size. */ /* 64 */ void *non_resident_end[0]; /* Use offsetof(ATTR_RECORD, non_resident_end) to get size of a non resident attribute. */ /* sizeof(uncompressed attr) = 64*/ /* 64*/ sle64 compressed_size; /* Byte size of the attribute value after compression. Only present when compressed. Always is a multiple of the cluster size. Represents the actual amount of disk space being used on the disk. */ /* 72 */ void *compressed_end[0]; /* Use offsetof(ATTR_RECORD, compressed_end) to get size of a compressed attribute. */ /* sizeof(compressed attr) = 72*/ } __attribute__((__packed__)); } __attribute__((__packed__)); } __attribute__((__packed__)) ATTR_RECORD; typedef ATTR_RECORD ATTR_REC; /** * enum FILE_ATTR_FLAGS - File attribute flags (32-bit). */ typedef enum { /* * These flags are only present in the STANDARD_INFORMATION attribute * (in the field file_attributes). */ FILE_ATTR_READONLY = const_cpu_to_le32(0x00000001), FILE_ATTR_HIDDEN = const_cpu_to_le32(0x00000002), FILE_ATTR_SYSTEM = const_cpu_to_le32(0x00000004), /* Old DOS volid. Unused in NT. = const_cpu_to_le32(0x00000008), */ FILE_ATTR_DIRECTORY = const_cpu_to_le32(0x00000010), /* FILE_ATTR_DIRECTORY is not considered valid in NT. It is reserved for the DOS SUBDIRECTORY flag. */ FILE_ATTR_ARCHIVE = const_cpu_to_le32(0x00000020), FILE_ATTR_DEVICE = const_cpu_to_le32(0x00000040), FILE_ATTR_NORMAL = const_cpu_to_le32(0x00000080), FILE_ATTR_TEMPORARY = const_cpu_to_le32(0x00000100), FILE_ATTR_SPARSE_FILE = const_cpu_to_le32(0x00000200), FILE_ATTR_REPARSE_POINT = const_cpu_to_le32(0x00000400), FILE_ATTR_COMPRESSED = const_cpu_to_le32(0x00000800), FILE_ATTR_OFFLINE = const_cpu_to_le32(0x00001000), FILE_ATTR_NOT_CONTENT_INDEXED = const_cpu_to_le32(0x00002000), FILE_ATTR_ENCRYPTED = const_cpu_to_le32(0x00004000), /* Supposed to mean no data locally, possibly repurposed */ FILE_ATTRIBUTE_RECALL_ON_OPEN = const_cpu_to_le32(0x00040000), FILE_ATTR_VALID_FLAGS = const_cpu_to_le32(0x00047fb7), /* FILE_ATTR_VALID_FLAGS masks out the old DOS VolId and the FILE_ATTR_DEVICE and preserves everything else. This mask is used to obtain all flags that are valid for reading. */ FILE_ATTR_VALID_SET_FLAGS = const_cpu_to_le32(0x000031a7), /* FILE_ATTR_VALID_SET_FLAGS masks out the old DOS VolId, the FILE_ATTR_DEVICE, FILE_ATTR_DIRECTORY, FILE_ATTR_SPARSE_FILE, FILE_ATTR_REPARSE_POINT, FILE_ATRE_COMPRESSED and FILE_ATTR_ENCRYPTED and preserves the rest. This mask is used to to obtain all flags that are valid for setting. */ /** * FILE_ATTR_I30_INDEX_PRESENT - Is it a directory? * * This is a copy of the MFT_RECORD_IS_DIRECTORY bit from the mft * record, telling us whether this is a directory or not, i.e. whether * it has an index root attribute named "$I30" or not. * * This flag is only present in the FILE_NAME attribute (in the * file_attributes field). */ FILE_ATTR_I30_INDEX_PRESENT = const_cpu_to_le32(0x10000000), /** * FILE_ATTR_VIEW_INDEX_PRESENT - Does have a non-directory index? * * This is a copy of the MFT_RECORD_IS_VIEW_INDEX bit from the mft * record, telling us whether this file has a view index present (eg. * object id index, quota index, one of the security indexes and the * reparse points index). * * This flag is only present in the $STANDARD_INFORMATION and * $FILE_NAME attributes. */ FILE_ATTR_VIEW_INDEX_PRESENT = const_cpu_to_le32(0x20000000), } __attribute__((__packed__)) FILE_ATTR_FLAGS; /* * NOTE on times in NTFS: All times are in MS standard time format, i.e. they * are the number of 100-nanosecond intervals since 1st January 1601, 00:00:00 * universal coordinated time (UTC). (In Linux time starts 1st January 1970, * 00:00:00 UTC and is stored as the number of 1-second intervals since then.) */ /** * struct STANDARD_INFORMATION - Attribute: Standard information (0x10). * * NOTE: Always resident. * NOTE: Present in all base file records on a volume. * NOTE: There is conflicting information about the meaning of each of the time * fields but the meaning as defined below has been verified to be * correct by practical experimentation on Windows NT4 SP6a and is hence * assumed to be the one and only correct interpretation. */ typedef struct { /*Ofs*/ /* 0*/ sle64 creation_time; /* Time file was created. Updated when a filename is changed(?). */ /* 8*/ sle64 last_data_change_time; /* Time the data attribute was last modified. */ /* 16*/ sle64 last_mft_change_time; /* Time this mft record was last modified. */ /* 24*/ sle64 last_access_time; /* Approximate time when the file was last accessed (obviously this is not updated on read-only volumes). In Windows this is only updated when accessed if some time delta has passed since the last update. Also, last access times updates can be disabled altogether for speed. */ /* 32*/ FILE_ATTR_FLAGS file_attributes; /* Flags describing the file. */ /* 36*/ union { /* NTFS 1.2 (and previous, presumably) */ struct { /* 36 */ u8 reserved12[12]; /* Reserved/alignment to 8-byte boundary. */ /* 48 */ void *v1_end[0]; /* Marker for offsetof(). */ } __attribute__((__packed__)); /* sizeof() = 48 bytes */ /* NTFS 3.0 */ struct { /* * If a volume has been upgraded from a previous NTFS version, then these * fields are present only if the file has been accessed since the upgrade. * Recognize the difference by comparing the length of the resident attribute * value. If it is 48, then the following fields are missing. If it is 72 then * the fields are present. Maybe just check like this: * if (resident.ValueLength < sizeof(STANDARD_INFORMATION)) { * Assume NTFS 1.2- format. * If (volume version is 3.0+) * Upgrade attribute to NTFS 3.0 format. * else * Use NTFS 1.2- format for access. * } else * Use NTFS 3.0 format for access. * Only problem is that it might be legal to set the length of the value to * arbitrarily large values thus spoiling this check. - But chkdsk probably * views that as a corruption, assuming that it behaves like this for all * attributes. */ /* 36*/ le32 maximum_versions; /* Maximum allowed versions for file. Zero if version numbering is disabled. */ /* 40*/ le32 version_number; /* This file's version (if any). Set to zero if maximum_versions is zero. */ /* 44*/ le32 class_id; /* Class id from bidirectional class id index (?). */ /* 48*/ le32 owner_id; /* Owner_id of the user owning the file. Translate via $Q index in FILE_Extend /$Quota to the quota control entry for the user owning the file. Zero if quotas are disabled. */ /* 52*/ le32 security_id; /* Security_id for the file. Translate via $SII index and $SDS data stream in FILE_Secure to the security descriptor. */ /* 56*/ le64 quota_charged; /* Byte size of the charge to the quota for all streams of the file. Note: Is zero if quotas are disabled. */ /* 64*/ le64 usn; /* Last update sequence number of the file. This is a direct index into the change (aka usn) journal file. It is zero if the usn journal is disabled. NOTE: To disable the journal need to delete the journal file itself and to then walk the whole mft and set all Usn entries in all mft records to zero! (This can take a while!) The journal is FILE_Extend/$UsnJrnl. Win2k will recreate the journal and initiate logging if necessary when mounting the partition. This, in contrast to disabling the journal is a very fast process, so the user won't even notice it. */ /* 72*/ void *v3_end[0]; /* Marker for offsetof(). */ } __attribute__((__packed__)); } __attribute__((__packed__)); /* sizeof() = 72 bytes (NTFS 3.0) */ } __attribute__((__packed__)) STANDARD_INFORMATION; /** * struct ATTR_LIST_ENTRY - Attribute: Attribute list (0x20). * * - Can be either resident or non-resident. * - Value consists of a sequence of variable length, 8-byte aligned, * ATTR_LIST_ENTRY records. * - The attribute list attribute contains one entry for each attribute of * the file in which the list is located, except for the list attribute * itself. The list is sorted: first by attribute type, second by attribute * name (if present), third by instance number. The extents of one * non-resident attribute (if present) immediately follow after the initial * extent. They are ordered by lowest_vcn and have their instance set to zero. * It is not allowed to have two attributes with all sorting keys equal. * - Further restrictions: * - If not resident, the vcn to lcn mapping array has to fit inside the * base mft record. * - The attribute list attribute value has a maximum size of 256kb. This * is imposed by the Windows cache manager. * - Attribute lists are only used when the attributes of mft record do not * fit inside the mft record despite all attributes (that can be made * non-resident) having been made non-resident. This can happen e.g. when: * - File has a large number of hard links (lots of file name * attributes present). * - The mapping pairs array of some non-resident attribute becomes so * large due to fragmentation that it overflows the mft record. * - The security descriptor is very complex (not applicable to * NTFS 3.0 volumes). * - There are many named streams. */ typedef struct { /*Ofs*/ /* 0*/ ATTR_TYPES type; /* Type of referenced attribute. */ /* 4*/ le16 length; /* Byte size of this entry. */ /* 6*/ u8 name_length; /* Size in Unicode chars of the name of the attribute or 0 if unnamed. */ /* 7*/ u8 name_offset; /* Byte offset to beginning of attribute name (always set this to where the name would start even if unnamed). */ /* 8*/ leVCN lowest_vcn; /* Lowest virtual cluster number of this portion of the attribute value. This is usually 0. It is non-zero for the case where one attribute does not fit into one mft record and thus several mft records are allocated to hold this attribute. In the latter case, each mft record holds one extent of the attribute and there is one attribute list entry for each extent. NOTE: This is DEFINITELY a signed value! The windows driver uses cmp, followed by jg when comparing this, thus it treats it as signed. */ /* 16*/ leMFT_REF mft_reference;/* The reference of the mft record holding the ATTR_RECORD for this portion of the attribute value. */ /* 24*/ le16 instance; /* If lowest_vcn = 0, the instance of the attribute being referenced; otherwise 0. */ /* 26*/ ntfschar name[0]; /* Use when creating only. When reading use name_offset to determine the location of the name. */ /* sizeof() = 26 + (attribute_name_length * 2) bytes */ } __attribute__((__packed__)) ATTR_LIST_ENTRY; /* * The maximum allowed length for a file name. */ #define NTFS_MAX_NAME_LEN 255 /** * enum FILE_NAME_TYPE_FLAGS - Possible namespaces for filenames in ntfs. * (8-bit). */ typedef enum { FILE_NAME_POSIX = 0x00, /* This is the largest namespace. It is case sensitive and allows all Unicode characters except for: '\0' and '/'. Beware that in WinNT/2k files which eg have the same name except for their case will not be distinguished by the standard utilities and thus a "del filename" will delete both "filename" and "fileName" without warning. */ FILE_NAME_WIN32 = 0x01, /* The standard WinNT/2k NTFS long filenames. Case insensitive. All Unicode chars except: '\0', '"', '*', '/', ':', '<', '>', '?', '\' and '|'. Trailing dots and spaces are allowed, even though on Windows a filename with such a suffix can only be created and accessed using a WinNT-style path, i.e. \\?\-prefixed. (If a regular path is used, Windows will strip the trailing dots and spaces, which makes such filenames incompatible with most Windows software.) */ FILE_NAME_DOS = 0x02, /* The standard DOS filenames (8.3 format). Uppercase only. All 8-bit characters greater space, except: '"', '*', '+', ',', '/', ':', ';', '<', '=', '>', '?' and '\'. Trailing dots and spaces are forbidden. */ FILE_NAME_WIN32_AND_DOS = 0x03, /* 3 means that both the Win32 and the DOS filenames are identical and hence have been saved in this single filename record. */ } __attribute__((__packed__)) FILE_NAME_TYPE_FLAGS; /** * struct FILE_NAME_ATTR - Attribute: Filename (0x30). * * NOTE: Always resident. * NOTE: All fields, except the parent_directory, are only updated when the * filename is changed. Until then, they just become out of sync with * reality and the more up to date values are present in the standard * information attribute. * NOTE: There is conflicting information about the meaning of each of the time * fields but the meaning as defined below has been verified to be * correct by practical experimentation on Windows NT4 SP6a and is hence * assumed to be the one and only correct interpretation. */ typedef struct { /*hex ofs*/ /* 0*/ leMFT_REF parent_directory; /* Directory this filename is referenced from. */ /* 8*/ sle64 creation_time; /* Time file was created. */ /* 10*/ sle64 last_data_change_time; /* Time the data attribute was last modified. */ /* 18*/ sle64 last_mft_change_time; /* Time this mft record was last modified. */ /* 20*/ sle64 last_access_time; /* Last time this mft record was accessed. */ /* 28*/ sle64 allocated_size; /* Byte size of on-disk allocated space for the data attribute. So for normal $DATA, this is the allocated_size from the unnamed $DATA attribute and for compressed and/or sparse $DATA, this is the compressed_size from the unnamed $DATA attribute. NOTE: This is a multiple of the cluster size. */ /* 30*/ sle64 data_size; /* Byte size of actual data in data attribute. */ /* 38*/ FILE_ATTR_FLAGS file_attributes; /* Flags describing the file. */ /* 3c*/ union { /* 3c*/ struct { /* 3c*/ le16 packed_ea_size; /* Size of the buffer needed to pack the extended attributes (EAs), if such are present.*/ /* 3e*/ le16 reserved; /* Reserved for alignment. */ } __attribute__((__packed__)); /* 3c*/ le32 reparse_point_tag; /* Type of reparse point, present only in reparse points and only if there are no EAs. */ } __attribute__((__packed__)); /* 40*/ u8 file_name_length; /* Length of file name in (Unicode) characters. */ /* 41*/ FILE_NAME_TYPE_FLAGS file_name_type; /* Namespace of the file name.*/ /* 42*/ ntfschar file_name[0]; /* File name in Unicode. */ } __attribute__((__packed__)) FILE_NAME_ATTR; /** * struct GUID - GUID structures store globally unique identifiers (GUID). * * A GUID is a 128-bit value consisting of one group of eight hexadecimal * digits, followed by three groups of four hexadecimal digits each, followed * by one group of twelve hexadecimal digits. GUIDs are Microsoft's * implementation of the distributed computing environment (DCE) universally * unique identifier (UUID). * * Example of a GUID: * 1F010768-5A73-BC91-0010-A52216A7227B */ typedef struct { le32 data1; /* The first eight hexadecimal digits of the GUID. */ le16 data2; /* The first group of four hexadecimal digits. */ le16 data3; /* The second group of four hexadecimal digits. */ u8 data4[8]; /* The first two bytes are the third group of four hexadecimal digits. The remaining six bytes are the final 12 hexadecimal digits. */ } __attribute__((__packed__)) GUID; /** * struct OBJ_ID_INDEX_DATA - FILE_Extend/$ObjId contains an index named $O. * * This index contains all object_ids present on the volume as the index keys * and the corresponding mft_record numbers as the index entry data parts. * * The data part (defined below) also contains three other object_ids: * birth_volume_id - object_id of FILE_Volume on which the file was first * created. Optional (i.e. can be zero). * birth_object_id - object_id of file when it was first created. Usually * equals the object_id. Optional (i.e. can be zero). * domain_id - Reserved (always zero). */ typedef struct { leMFT_REF mft_reference; /* Mft record containing the object_id in the index entry key. */ union { struct { GUID birth_volume_id; GUID birth_object_id; GUID domain_id; } __attribute__((__packed__)); u8 extended_info[48]; } __attribute__((__packed__)); } __attribute__((__packed__)) OBJ_ID_INDEX_DATA; /** * struct OBJECT_ID_ATTR - Attribute: Object id (NTFS 3.0+) (0x40). * * NOTE: Always resident. */ typedef struct { GUID object_id; /* Unique id assigned to the file.*/ /* The following fields are optional. The attribute value size is 16 bytes, i.e. sizeof(GUID), if these are not present at all. Note, the entries can be present but one or more (or all) can be zero meaning that that particular value(s) is(are) not defined. Note, when the fields are missing here, it is well possible that they are to be found within the $Extend/$ObjId system file indexed under the above object_id. */ union { struct { GUID birth_volume_id; /* Unique id of volume on which the file was first created.*/ GUID birth_object_id; /* Unique id of file when it was first created. */ GUID domain_id; /* Reserved, zero. */ } __attribute__((__packed__)); u8 extended_info[48]; } __attribute__((__packed__)); } __attribute__((__packed__)) OBJECT_ID_ATTR; #if 0 /** * enum IDENTIFIER_AUTHORITIES - * * The pre-defined IDENTIFIER_AUTHORITIES used as SID_IDENTIFIER_AUTHORITY in * the SID structure (see below). */ typedef enum { /* SID string prefix. */ SECURITY_NULL_SID_AUTHORITY = {0, 0, 0, 0, 0, 0}, /* S-1-0 */ SECURITY_WORLD_SID_AUTHORITY = {0, 0, 0, 0, 0, 1}, /* S-1-1 */ SECURITY_LOCAL_SID_AUTHORITY = {0, 0, 0, 0, 0, 2}, /* S-1-2 */ SECURITY_CREATOR_SID_AUTHORITY = {0, 0, 0, 0, 0, 3}, /* S-1-3 */ SECURITY_NON_UNIQUE_AUTHORITY = {0, 0, 0, 0, 0, 4}, /* S-1-4 */ SECURITY_NT_SID_AUTHORITY = {0, 0, 0, 0, 0, 5}, /* S-1-5 */ } IDENTIFIER_AUTHORITIES; #endif /** * enum RELATIVE_IDENTIFIERS - * * These relative identifiers (RIDs) are used with the above identifier * authorities to make up universal well-known SIDs. * * Note: The relative identifier (RID) refers to the portion of a SID, which * identifies a user or group in relation to the authority that issued the SID. * For example, the universal well-known SID Creator Owner ID (S-1-3-0) is * made up of the identifier authority SECURITY_CREATOR_SID_AUTHORITY (3) and * the relative identifier SECURITY_CREATOR_OWNER_RID (0). */ typedef enum { /* Identifier authority. */ SECURITY_NULL_RID = 0, /* S-1-0 */ SECURITY_WORLD_RID = 0, /* S-1-1 */ SECURITY_LOCAL_RID = 0, /* S-1-2 */ SECURITY_CREATOR_OWNER_RID = 0, /* S-1-3 */ SECURITY_CREATOR_GROUP_RID = 1, /* S-1-3 */ SECURITY_CREATOR_OWNER_SERVER_RID = 2, /* S-1-3 */ SECURITY_CREATOR_GROUP_SERVER_RID = 3, /* S-1-3 */ SECURITY_DIALUP_RID = 1, SECURITY_NETWORK_RID = 2, SECURITY_BATCH_RID = 3, SECURITY_INTERACTIVE_RID = 4, SECURITY_SERVICE_RID = 6, SECURITY_ANONYMOUS_LOGON_RID = 7, SECURITY_PROXY_RID = 8, SECURITY_ENTERPRISE_CONTROLLERS_RID=9, SECURITY_SERVER_LOGON_RID = 9, SECURITY_PRINCIPAL_SELF_RID = 0xa, SECURITY_AUTHENTICATED_USER_RID = 0xb, SECURITY_RESTRICTED_CODE_RID = 0xc, SECURITY_TERMINAL_SERVER_RID = 0xd, SECURITY_LOGON_IDS_RID = 5, SECURITY_LOGON_IDS_RID_COUNT = 3, SECURITY_LOCAL_SYSTEM_RID = 0x12, SECURITY_NT_NON_UNIQUE = 0x15, SECURITY_BUILTIN_DOMAIN_RID = 0x20, /* * Well-known domain relative sub-authority values (RIDs). */ /* Users. */ DOMAIN_USER_RID_ADMIN = 0x1f4, DOMAIN_USER_RID_GUEST = 0x1f5, DOMAIN_USER_RID_KRBTGT = 0x1f6, /* Groups. */ DOMAIN_GROUP_RID_ADMINS = 0x200, DOMAIN_GROUP_RID_USERS = 0x201, DOMAIN_GROUP_RID_GUESTS = 0x202, DOMAIN_GROUP_RID_COMPUTERS = 0x203, DOMAIN_GROUP_RID_CONTROLLERS = 0x204, DOMAIN_GROUP_RID_CERT_ADMINS = 0x205, DOMAIN_GROUP_RID_SCHEMA_ADMINS = 0x206, DOMAIN_GROUP_RID_ENTERPRISE_ADMINS= 0x207, DOMAIN_GROUP_RID_POLICY_ADMINS = 0x208, /* Aliases. */ DOMAIN_ALIAS_RID_ADMINS = 0x220, DOMAIN_ALIAS_RID_USERS = 0x221, DOMAIN_ALIAS_RID_GUESTS = 0x222, DOMAIN_ALIAS_RID_POWER_USERS = 0x223, DOMAIN_ALIAS_RID_ACCOUNT_OPS = 0x224, DOMAIN_ALIAS_RID_SYSTEM_OPS = 0x225, DOMAIN_ALIAS_RID_PRINT_OPS = 0x226, DOMAIN_ALIAS_RID_BACKUP_OPS = 0x227, DOMAIN_ALIAS_RID_REPLICATOR = 0x228, DOMAIN_ALIAS_RID_RAS_SERVERS = 0x229, DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 0x22a, } RELATIVE_IDENTIFIERS; /* * The universal well-known SIDs: * * NULL_SID S-1-0-0 * WORLD_SID S-1-1-0 * LOCAL_SID S-1-2-0 * CREATOR_OWNER_SID S-1-3-0 * CREATOR_GROUP_SID S-1-3-1 * CREATOR_OWNER_SERVER_SID S-1-3-2 * CREATOR_GROUP_SERVER_SID S-1-3-3 * * (Non-unique IDs) S-1-4 * * NT well-known SIDs: * * NT_AUTHORITY_SID S-1-5 * DIALUP_SID S-1-5-1 * * NETWORD_SID S-1-5-2 * BATCH_SID S-1-5-3 * INTERACTIVE_SID S-1-5-4 * SERVICE_SID S-1-5-6 * ANONYMOUS_LOGON_SID S-1-5-7 (aka null logon session) * PROXY_SID S-1-5-8 * SERVER_LOGON_SID S-1-5-9 (aka domain controller account) * SELF_SID S-1-5-10 (self RID) * AUTHENTICATED_USER_SID S-1-5-11 * RESTRICTED_CODE_SID S-1-5-12 (running restricted code) * TERMINAL_SERVER_SID S-1-5-13 (running on terminal server) * * (Logon IDs) S-1-5-5-X-Y * * (NT non-unique IDs) S-1-5-0x15-... * * (Built-in domain) S-1-5-0x20 */ /** * union SID_IDENTIFIER_AUTHORITY - A 48-bit value used in the SID structure * * NOTE: This is stored as a big endian number. */ typedef union { struct { be16 high_part; /* High 16-bits. */ be32 low_part; /* Low 32-bits. */ } __attribute__((__packed__)); u8 value[6]; /* Value as individual bytes. */ } __attribute__((__packed__)) SID_IDENTIFIER_AUTHORITY; /** * struct SID - * * The SID structure is a variable-length structure used to uniquely identify * users or groups. SID stands for security identifier. * * The standard textual representation of the SID is of the form: * S-R-I-S-S... * Where: * - The first "S" is the literal character 'S' identifying the following * digits as a SID. * - R is the revision level of the SID expressed as a sequence of digits * in decimal. * - I is the 48-bit identifier_authority, expressed as digits in decimal, * if I < 2^32, or hexadecimal prefixed by "0x", if I >= 2^32. * - S... is one or more sub_authority values, expressed as digits in * decimal. * * Example SID; the domain-relative SID of the local Administrators group on * Windows NT/2k: * S-1-5-32-544 * This translates to a SID with: * revision = 1, * sub_authority_count = 2, * identifier_authority = {0,0,0,0,0,5}, // SECURITY_NT_AUTHORITY * sub_authority[0] = 32, // SECURITY_BUILTIN_DOMAIN_RID * sub_authority[1] = 544 // DOMAIN_ALIAS_RID_ADMINS */ typedef struct { u8 revision; u8 sub_authority_count; SID_IDENTIFIER_AUTHORITY identifier_authority; le32 sub_authority[1]; /* At least one sub_authority. */ } __attribute__((__packed__)) SID; /** * enum SID_CONSTANTS - Current constants for SIDs. */ typedef enum { SID_REVISION = 1, /* Current revision level. */ SID_MAX_SUB_AUTHORITIES = 15, /* Maximum number of those. */ SID_RECOMMENDED_SUB_AUTHORITIES = 1, /* Will change to around 6 in a future revision. */ } SID_CONSTANTS; /** * enum ACE_TYPES - The predefined ACE types (8-bit, see below). */ typedef enum { ACCESS_MIN_MS_ACE_TYPE = 0, ACCESS_ALLOWED_ACE_TYPE = 0, ACCESS_DENIED_ACE_TYPE = 1, SYSTEM_AUDIT_ACE_TYPE = 2, SYSTEM_ALARM_ACE_TYPE = 3, /* Not implemented as of Win2k. */ ACCESS_MAX_MS_V2_ACE_TYPE = 3, ACCESS_ALLOWED_COMPOUND_ACE_TYPE= 4, ACCESS_MAX_MS_V3_ACE_TYPE = 4, /* The following are Win2k only. */ ACCESS_MIN_MS_OBJECT_ACE_TYPE = 5, ACCESS_ALLOWED_OBJECT_ACE_TYPE = 5, ACCESS_DENIED_OBJECT_ACE_TYPE = 6, SYSTEM_AUDIT_OBJECT_ACE_TYPE = 7, SYSTEM_ALARM_OBJECT_ACE_TYPE = 8, ACCESS_MAX_MS_OBJECT_ACE_TYPE = 8, ACCESS_MAX_MS_V4_ACE_TYPE = 8, /* This one is for WinNT&2k. */ ACCESS_MAX_MS_ACE_TYPE = 8, /* Windows XP and later */ ACCESS_ALLOWED_CALLBACK_ACE_TYPE = 9, ACCESS_DENIED_CALLBACK_ACE_TYPE = 10, ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE = 11, ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE = 12, SYSTEM_AUDIT_CALLBACK_ACE_TYPE = 13, SYSTEM_ALARM_CALLBACK_ACE_TYPE = 14, /* reserved */ SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE = 15, SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE = 16, /* reserved */ /* Windows Vista and later */ SYSTEM_MANDATORY_LABEL_ACE_TYPE = 17, /* Windows 8 and later */ SYSTEM_RESOURCE_ATTRIBUTE_ACE_TYPE = 18, SYSTEM_SCOPED_POLICY_ID_ACE_TYPE = 19, /* Windows 10 and later */ SYSTEM_PROCESS_TRUST_LABEL_ACE_TYPE = 20, } __attribute__((__packed__)) ACE_TYPES; /** * enum ACE_FLAGS - The ACE flags (8-bit) for audit and inheritance. * * SUCCESSFUL_ACCESS_ACE_FLAG is only used with system audit and alarm ACE * types to indicate that a message is generated (in Windows!) for successful * accesses. * * FAILED_ACCESS_ACE_FLAG is only used with system audit and alarm ACE types * to indicate that a message is generated (in Windows!) for failed accesses. */ typedef enum { /* The inheritance flags. */ OBJECT_INHERIT_ACE = 0x01, CONTAINER_INHERIT_ACE = 0x02, NO_PROPAGATE_INHERIT_ACE = 0x04, INHERIT_ONLY_ACE = 0x08, INHERITED_ACE = 0x10, /* Win2k only. */ VALID_INHERIT_FLAGS = 0x1f, /* The audit flags. */ SUCCESSFUL_ACCESS_ACE_FLAG = 0x40, FAILED_ACCESS_ACE_FLAG = 0x80, } __attribute__((__packed__)) ACE_FLAGS; /** * struct ACE_HEADER - * * An ACE is an access-control entry in an access-control list (ACL). * An ACE defines access to an object for a specific user or group or defines * the types of access that generate system-administration messages or alarms * for a specific user or group. The user or group is identified by a security * identifier (SID). * * Each ACE starts with an ACE_HEADER structure (aligned on 4-byte boundary), * which specifies the type and size of the ACE. The format of the subsequent * data depends on the ACE type. */ typedef struct { ACE_TYPES type; /* Type of the ACE. */ ACE_FLAGS flags; /* Flags describing the ACE. */ le16 size; /* Size in bytes of the ACE. */ } __attribute__((__packed__)) ACE_HEADER; /** * enum ACCESS_MASK - The access mask (32-bit). * * Defines the access rights. */ typedef enum { /* * The specific rights (bits 0 to 15). Depend on the type of the * object being secured by the ACE. */ /* Specific rights for files and directories are as follows: */ /* Right to read data from the file. (FILE) */ FILE_READ_DATA = const_cpu_to_le32(0x00000001), /* Right to list contents of a directory. (DIRECTORY) */ FILE_LIST_DIRECTORY = const_cpu_to_le32(0x00000001), /* Right to write data to the file. (FILE) */ FILE_WRITE_DATA = const_cpu_to_le32(0x00000002), /* Right to create a file in the directory. (DIRECTORY) */ FILE_ADD_FILE = const_cpu_to_le32(0x00000002), /* Right to append data to the file. (FILE) */ FILE_APPEND_DATA = const_cpu_to_le32(0x00000004), /* Right to create a subdirectory. (DIRECTORY) */ FILE_ADD_SUBDIRECTORY = const_cpu_to_le32(0x00000004), /* Right to read extended attributes. (FILE/DIRECTORY) */ FILE_READ_EA = const_cpu_to_le32(0x00000008), /* Right to write extended attributes. (FILE/DIRECTORY) */ FILE_WRITE_EA = const_cpu_to_le32(0x00000010), /* Right to execute a file. (FILE) */ FILE_EXECUTE = const_cpu_to_le32(0x00000020), /* Right to traverse the directory. (DIRECTORY) */ FILE_TRAVERSE = const_cpu_to_le32(0x00000020), /* * Right to delete a directory and all the files it contains (its * children), even if the files are read-only. (DIRECTORY) */ FILE_DELETE_CHILD = const_cpu_to_le32(0x00000040), /* Right to read file attributes. (FILE/DIRECTORY) */ FILE_READ_ATTRIBUTES = const_cpu_to_le32(0x00000080), /* Right to change file attributes. (FILE/DIRECTORY) */ FILE_WRITE_ATTRIBUTES = const_cpu_to_le32(0x00000100), /* * The standard rights (bits 16 to 23). Are independent of the type of * object being secured. */ /* Right to delete the object. */ DELETE = const_cpu_to_le32(0x00010000), /* * Right to read the information in the object's security descriptor, * not including the information in the SACL. I.e. right to read the * security descriptor and owner. */ READ_CONTROL = const_cpu_to_le32(0x00020000), /* Right to modify the DACL in the object's security descriptor. */ WRITE_DAC = const_cpu_to_le32(0x00040000), /* Right to change the owner in the object's security descriptor. */ WRITE_OWNER = const_cpu_to_le32(0x00080000), /* * Right to use the object for synchronization. Enables a process to * wait until the object is in the signalled state. Some object types * do not support this access right. */ SYNCHRONIZE = const_cpu_to_le32(0x00100000), /* * The following STANDARD_RIGHTS_* are combinations of the above for * convenience and are defined by the Win32 API. */ /* These are currently defined to READ_CONTROL. */ STANDARD_RIGHTS_READ = const_cpu_to_le32(0x00020000), STANDARD_RIGHTS_WRITE = const_cpu_to_le32(0x00020000), STANDARD_RIGHTS_EXECUTE = const_cpu_to_le32(0x00020000), /* Combines DELETE, READ_CONTROL, WRITE_DAC, and WRITE_OWNER access. */ STANDARD_RIGHTS_REQUIRED = const_cpu_to_le32(0x000f0000), /* * Combines DELETE, READ_CONTROL, WRITE_DAC, WRITE_OWNER, and * SYNCHRONIZE access. */ STANDARD_RIGHTS_ALL = const_cpu_to_le32(0x001f0000), /* * The access system ACL and maximum allowed access types (bits 24 to * 25, bits 26 to 27 are reserved). */ ACCESS_SYSTEM_SECURITY = const_cpu_to_le32(0x01000000), MAXIMUM_ALLOWED = const_cpu_to_le32(0x02000000), /* * The generic rights (bits 28 to 31). These map onto the standard and * specific rights. */ /* Read, write, and execute access. */ GENERIC_ALL = const_cpu_to_le32(0x10000000), /* Execute access. */ GENERIC_EXECUTE = const_cpu_to_le32(0x20000000), /* * Write access. For files, this maps onto: * FILE_APPEND_DATA | FILE_WRITE_ATTRIBUTES | FILE_WRITE_DATA | * FILE_WRITE_EA | STANDARD_RIGHTS_WRITE | SYNCHRONIZE * For directories, the mapping has the same numerical value. See * above for the descriptions of the rights granted. */ GENERIC_WRITE = const_cpu_to_le32(0x40000000), /* * Read access. For files, this maps onto: * FILE_READ_ATTRIBUTES | FILE_READ_DATA | FILE_READ_EA | * STANDARD_RIGHTS_READ | SYNCHRONIZE * For directories, the mapping has the same numerical value. See * above for the descriptions of the rights granted. */ GENERIC_READ = const_cpu_to_le32(0x80000000), } ACCESS_MASK; /** * struct GENERIC_MAPPING - * * The generic mapping array. Used to denote the mapping of each generic * access right to a specific access mask. * * FIXME: What exactly is this and what is it for? (AIA) */ typedef struct { ACCESS_MASK generic_read; ACCESS_MASK generic_write; ACCESS_MASK generic_execute; ACCESS_MASK generic_all; } __attribute__((__packed__)) GENERIC_MAPPING; /* * The predefined ACE type structures are as defined below. */ /** * struct ACCESS_DENIED_ACE - * * ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE, SYSTEM_AUDIT_ACE, SYSTEM_ALARM_ACE */ typedef struct { /* 0 ACE_HEADER; -- Unfolded here as gcc doesn't like unnamed structs. */ ACE_TYPES type; /* Type of the ACE. */ ACE_FLAGS flags; /* Flags describing the ACE. */ le16 size; /* Size in bytes of the ACE. */ /* 4*/ ACCESS_MASK mask; /* Access mask associated with the ACE. */ /* 8*/ SID sid; /* The SID associated with the ACE. */ } __attribute__((__packed__)) ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE, SYSTEM_AUDIT_ACE, SYSTEM_ALARM_ACE; /** * enum OBJECT_ACE_FLAGS - The object ACE flags (32-bit). */ typedef enum { ACE_OBJECT_TYPE_PRESENT = const_cpu_to_le32(1), ACE_INHERITED_OBJECT_TYPE_PRESENT = const_cpu_to_le32(2), } OBJECT_ACE_FLAGS; /** * struct ACCESS_ALLOWED_OBJECT_ACE - */ typedef struct { /* 0 ACE_HEADER; -- Unfolded here as gcc doesn't like unnamed structs. */ ACE_TYPES type; /* Type of the ACE. */ ACE_FLAGS flags; /* Flags describing the ACE. */ le16 size; /* Size in bytes of the ACE. */ /* 4*/ ACCESS_MASK mask; /* Access mask associated with the ACE. */ /* 8*/ OBJECT_ACE_FLAGS object_flags; /* Flags describing the object ACE. */ /* 12*/ GUID object_type; /* 28*/ GUID inherited_object_type; /* 44*/ SID sid; /* The SID associated with the ACE. */ } __attribute__((__packed__)) ACCESS_ALLOWED_OBJECT_ACE, ACCESS_DENIED_OBJECT_ACE, SYSTEM_AUDIT_OBJECT_ACE, SYSTEM_ALARM_OBJECT_ACE; /** * struct ACL - An ACL is an access-control list (ACL). * * An ACL starts with an ACL header structure, which specifies the size of * the ACL and the number of ACEs it contains. The ACL header is followed by * zero or more access control entries (ACEs). The ACL as well as each ACE * are aligned on 4-byte boundaries. */ typedef struct { u8 revision; /* Revision of this ACL. */ u8 alignment1; le16 size; /* Allocated space in bytes for ACL. Includes this header, the ACEs and the remaining free space. */ le16 ace_count; /* Number of ACEs in the ACL. */ le16 alignment2; /* sizeof() = 8 bytes */ } __attribute__((__packed__)) ACL; /** * enum ACL_CONSTANTS - Current constants for ACLs. */ typedef enum { /* Current revision. */ ACL_REVISION = 2, ACL_REVISION_DS = 4, /* History of revisions. */ ACL_REVISION1 = 1, MIN_ACL_REVISION = 2, ACL_REVISION2 = 2, ACL_REVISION3 = 3, ACL_REVISION4 = 4, MAX_ACL_REVISION = 4, } ACL_CONSTANTS; /** * enum SECURITY_DESCRIPTOR_CONTROL - * * The security descriptor control flags (16-bit). * * SE_OWNER_DEFAULTED - This boolean flag, when set, indicates that the * SID pointed to by the Owner field was provided by a * defaulting mechanism rather than explicitly provided by the * original provider of the security descriptor. This may * affect the treatment of the SID with respect to inheritance * of an owner. * * SE_GROUP_DEFAULTED - This boolean flag, when set, indicates that the * SID in the Group field was provided by a defaulting mechanism * rather than explicitly provided by the original provider of * the security descriptor. This may affect the treatment of * the SID with respect to inheritance of a primary group. * * SE_DACL_PRESENT - This boolean flag, when set, indicates that the * security descriptor contains a discretionary ACL. If this * flag is set and the Dacl field of the SECURITY_DESCRIPTOR is * null, then a null ACL is explicitly being specified. * * SE_DACL_DEFAULTED - This boolean flag, when set, indicates that the * ACL pointed to by the Dacl field was provided by a defaulting * mechanism rather than explicitly provided by the original * provider of the security descriptor. This may affect the * treatment of the ACL with respect to inheritance of an ACL. * This flag is ignored if the DaclPresent flag is not set. * * SE_SACL_PRESENT - This boolean flag, when set, indicates that the * security descriptor contains a system ACL pointed to by the * Sacl field. If this flag is set and the Sacl field of the * SECURITY_DESCRIPTOR is null, then an empty (but present) * ACL is being specified. * * SE_SACL_DEFAULTED - This boolean flag, when set, indicates that the * ACL pointed to by the Sacl field was provided by a defaulting * mechanism rather than explicitly provided by the original * provider of the security descriptor. This may affect the * treatment of the ACL with respect to inheritance of an ACL. * This flag is ignored if the SaclPresent flag is not set. * * SE_SELF_RELATIVE - This boolean flag, when set, indicates that the * security descriptor is in self-relative form. In this form, * all fields of the security descriptor are contiguous in memory * and all pointer fields are expressed as offsets from the * beginning of the security descriptor. */ typedef enum { SE_OWNER_DEFAULTED = const_cpu_to_le16(0x0001), SE_GROUP_DEFAULTED = const_cpu_to_le16(0x0002), SE_DACL_PRESENT = const_cpu_to_le16(0x0004), SE_DACL_DEFAULTED = const_cpu_to_le16(0x0008), SE_SACL_PRESENT = const_cpu_to_le16(0x0010), SE_SACL_DEFAULTED = const_cpu_to_le16(0x0020), SE_DACL_AUTO_INHERIT_REQ = const_cpu_to_le16(0x0100), SE_SACL_AUTO_INHERIT_REQ = const_cpu_to_le16(0x0200), SE_DACL_AUTO_INHERITED = const_cpu_to_le16(0x0400), SE_SACL_AUTO_INHERITED = const_cpu_to_le16(0x0800), SE_DACL_PROTECTED = const_cpu_to_le16(0x1000), SE_SACL_PROTECTED = const_cpu_to_le16(0x2000), SE_RM_CONTROL_VALID = const_cpu_to_le16(0x4000), SE_SELF_RELATIVE = const_cpu_to_le16(0x8000), } __attribute__((__packed__)) SECURITY_DESCRIPTOR_CONTROL; /** * struct SECURITY_DESCRIPTOR_RELATIVE - * * Self-relative security descriptor. Contains the owner and group SIDs as well * as the sacl and dacl ACLs inside the security descriptor itself. */ typedef struct { u8 revision; /* Revision level of the security descriptor. */ u8 alignment; SECURITY_DESCRIPTOR_CONTROL control; /* Flags qualifying the type of the descriptor as well as the following fields. */ le32 owner; /* Byte offset to a SID representing an object's owner. If this is NULL, no owner SID is present in the descriptor. */ le32 group; /* Byte offset to a SID representing an object's primary group. If this is NULL, no primary group SID is present in the descriptor. */ le32 sacl; /* Byte offset to a system ACL. Only valid, if SE_SACL_PRESENT is set in the control field. If SE_SACL_PRESENT is set but sacl is NULL, a NULL ACL is specified. */ le32 dacl; /* Byte offset to a discretionary ACL. Only valid, if SE_DACL_PRESENT is set in the control field. If SE_DACL_PRESENT is set but dacl is NULL, a NULL ACL (unconditionally granting access) is specified. */ /* sizeof() = 0x14 bytes */ } __attribute__((__packed__)) SECURITY_DESCRIPTOR_RELATIVE; /** * struct SECURITY_DESCRIPTOR - Absolute security descriptor. * * Does not contain the owner and group SIDs, nor the sacl and dacl ACLs inside * the security descriptor. Instead, it contains pointers to these structures * in memory. Obviously, absolute security descriptors are only useful for in * memory representations of security descriptors. * * On disk, a self-relative security descriptor is used. */ typedef struct { u8 revision; /* Revision level of the security descriptor. */ u8 alignment; SECURITY_DESCRIPTOR_CONTROL control; /* Flags qualifying the type of the descriptor as well as the following fields. */ SID *owner; /* Points to a SID representing an object's owner. If this is NULL, no owner SID is present in the descriptor. */ SID *group; /* Points to a SID representing an object's primary group. If this is NULL, no primary group SID is present in the descriptor. */ ACL *sacl; /* Points to a system ACL. Only valid, if SE_SACL_PRESENT is set in the control field. If SE_SACL_PRESENT is set but sacl is NULL, a NULL ACL is specified. */ ACL *dacl; /* Points to a discretionary ACL. Only valid, if SE_DACL_PRESENT is set in the control field. If SE_DACL_PRESENT is set but dacl is NULL, a NULL ACL (unconditionally granting access) is specified. */ } __attribute__((__packed__)) SECURITY_DESCRIPTOR; /** * enum SECURITY_DESCRIPTOR_CONSTANTS - * * Current constants for security descriptors. */ typedef enum { /* Current revision. */ SECURITY_DESCRIPTOR_REVISION = 1, SECURITY_DESCRIPTOR_REVISION1 = 1, /* The sizes of both the absolute and relative security descriptors is the same as pointers, at least on ia32 architecture are 32-bit. */ SECURITY_DESCRIPTOR_MIN_LENGTH = sizeof(SECURITY_DESCRIPTOR), } SECURITY_DESCRIPTOR_CONSTANTS; /* * Attribute: Security descriptor (0x50). * * A standard self-relative security descriptor. * * NOTE: Can be resident or non-resident. * NOTE: Not used in NTFS 3.0+, as security descriptors are stored centrally * in FILE_Secure and the correct descriptor is found using the security_id * from the standard information attribute. */ typedef SECURITY_DESCRIPTOR_RELATIVE SECURITY_DESCRIPTOR_ATTR; /* * On NTFS 3.0+, all security descriptors are stored in FILE_Secure. Only one * referenced instance of each unique security descriptor is stored. * * FILE_Secure contains no unnamed data attribute, i.e. it has zero length. It * does, however, contain two indexes ($SDH and $SII) as well as a named data * stream ($SDS). * * Every unique security descriptor is assigned a unique security identifier * (security_id, not to be confused with a SID). The security_id is unique for * the NTFS volume and is used as an index into the $SII index, which maps * security_ids to the security descriptor's storage location within the $SDS * data attribute. The $SII index is sorted by ascending security_id. * * A simple hash is computed from each security descriptor. This hash is used * as an index into the $SDH index, which maps security descriptor hashes to * the security descriptor's storage location within the $SDS data attribute. * The $SDH index is sorted by security descriptor hash and is stored in a B+ * tree. When searching $SDH (with the intent of determining whether or not a * new security descriptor is already present in the $SDS data stream), if a * matching hash is found, but the security descriptors do not match, the * search in the $SDH index is continued, searching for a next matching hash. * * When a precise match is found, the security_id corresponding to the security * descriptor in the $SDS attribute is read from the found $SDH index entry and * is stored in the $STANDARD_INFORMATION attribute of the file/directory to * which the security descriptor is being applied. The $STANDARD_INFORMATION * attribute is present in all base mft records (i.e. in all files and * directories). * * If a match is not found, the security descriptor is assigned a new unique * security_id and is added to the $SDS data attribute. Then, entries * referencing the this security descriptor in the $SDS data attribute are * added to the $SDH and $SII indexes. * * Note: Entries are never deleted from FILE_Secure, even if nothing * references an entry any more. */ /** * struct SECURITY_DESCRIPTOR_HEADER - * * This header precedes each security descriptor in the $SDS data stream. * This is also the index entry data part of both the $SII and $SDH indexes. */ typedef struct { le32 hash; /* Hash of the security descriptor. */ le32 security_id; /* The security_id assigned to the descriptor. */ le64 offset; /* Byte offset of this entry in the $SDS stream. */ le32 length; /* Size in bytes of this entry in $SDS stream. */ } __attribute__((__packed__)) SECURITY_DESCRIPTOR_HEADER; /** * struct SDH_INDEX_DATA - */ typedef struct { le32 hash; /* Hash of the security descriptor. */ le32 security_id; /* The security_id assigned to the descriptor. */ le64 offset; /* Byte offset of this entry in the $SDS stream. */ le32 length; /* Size in bytes of this entry in $SDS stream. */ le32 reserved_II; /* Padding - always unicode "II" or zero. This field isn't counted in INDEX_ENTRY's data_length. */ } __attribute__((__packed__)) SDH_INDEX_DATA; /** * struct SII_INDEX_DATA - */ typedef SECURITY_DESCRIPTOR_HEADER SII_INDEX_DATA; /** * struct SDS_ENTRY - * * The $SDS data stream contains the security descriptors, aligned on 16-byte * boundaries, sorted by security_id in a B+ tree. Security descriptors cannot * cross 256kib boundaries (this restriction is imposed by the Windows cache * manager). Each security descriptor is contained in a SDS_ENTRY structure. * Also, each security descriptor is stored twice in the $SDS stream with a * fixed offset of 0x40000 bytes (256kib, the Windows cache manager's max size) * between them; i.e. if a SDS_ENTRY specifies an offset of 0x51d0, then the * the first copy of the security descriptor will be at offset 0x51d0 in the * $SDS data stream and the second copy will be at offset 0x451d0. */ typedef struct { /* 0 SECURITY_DESCRIPTOR_HEADER; -- Unfolded here as gcc doesn't like unnamed structs. */ le32 hash; /* Hash of the security descriptor. */ le32 security_id; /* The security_id assigned to the descriptor. */ le64 offset; /* Byte offset of this entry in the $SDS stream. */ le32 length; /* Size in bytes of this entry in $SDS stream. */ /* 20*/ SECURITY_DESCRIPTOR_RELATIVE sid; /* The self-relative security descriptor. */ } __attribute__((__packed__)) SDS_ENTRY; /** * struct SII_INDEX_KEY - The index entry key used in the $SII index. * * The collation type is COLLATION_NTOFS_ULONG. */ typedef struct { le32 security_id; /* The security_id assigned to the descriptor. */ } __attribute__((__packed__)) SII_INDEX_KEY; /** * struct SDH_INDEX_KEY - The index entry key used in the $SDH index. * * The keys are sorted first by hash and then by security_id. * The collation rule is COLLATION_NTOFS_SECURITY_HASH. */ typedef struct { le32 hash; /* Hash of the security descriptor. */ le32 security_id; /* The security_id assigned to the descriptor. */ } __attribute__((__packed__)) SDH_INDEX_KEY; /** * struct VOLUME_NAME - Attribute: Volume name (0x60). * * NOTE: Always resident. * NOTE: Present only in FILE_Volume. */ typedef struct { ntfschar name[0]; /* The name of the volume in Unicode. */ } __attribute__((__packed__)) VOLUME_NAME; /** * enum VOLUME_FLAGS - Possible flags for the volume (16-bit). */ typedef enum { VOLUME_IS_DIRTY = const_cpu_to_le16(0x0001), VOLUME_RESIZE_LOG_FILE = const_cpu_to_le16(0x0002), VOLUME_UPGRADE_ON_MOUNT = const_cpu_to_le16(0x0004), VOLUME_MOUNTED_ON_NT4 = const_cpu_to_le16(0x0008), VOLUME_DELETE_USN_UNDERWAY = const_cpu_to_le16(0x0010), VOLUME_REPAIR_OBJECT_ID = const_cpu_to_le16(0x0020), VOLUME_CHKDSK_UNDERWAY = const_cpu_to_le16(0x4000), VOLUME_MODIFIED_BY_CHKDSK = const_cpu_to_le16(0x8000), VOLUME_FLAGS_MASK = const_cpu_to_le16(0xc03f), } __attribute__((__packed__)) VOLUME_FLAGS; /** * struct VOLUME_INFORMATION - Attribute: Volume information (0x70). * * NOTE: Always resident. * NOTE: Present only in FILE_Volume. * NOTE: Windows 2000 uses NTFS 3.0 while Windows NT4 service pack 6a uses * NTFS 1.2. I haven't personally seen other values yet. */ typedef struct { le64 reserved; /* Not used (yet?). */ u8 major_ver; /* Major version of the ntfs format. */ u8 minor_ver; /* Minor version of the ntfs format. */ VOLUME_FLAGS flags; /* Bit array of VOLUME_* flags. */ } __attribute__((__packed__)) VOLUME_INFORMATION; /** * struct DATA_ATTR - Attribute: Data attribute (0x80). * * NOTE: Can be resident or non-resident. * * Data contents of a file (i.e. the unnamed stream) or of a named stream. */ typedef struct { u8 data[0]; /* The file's data contents. */ } __attribute__((__packed__)) DATA_ATTR; /** * enum INDEX_HEADER_FLAGS - Index header flags (8-bit). */ typedef enum { /* When index header is in an index root attribute: */ SMALL_INDEX = 0, /* The index is small enough to fit inside the index root attribute and there is no index allocation attribute present. */ LARGE_INDEX = 1, /* The index is too large to fit in the index root attribute and/or an index allocation attribute is present. */ /* * When index header is in an index block, i.e. is part of index * allocation attribute: */ LEAF_NODE = 0, /* This is a leaf node, i.e. there are no more nodes branching off it. */ INDEX_NODE = 1, /* This node indexes other nodes, i.e. is not a leaf node. */ NODE_MASK = 1, /* Mask for accessing the *_NODE bits. */ } __attribute__((__packed__)) INDEX_HEADER_FLAGS; /** * struct INDEX_HEADER - * * This is the header for indexes, describing the INDEX_ENTRY records, which * follow the INDEX_HEADER. Together the index header and the index entries * make up a complete index. * * IMPORTANT NOTE: The offset, length and size structure members are counted * relative to the start of the index header structure and not relative to the * start of the index root or index allocation structures themselves. */ typedef struct { /* 0*/ le32 entries_offset; /* Byte offset from the INDEX_HEADER to first INDEX_ENTRY, aligned to 8-byte boundary. */ /* 4*/ le32 index_length; /* Data size in byte of the INDEX_ENTRY's, including the INDEX_HEADER, aligned to 8. */ /* 8*/ le32 allocated_size; /* Allocated byte size of this index (block), multiple of 8 bytes. See more below. */ /* For the index root attribute, the above two numbers are always equal, as the attribute is resident and it is resized as needed. For the index allocation attribute, the attribute is not resident and the allocated_size is equal to the index_block_size specified by the corresponding INDEX_ROOT attribute minus the INDEX_BLOCK size not counting the INDEX_HEADER part (i.e. minus -24). */ /* 12*/ INDEX_HEADER_FLAGS ih_flags; /* Bit field of INDEX_HEADER_FLAGS. */ /* 13*/ u8 reserved[3]; /* Reserved/align to 8-byte boundary.*/ /* sizeof() == 16 */ } __attribute__((__packed__)) INDEX_HEADER; /* * $INDEX_ROOT attribute structure (always resident) * +--------------------------------------------------------------------+ * |ATTR_RECORD|INDEX_ROOT(include INDEX_HEADER)|INDEX_ENTRY| | |... * +--------------------------------------------------------------------+ */ /** * struct INDEX_ROOT - Attribute: Index root (0x90). * * NOTE: Always resident. * * This is followed by a sequence of index entries (INDEX_ENTRY structures) * as described by the index header. * * When a directory is small enough to fit inside the index root then this * is the only attribute describing the directory. When the directory is too * large to fit in the index root, on the other hand, two additional attributes * are present: an index allocation attribute, containing sub-nodes of the B+ * directory tree (see below), and a bitmap attribute, describing which virtual * cluster numbers (vcns) in the index allocation attribute are in use by an * index block. * * NOTE: The root directory (FILE_root) contains an entry for itself. Other * directories do not contain entries for themselves, though. */ typedef struct { /* 0*/ ATTR_TYPES type; /* Type of the indexed attribute. Is $FILE_NAME for directories, zero for view indexes. No other values allowed. */ /* 4*/ COLLATION_RULES collation_rule; /* Collation rule used to sort the index entries. If type is $FILE_NAME, this must be COLLATION_FILE_NAME. */ /* 8*/ le32 index_block_size; /* Size of index block in bytes (in the index allocation attribute). */ /* 12*/ s8 clusters_per_index_block; /* Size of index block in clusters (in the index allocation attribute), when an index block is >= than a cluster, otherwise sectors per index block. */ /* 13*/ u8 reserved[3]; /* Reserved/align to 8-byte boundary. */ /* 16*/ INDEX_HEADER index; /* Index header describing the following index entries. */ /* sizeof()= 32 bytes */ } __attribute__((__packed__)) INDEX_ROOT; /* * $INDEX_ALLOCATION attribute structure (always non-resident) * +------------------------------------------------------------------+ * |ATTR_RECORD| data run | * +------------------------------------------------------------------+ * * INDEX_ALLOCATION data structure * +------------------------------------------------------------------+ * |INDEX_BLOCK(include INDEX_HEADER)|USN array|INDEX_ENTRY| | |... * +------------------------------------------------------------------+ */ /** * struct INDEX_BLOCK - Attribute: Index allocation (0xa0). * * NOTE: Always non-resident (doesn't make sense to be resident anyway!). * * This is an array of index blocks. Each index block starts with an * INDEX_BLOCK structure containing an index header, followed by a sequence of * index entries (INDEX_ENTRY structures), as described by the INDEX_HEADER. */ typedef struct { /* 0 NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */ NTFS_RECORD_TYPES magic;/* Magic is "INDX". */ le16 usa_ofs; /* See NTFS_RECORD definition. */ le16 usa_count; /* See NTFS_RECORD definition. */ /* 8*/ leLSN lsn; /* $LogFile sequence number of the last modification of this index block. */ /* 16*/ leVCN index_block_vcn; /* Virtual cluster number of the index block. */ /* 24*/ INDEX_HEADER index; /* Describes the following index entries. */ /* sizeof()= 40 (0x28) bytes */ /* * When creating the index block, we place the update sequence array at this * offset, i.e. before we start with the index entries. This also makes sense, * otherwise we could run into problems with the update sequence array * containing in itself the last two bytes of a sector which would mean that * multi sector transfer protection wouldn't work. As you can't protect data * by overwriting it since you then can't get it back... * When reading use the data from the ntfs record header. */ } __attribute__((__packed__)) INDEX_BLOCK; typedef INDEX_BLOCK INDEX_ALLOCATION; /** * struct REPARSE_INDEX_KEY - * * The system file FILE_Extend/$Reparse contains an index named $R listing * all reparse points on the volume. The index entry keys are as defined * below. Note, that there is no index data associated with the index entries. * * The index entries are sorted by the index key file_id. The collation rule is * COLLATION_NTOFS_ULONGS. FIXME: Verify whether the reparse_tag is not the * primary key / is not a key at all. (AIA) */ typedef struct { le32 reparse_tag; /* Reparse point type (inc. flags). */ leMFT_REF file_id; /* Mft record of the file containing the reparse point attribute. */ } __attribute__((__packed__)) REPARSE_INDEX_KEY; /** * enum QUOTA_FLAGS - Quota flags (32-bit). */ typedef enum { /* The user quota flags. Names explain meaning. */ QUOTA_FLAG_DEFAULT_LIMITS = const_cpu_to_le32(0x00000001), QUOTA_FLAG_LIMIT_REACHED = const_cpu_to_le32(0x00000002), QUOTA_FLAG_ID_DELETED = const_cpu_to_le32(0x00000004), QUOTA_FLAG_USER_MASK = const_cpu_to_le32(0x00000007), /* Bit mask for user quota flags. */ /* These flags are only present in the quota defaults index entry, i.e. in the entry where owner_id = QUOTA_DEFAULTS_ID. */ QUOTA_FLAG_TRACKING_ENABLED = const_cpu_to_le32(0x00000010), QUOTA_FLAG_ENFORCEMENT_ENABLED = const_cpu_to_le32(0x00000020), QUOTA_FLAG_TRACKING_REQUESTED = const_cpu_to_le32(0x00000040), QUOTA_FLAG_LOG_THRESHOLD = const_cpu_to_le32(0x00000080), QUOTA_FLAG_LOG_LIMIT = const_cpu_to_le32(0x00000100), QUOTA_FLAG_OUT_OF_DATE = const_cpu_to_le32(0x00000200), QUOTA_FLAG_CORRUPT = const_cpu_to_le32(0x00000400), QUOTA_FLAG_PENDING_DELETES = const_cpu_to_le32(0x00000800), } QUOTA_FLAGS; /** * struct QUOTA_CONTROL_ENTRY - * * The system file FILE_Extend/$Quota contains two indexes $O and $Q. Quotas * are on a per volume and per user basis. * * The $Q index contains one entry for each existing user_id on the volume. The * index key is the user_id of the user/group owning this quota control entry, * i.e. the key is the owner_id. The user_id of the owner of a file, i.e. the * owner_id, is found in the standard information attribute. The collation rule * for $Q is COLLATION_NTOFS_ULONG. * * The $O index contains one entry for each user/group who has been assigned * a quota on that volume. The index key holds the SID of the user_id the * entry belongs to, i.e. the owner_id. The collation rule for $O is * COLLATION_NTOFS_SID. * * The $O index entry data is the user_id of the user corresponding to the SID. * This user_id is used as an index into $Q to find the quota control entry * associated with the SID. * * The $Q index entry data is the quota control entry and is defined below. */ typedef struct { le32 version; /* Currently equals 2. */ QUOTA_FLAGS flags; /* Flags describing this quota entry. */ le64 bytes_used; /* How many bytes of the quota are in use. */ sle64 change_time; /* Last time this quota entry was changed. */ sle64 threshold; /* Soft quota (-1 if not limited). */ sle64 limit; /* Hard quota (-1 if not limited). */ sle64 exceeded_time; /* How long the soft quota has been exceeded. */ /* The below field is NOT present for the quota defaults entry. */ SID sid; /* The SID of the user/object associated with this quota entry. If this field is missing then the INDEX_ENTRY is padded to a multiple of 8 with zeros which are not counted in the data_length field. If the sid is present then this structure is padded with zeros to a multiple of 8 and the padding is counted in the INDEX_ENTRY's data_length. */ } __attribute__((__packed__)) QUOTA_CONTROL_ENTRY; /** * struct QUOTA_O_INDEX_DATA - */ typedef struct { le32 owner_id; le32 unknown; /* Always 32. Seems to be padding and it's not counted in the INDEX_ENTRY's data_length. This field shouldn't be really here. */ } __attribute__((__packed__)) QUOTA_O_INDEX_DATA; /** * enum PREDEFINED_OWNER_IDS - Predefined owner_id values (32-bit). */ typedef enum { QUOTA_INVALID_ID = const_cpu_to_le32(0x00000000), QUOTA_DEFAULTS_ID = const_cpu_to_le32(0x00000001), QUOTA_FIRST_USER_ID = const_cpu_to_le32(0x00000100), } PREDEFINED_OWNER_IDS; /** * enum INDEX_ENTRY_FLAGS - Index entry flags (16-bit). */ typedef enum { INDEX_ENTRY_NODE = const_cpu_to_le16(1), /* This entry contains a sub-node, i.e. a reference to an index block in form of a virtual cluster number (see below). */ INDEX_ENTRY_END = const_cpu_to_le16(2), /* This signifies the last entry in an index block. The index entry does not represent a file but it can point to a sub-node. */ INDEX_ENTRY_SPACE_FILLER = 0xffff, /* Just to force 16-bit width. */ } __attribute__((__packed__)) INDEX_ENTRY_FLAGS; /** * struct INDEX_ENTRY_HEADER - This the index entry header (see below). * * ========================================================== * !!!!! SEE DESCRIPTION OF THE FIELDS AT INDEX_ENTRY !!!!! * ========================================================== */ typedef struct { /* 0*/ union { leMFT_REF indexed_file; struct { le16 data_offset; le16 data_length; le32 reservedV; } __attribute__((__packed__)); } __attribute__((__packed__)); /* 8*/ le16 length; /* 10*/ le16 key_length; /* 12*/ INDEX_ENTRY_FLAGS flags; /* 14*/ le16 reserved; /* sizeof() = 16 bytes */ } __attribute__((__packed__)) INDEX_ENTRY_HEADER; /** * struct INDEX_ENTRY - This is an index entry. * * A sequence of such entries follows each INDEX_HEADER structure. Together * they make up a complete index. The index follows either an index root * attribute or an index allocation attribute. * * NOTE: Before NTFS 3.0 only filename attributes were indexed. */ typedef struct { /* 0 INDEX_ENTRY_HEADER; -- Unfolded here as gcc dislikes unnamed structs. */ union { /* Only valid when INDEX_ENTRY_END is not set. */ leMFT_REF indexed_file; /* The mft reference of the file described by this index entry. Used for directory indexes. */ struct { /* Used for views/indexes to find the entry's data. */ le16 data_offset; /* Data byte offset from this INDEX_ENTRY. Follows the index key. */ le16 data_length; /* Data length in bytes. */ le32 reservedV; /* Reserved (zero). */ } __attribute__((__packed__)); } __attribute__((__packed__)); /* 8*/ le16 length; /* Byte size of this index entry, multiple of 8-bytes. Size includes INDEX_ENTRY_HEADER and the optional subnode VCN. See below. */ /* 10*/ le16 key_length; /* Byte size of the key value, which is in the index entry. It follows field reserved. Not multiple of 8-bytes. */ /* 12*/ INDEX_ENTRY_FLAGS ie_flags; /* Bit field of INDEX_ENTRY_* flags. */ /* 14*/ le16 reserved; /* Reserved/align to 8-byte boundary. */ /* End of INDEX_ENTRY_HEADER */ /* 16*/ union { /* The key of the indexed attribute. NOTE: Only present if INDEX_ENTRY_END bit in flags is not set. NOTE: On NTFS versions before 3.0 the only valid key is the FILE_NAME_ATTR. On NTFS 3.0+ the following additional index keys are defined: */ FILE_NAME_ATTR file_name;/* $I30 index in directories. */ SII_INDEX_KEY sii; /* $SII index in $Secure. */ SDH_INDEX_KEY sdh; /* $SDH index in $Secure. */ GUID object_id; /* $O index in FILE_Extend/$ObjId: The object_id of the mft record found in the data part of the index. */ REPARSE_INDEX_KEY reparse; /* $R index in FILE_Extend/$Reparse. */ SID sid; /* $O index in FILE_Extend/$Quota: SID of the owner of the user_id. */ le32 owner_id; /* $Q index in FILE_Extend/$Quota: user_id of the owner of the quota control entry in the data part of the index. */ } __attribute__((__packed__)) key; /* The (optional) index data is inserted here when creating. leVCN vcn; If INDEX_ENTRY_NODE bit in ie_flags is set, the last eight bytes of this index entry contain the virtual cluster number of the index block that holds the entries immediately preceding the current entry. If the key_length is zero, then the vcn immediately follows the INDEX_ENTRY_HEADER. The address of the vcn of "ie" INDEX_ENTRY is given by (char*)ie + le16_to_cpu(ie->length) - sizeof(VCN) */ } __attribute__((__packed__)) INDEX_ENTRY; /** * struct BITMAP_ATTR - Attribute: Bitmap (0xb0). * * Contains an array of bits (aka a bitfield). * * When used in conjunction with the index allocation attribute, each bit * corresponds to one index block within the index allocation attribute. Thus * the number of bits in the bitmap * index block size / cluster size is the * number of clusters in the index allocation attribute. */ typedef struct { u8 bitmap[0]; /* Array of bits. */ } __attribute__((__packed__)) BITMAP_ATTR; /** * enum PREDEFINED_REPARSE_TAGS - * * The reparse point tag defines the type of the reparse point. It also * includes several flags, which further describe the reparse point. * * The reparse point tag is an unsigned 32-bit value divided in three parts: * * 1. The least significant 16 bits (i.e. bits 0 to 15) specify the type of * the reparse point. * 2. The 12 bits after this (i.e. bits 16 to 27) are reserved for future use. * 3. The most significant four bits are flags describing the reparse point. * They are defined as follows: * bit 28: Directory bit. If set, the directory is not a surrogate * and can be used the usual way. * bit 29: Name surrogate bit. If set, the filename is an alias for * another object in the system. * bit 30: High-latency bit. If set, accessing the first byte of data will * be slow. (E.g. the data is stored on a tape drive.) * bit 31: Microsoft bit. If set, the tag is owned by Microsoft. User * defined tags have to use zero here. * 4. Moreover, on Windows 10 : * Some flags may be used in bits 12 to 15 to further describe the * reparse point. */ typedef enum { IO_REPARSE_TAG_DIRECTORY = const_cpu_to_le32(0x10000000), IO_REPARSE_TAG_IS_ALIAS = const_cpu_to_le32(0x20000000), IO_REPARSE_TAG_IS_HIGH_LATENCY = const_cpu_to_le32(0x40000000), IO_REPARSE_TAG_IS_MICROSOFT = const_cpu_to_le32(0x80000000), IO_REPARSE_TAG_RESERVED_ZERO = const_cpu_to_le32(0x00000000), IO_REPARSE_TAG_RESERVED_ONE = const_cpu_to_le32(0x00000001), IO_REPARSE_TAG_RESERVED_RANGE = const_cpu_to_le32(0x00000001), IO_REPARSE_TAG_CSV = const_cpu_to_le32(0x80000009), IO_REPARSE_TAG_DEDUP = const_cpu_to_le32(0x80000013), IO_REPARSE_TAG_DFS = const_cpu_to_le32(0x8000000A), IO_REPARSE_TAG_DFSR = const_cpu_to_le32(0x80000012), IO_REPARSE_TAG_HSM = const_cpu_to_le32(0xC0000004), IO_REPARSE_TAG_HSM2 = const_cpu_to_le32(0x80000006), IO_REPARSE_TAG_MOUNT_POINT = const_cpu_to_le32(0xA0000003), IO_REPARSE_TAG_NFS = const_cpu_to_le32(0x80000014), IO_REPARSE_TAG_SIS = const_cpu_to_le32(0x80000007), IO_REPARSE_TAG_SYMLINK = const_cpu_to_le32(0xA000000C), IO_REPARSE_TAG_WIM = const_cpu_to_le32(0x80000008), IO_REPARSE_TAG_DFM = const_cpu_to_le32(0x80000016), IO_REPARSE_TAG_WOF = const_cpu_to_le32(0x80000017), IO_REPARSE_TAG_WCI = const_cpu_to_le32(0x80000018), IO_REPARSE_TAG_CLOUD = const_cpu_to_le32(0x9000001A), IO_REPARSE_TAG_APPEXECLINK = const_cpu_to_le32(0x8000001B), IO_REPARSE_TAG_GVFS = const_cpu_to_le32(0x9000001C), IO_REPARSE_TAG_LX_SYMLINK = const_cpu_to_le32(0xA000001D), IO_REPARSE_TAG_AF_UNIX = const_cpu_to_le32(0x80000023), IO_REPARSE_TAG_LX_FIFO = const_cpu_to_le32(0x80000024), IO_REPARSE_TAG_LX_CHR = const_cpu_to_le32(0x80000025), IO_REPARSE_TAG_LX_BLK = const_cpu_to_le32(0x80000026), IO_REPARSE_TAG_VALID_VALUES = const_cpu_to_le32(0xf000ffff), IO_REPARSE_PLUGIN_SELECT = const_cpu_to_le32(0xffff0fff), } PREDEFINED_REPARSE_TAGS; /** * struct REPARSE_POINT - Attribute: Reparse point (0xc0). * * NOTE: Can be resident or non-resident. */ typedef struct { le32 reparse_tag; /* Reparse point type (inc. flags). */ le16 reparse_data_length; /* Byte size of reparse data. */ le16 reserved; /* Align to 8-byte boundary. */ u8 reparse_data[0]; /* Meaning depends on reparse_tag. */ } __attribute__((__packed__)) REPARSE_POINT; /** * struct EA_INFORMATION - Attribute: Extended attribute information (0xd0). * * NOTE: Always resident. */ typedef struct { le16 ea_length; /* Byte size of the packed extended attributes. */ le16 need_ea_count; /* The number of extended attributes which have the NEED_EA bit set. */ le32 ea_query_length; /* Byte size of the buffer required to query the extended attributes when calling ZwQueryEaFile() in Windows NT/2k. I.e. the byte size of the unpacked extended attributes. */ } __attribute__((__packed__)) EA_INFORMATION; /** * enum EA_FLAGS - Extended attribute flags (8-bit). */ typedef enum { NEED_EA = 0x80, /* Indicate that the file to which the EA belongs cannot be interpreted without understanding the associated extended attributes. */ } __attribute__((__packed__)) EA_FLAGS; /** * struct EA_ATTR - Attribute: Extended attribute (EA) (0xe0). * * Like the attribute list and the index buffer list, the EA attribute value is * a sequence of EA_ATTR variable length records. * * FIXME: It appears weird that the EA name is not Unicode. Is it true? * FIXME: It seems that name is always uppercased. Is it true? */ typedef struct { le32 next_entry_offset; /* Offset to the next EA_ATTR. */ EA_FLAGS flags; /* Flags describing the EA. */ u8 name_length; /* Length of the name of the extended attribute in bytes. */ le16 value_length; /* Byte size of the EA's value. */ u8 name[0]; /* Name of the EA. */ u8 value[0]; /* The value of the EA. Immediately follows the name. */ } __attribute__((__packed__)) EA_ATTR; /** * struct PROPERTY_SET - Attribute: Property set (0xf0). * * Intended to support Native Structure Storage (NSS) - a feature removed from * NTFS 3.0 during beta testing. */ typedef struct { /* Irrelevant as feature unused. */ } __attribute__((__packed__)) PROPERTY_SET; /** * struct LOGGED_UTILITY_STREAM - Attribute: Logged utility stream (0x100). * * NOTE: Can be resident or non-resident. * * Operations on this attribute are logged to the journal ($LogFile) like * normal metadata changes. * * Used by the Encrypting File System (EFS). All encrypted files have this * attribute with the name $EFS. See below for the relevant structures. */ typedef struct { /* Can be anything the creator chooses. */ } __attribute__((__packed__)) LOGGED_UTILITY_STREAM; /* * $EFS Data Structure: * * The following information is about the data structures that are contained * inside a logged utility stream (0x100) with a name of "$EFS". * * The stream starts with an instance of EFS_ATTR_HEADER. * * Next, at offsets offset_to_ddf_array and offset_to_drf_array (unless any of * them is 0) there is a EFS_DF_ARRAY_HEADER immediately followed by a sequence * of multiple data decryption/recovery fields. * * Each data decryption/recovery field starts with a EFS_DF_HEADER and the next * one (if it exists) can be found by adding EFS_DF_HEADER->df_length bytes to * the offset of the beginning of the current EFS_DF_HEADER. * * The data decryption/recovery field contains an EFS_DF_CERTIFICATE_HEADER, a * SID, an optional GUID, an optional container name, a non-optional user name, * and the encrypted FEK. * * Note all the below are best guesses so may have mistakes/inaccuracies. * Corrections/clarifications/additions are always welcome! * * Ntfs.sys takes an EFS value length of <= 0x54 or > 0x40000 to BSOD, i.e. it * is invalid. */ /** * struct EFS_ATTR_HEADER - "$EFS" header. * * The header of the Logged utility stream (0x100) attribute named "$EFS". */ typedef struct { /* 0*/ le32 length; /* Length of EFS attribute in bytes. */ le32 state; /* Always 0? */ le32 version; /* Efs version. Always 2? */ le32 crypto_api_version; /* Always 0? */ /* 16*/ u8 unknown4[16]; /* MD5 hash of decrypted FEK? This field is created with a call to UuidCreate() so is unlikely to be an MD5 hash and is more likely to be GUID of this encrytped file or something like that. */ /* 32*/ u8 unknown5[16]; /* MD5 hash of DDFs? */ /* 48*/ u8 unknown6[16]; /* MD5 hash of DRFs? */ /* 64*/ le32 offset_to_ddf_array;/* Offset in bytes to the array of data decryption fields (DDF), see below. Zero if no DDFs are present. */ le32 offset_to_drf_array;/* Offset in bytes to the array of data recovery fields (DRF), see below. Zero if no DRFs are present. */ le32 reserved; /* Reserved. */ } __attribute__((__packed__)) EFS_ATTR_HEADER; /** * struct EFS_DF_ARRAY_HEADER - */ typedef struct { le32 df_count; /* Number of data decryption/recovery fields in the array. */ } __attribute__((__packed__)) EFS_DF_ARRAY_HEADER; /** * struct EFS_DF_HEADER - */ typedef struct { /* 0*/ le32 df_length; /* Length of this data decryption/recovery field in bytes. */ le32 cred_header_offset; /* Offset in bytes to the credential header. */ le32 fek_size; /* Size in bytes of the encrypted file encryption key (FEK). */ le32 fek_offset; /* Offset in bytes to the FEK from the start of the data decryption/recovery field. */ /* 16*/ le32 unknown1; /* always 0? Might be just padding. */ } __attribute__((__packed__)) EFS_DF_HEADER; /** * struct EFS_DF_CREDENTIAL_HEADER - */ typedef struct { /* 0*/ le32 cred_length; /* Length of this credential in bytes. */ le32 sid_offset; /* Offset in bytes to the user's sid from start of this structure. Zero if no sid is present. */ /* 8*/ le32 type; /* Type of this credential: 1 = CryptoAPI container. 2 = Unexpected type. 3 = Certificate thumbprint. other = Unknown type. */ union { /* CryptoAPI container. */ struct { /* 12*/ le32 container_name_offset; /* Offset in bytes to the name of the container from start of this structure (may not be zero). */ /* 16*/ le32 provider_name_offset; /* Offset in bytes to the name of the provider from start of this structure (may not be zero). */ le32 public_key_blob_offset; /* Offset in bytes to the public key blob from start of this structure. */ /* 24*/ le32 public_key_blob_size; /* Size in bytes of public key blob. */ } __attribute__((__packed__)); /* Certificate thumbprint. */ struct { /* 12*/ le32 cert_thumbprint_header_size; /* Size in bytes of the header of the certificate thumbprint. */ /* 16*/ le32 cert_thumbprint_header_offset; /* Offset in bytes to the header of the certificate thumbprint from start of this structure. */ le32 unknown1; /* Always 0? Might be padding... */ le32 unknown2; /* Always 0? Might be padding... */ } __attribute__((__packed__)); } __attribute__((__packed__)); } __attribute__((__packed__)) EFS_DF_CREDENTIAL_HEADER; typedef EFS_DF_CREDENTIAL_HEADER EFS_DF_CRED_HEADER; /** * struct EFS_DF_CERTIFICATE_THUMBPRINT_HEADER - */ typedef struct { /* 0*/ le32 thumbprint_offset; /* Offset in bytes to the thumbprint. */ le32 thumbprint_size; /* Size of thumbprint in bytes. */ /* 8*/ le32 container_name_offset; /* Offset in bytes to the name of the container from start of this structure or 0 if no name present. */ le32 provider_name_offset; /* Offset in bytes to the name of the cryptographic provider from start of this structure or 0 if no name present. */ /* 16*/ le32 user_name_offset; /* Offset in bytes to the user name from start of this structure or 0 if no user name present. (This is also known as lpDisplayInformation.) */ } __attribute__((__packed__)) EFS_DF_CERTIFICATE_THUMBPRINT_HEADER; typedef EFS_DF_CERTIFICATE_THUMBPRINT_HEADER EFS_DF_CERT_THUMBPRINT_HEADER; typedef enum { INTX_SYMBOLIC_LINK = const_cpu_to_le64(0x014B4E4C78746E49ULL), /* "IntxLNK\1" */ INTX_CHARACTER_DEVICE = const_cpu_to_le64(0x0052484378746E49ULL), /* "IntxCHR\0" */ INTX_BLOCK_DEVICE = const_cpu_to_le64(0x004B4C4278746E49ULL), /* "IntxBLK\0" */ } INTX_FILE_TYPES; typedef struct { INTX_FILE_TYPES magic; /* Intx file magic. */ union { /* For character and block devices. */ struct { le64 major; /* Major device number. */ le64 minor; /* Minor device number. */ void *device_end[0]; /* Marker for offsetof(). */ } __attribute__((__packed__)); /* For symbolic links. */ ntfschar target[0]; } __attribute__((__packed__)); } __attribute__((__packed__)) INTX_FILE; #endif /* defined _NTFS_LAYOUT_H */ ntfsprogs-plus-1.0.0/include/lcnalloc.h000066400000000000000000000035271507404161300201110ustar00rootroot00000000000000/* * lcnalloc.h - Exports for cluster (de)allocation. Originated from the Linux-NTFS * project. * * Copyright (c) 2002 Anton Altaparmakov * Copyright (c) 2004 Yura Pakhuchiy * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_LCNALLOC_H #define _NTFS_LCNALLOC_H #include "types.h" #include "runlist.h" #include "volume.h" #define LCNBMP_ALLOC_SIZE 4096 #define MFTBMP_ALLOC_SIZE 4096 /** * enum NTFS_CLUSTER_ALLOCATION_ZONES - */ typedef enum { FIRST_ZONE = 0, /* For sanity checking. */ MFT_ZONE = 0, /* Allocate from $MFT zone. */ DATA_ZONE = 1, /* Allocate from $DATA zone. */ LAST_ZONE = 1, /* For sanity checking. */ } NTFS_CLUSTER_ALLOCATION_ZONES; extern runlist *ntfs_cluster_alloc(ntfs_volume *vol, VCN start_vcn, s64 count, LCN start_lcn, const NTFS_CLUSTER_ALLOCATION_ZONES zone); extern int ntfs_cluster_free_from_rl(ntfs_volume *vol, runlist *rl); extern int ntfs_cluster_free_basic(ntfs_volume *vol, s64 lcn, s64 count); extern int ntfs_cluster_free(ntfs_volume *vol, ntfs_attr *na, VCN start_vcn, s64 count); #endif /* defined _NTFS_LCNALLOC_H */ ntfsprogs-plus-1.0.0/include/lib_utils.h000066400000000000000000000006771507404161300203130ustar00rootroot00000000000000#ifndef _LIB_UTILS_H_ #define _LIB_UTILS_H_ #include "config.h" #include "types.h" #include "layout.h" #include "volume.h" #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STDARG_H #include #endif int utils_is_metadata(ntfs_inode *inode); ATTR_RECORD * find_attribute(const ATTR_TYPES type, ntfs_attr_search_ctx *ctx); ATTR_RECORD * find_first_attribute(const ATTR_TYPES type, MFT_RECORD *mft); #endif /* _LIB_UTILS_H_ */ ntfsprogs-plus-1.0.0/include/logfile.h000066400000000000000000000436271507404161300177500ustar00rootroot00000000000000/* * logfile.h - Exports for $LogFile handling. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2005 Anton Altaparmakov * Copyright (c) 2016 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_LOGFILE_H #define _NTFS_LOGFILE_H #include "types.h" #include "endians.h" #include "layout.h" /* * Journal ($LogFile) organization: * * Two restart areas present in the first two pages (restart pages, one restart * area in each page). When the volume is dismounted they should be identical, * except for the update sequence array which usually has a different update * sequence number. * * These are followed by log records organized in pages headed by a log record * header going up to log file size. Not all pages contain log records when a * volume is first formatted, but as the volume ages, all records will be used. * When the log file fills up, the records at the beginning are purged (by * modifying the oldest_lsn to a higher value presumably) and writing begins * at the beginning of the file. Effectively, the log file is viewed as a * circular entity. * * NOTE: Windows NT, 2000, and XP all use log file version 1.1 but they accept * versions <= 1.x, including 0.-1. (Yes, that is a minus one in there!) We * probably only want to support 1.1 as this seems to be the current version * and we don't know how that differs from the older versions. The only * exception is if the journal is clean as marked by the two restart pages * then it doesn't matter whether we are on an earlier version. We can just * reinitialize the logfile and start again with version 1.1. */ /* Some $LogFile related constants. */ #define MaxLogFileSize 0x100000000ULL #define DefaultLogPageSize 4096 #define MinLogRecordPages 48 /** * struct RESTART_PAGE_HEADER - Log file restart page header. * * Begins the restart area. */ typedef struct { /*Ofs*/ /* 0 NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */ /* 0*/ NTFS_RECORD_TYPES magic;/* The magic is "RSTR". */ /* 4*/ le16 usa_ofs; /* See NTFS_RECORD definition in layout.h. When creating, set this to be immediately after this header structure (without any alignment). */ /* 6*/ le16 usa_count; /* See NTFS_RECORD definition in layout.h. */ /* 8*/ leLSN chkdsk_lsn; /* The last log file sequence number found by chkdsk. Only used when the magic is changed to "CHKD". Otherwise this is zero. */ /* 16*/ le32 system_page_size; /* Byte size of system pages when the log file was created, has to be >= 512 and a power of 2. Use this to calculate the required size of the usa (usa_count) and add it to usa_ofs. Then verify that the result is less than the value of the restart_area_offset. */ /* 20*/ le32 log_page_size; /* Byte size of log file pages, has to be >= 512 and a power of 2. The default is 4096 and is used when the system page size is between 4096 and 8192. Otherwise this is set to the system page size instead. */ /* 24*/ le16 restart_area_offset;/* Byte offset from the start of this header to the RESTART_AREA. Value has to be aligned to 8-byte boundary. When creating, set this to be after the usa. */ /* 26*/ sle16 minor_ver; /* Log file minor version. Only check if major version is 1. */ /* 28*/ sle16 major_ver; /* Log file major version. We only support version 1.1. */ /* 30*/ le16 usn; /* sizeof() = 32 (0x20) bytes */ } __attribute__((__packed__)) RESTART_PAGE_HEADER; /* * Constant for the log client indices meaning that there are no client records * in this particular client array. Also inside the client records themselves, * this means that there are no client records preceding or following this one. */ #define LOGFILE_NO_CLIENT_CPU 0xffff #define LOGFILE_NO_CLIENT const_cpu_to_le16(LOGFILE_NO_CLIENT_CPU) /* * These are the so far known RESTART_AREA_* flags (16-bit) which contain * information about the log file in which they are present. */ enum { RESTART_VOLUME_IS_CLEAN = const_cpu_to_le16(0x0002), RESTART_SPACE_FILLER = 0xffff, /* gcc: Force enum bit width to 16. */ } __attribute__((__packed__)); typedef le16 RESTART_AREA_FLAGS; /** * struct RESTART_AREA - Log file restart area record. * * The offset of this record is found by adding the offset of the * RESTART_PAGE_HEADER to the restart_area_offset value found in it. * See notes at restart_area_offset above. */ typedef struct { /*Ofs*/ /* 0*/ leLSN current_lsn; /* The current, i.e. last LSN inside the log when the restart area was last written. This happens often but what is the interval? Is it just fixed time or is it every time a check point is written or something else? On create set to 0. */ /* 8*/ le16 log_clients; /* Number of log client records in the array of log client records which follows this restart area. Must be 1. */ /* 10*/ le16 client_free_list; /* The index of the first free log client record in the array of log client records. LOGFILE_NO_CLIENT means that there are no free log client records in the array. If != LOGFILE_NO_CLIENT, check that log_clients > client_free_list. On Win2k and presumably earlier, on a clean volume this is != LOGFILE_NO_CLIENT, and it should be 0, i.e. the first (and only) client record is free and thus the logfile is closed and hence clean. A dirty volume would have left the logfile open and hence this would be LOGFILE_NO_CLIENT. On WinXP and presumably later, the logfile is always open, even on clean shutdown so this should always be LOGFILE_NO_CLIENT. */ /* 12*/ le16 client_in_use_list;/* The index of the first in-use log client record in the array of log client records. LOGFILE_NO_CLIENT means that there are no in-use log client records in the array. If != LOGFILE_NO_CLIENT check that log_clients > client_in_use_list. On Win2k and presumably earlier, on a clean volume this is LOGFILE_NO_CLIENT, i.e. there are no client records in use and thus the logfile is closed and hence clean. A dirty volume would have left the logfile open and hence this would be != LOGFILE_NO_CLIENT, and it should be 0, i.e. the first (and only) client record is in use. On WinXP and presumably later, the logfile is always open, even on clean shutdown so this should always be 0. */ /* 14*/ RESTART_AREA_FLAGS flags;/* Flags modifying LFS behaviour. On Win2k and presumably earlier this is always 0. On WinXP and presumably later, if the logfile was shutdown cleanly, the second bit, RESTART_VOLUME_IS_CLEAN, is set. This bit is cleared when the volume is mounted by WinXP and set when the volume is dismounted, thus if the logfile is dirty, this bit is clear. Thus we don't need to check the Windows version to determine if the logfile is clean. Instead if the logfile is closed, we know it must be clean. If it is open and this bit is set, we also know it must be clean. If on the other hand the logfile is open and this bit is clear, we can be almost certain that the logfile is dirty. */ /* 16*/ le32 seq_number_bits; /* How many bits to use for the sequence number. This is calculated as 67 - the number of bits required to store the logfile size in bytes and this can be used in with the specified file_size as a consistency check. */ /* 20*/ le16 restart_area_length;/* Length of the restart area including the client array. Following checks required if version matches. Otherwise, skip them. restart_area_offset + restart_area_length has to be <= system_page_size. Also, restart_area_length has to be >= client_array_offset + (log_clients * sizeof(log client record)). */ /* 22*/ le16 client_array_offset;/* Offset from the start of this record to the first log client record if versions are matched. When creating, set this to be after this restart area structure, aligned to 8-bytes boundary. If the versions do not match, this is ignored and the offset is assumed to be (sizeof(RESTART_AREA) + 7) & ~7, i.e. rounded up to first 8-byte boundary. Either way, client_array_offset has to be aligned to an 8-byte boundary. Also, restart_area_offset + client_array_offset has to be <= 510. Finally, client_array_offset + (log_clients * sizeof(log client record)) has to be <= system_page_size. On Win2k and presumably earlier, this is 0x30, i.e. immediately following this record. On WinXP and presumably later, this is 0x40, i.e. there are 16 extra bytes between this record and the client array. This probably means that the RESTART_AREA record is actually bigger in WinXP and later. */ /* 24*/ sle64 file_size; /* Usable byte size of the log file. If the restart_area_offset + the offset of the file_size are > 510 then corruption has occurred. This is the very first check when starting with the restart_area as if it fails it means that some of the above values will be corrupted by the multi sector transfer protection. The file_size has to be rounded down to be a multiple of the log_page_size in the RESTART_PAGE_HEADER and then it has to be at least big enough to store the two restart pages and 48 (0x30) log record pages. */ /* 32*/ le32 last_lsn_data_length;/* Length of data of last LSN, not including the log record header. On create set to 0. */ /* 36*/ le16 log_record_header_length;/* Byte size of the log record header. If the version matches then check that the value of log_record_header_length is a multiple of 8, i.e. (log_record_header_length + 7) & ~7 == log_record_header_length. When creating set it to sizeof(LOG_RECORD_HEADER), aligned to 8 bytes. */ /* 38*/ le16 log_page_data_offset;/* Offset to the start of data in a log record page. Must be a multiple of 8. On create set it to immediately after the update sequence array of the log record page. */ /* 40*/ le32 restart_log_open_count;/* A counter that gets incremented every time the logfile is restarted which happens at mount time when the logfile is opened. When creating set to a random value. Win2k sets it to the low 32 bits of the current system time in NTFS format (see time.h). */ /* 44*/ le32 reserved; /* Reserved/alignment to 8-byte boundary. */ /* sizeof() = 48 (0x30) bytes */ } __attribute__((__packed__)) RESTART_AREA; /** * struct LOG_CLIENT_RECORD - Log client record. * * The offset of this record is found by adding the offset of the * RESTART_AREA to the client_array_offset value found in it. */ typedef struct { /*Ofs*/ /* 0*/ leLSN oldest_lsn; /* Oldest LSN needed by this client. On create set to 0. */ /* 8*/ leLSN client_restart_lsn;/* LSN at which this client needs to restart the volume, i.e. the current position within the log file. At present, if clean this should = current_lsn in restart area but it probably also = current_lsn when dirty most of the time. At create set to 0. */ /* 16*/ le16 prev_client; /* The offset to the previous log client record in the array of log client records. LOGFILE_NO_CLIENT means there is no previous client record, i.e. this is the first one. This is always LOGFILE_NO_CLIENT. */ /* 18*/ le16 next_client; /* The offset to the next log client record in the array of log client records. LOGFILE_NO_CLIENT means there are no next client records, i.e. this is the last one. This is always LOGFILE_NO_CLIENT. */ /* 20*/ le16 seq_number; /* On Win2k and presumably earlier, this is set to zero every time the logfile is restarted and it is incremented when the logfile is closed at dismount time. Thus it is 0 when dirty and 1 when clean. On WinXP and presumably later, this is always 0. */ /* 22*/ u8 reserved[6]; /* Reserved/alignment. */ /* 28*/ le32 client_name_length;/* Length of client name in bytes. Should always be 8. */ /* 32*/ ntfschar client_name[64];/* Name of the client in Unicode. Should always be "NTFS" with the remaining bytes set to 0. */ /* sizeof() = 160 (0xa0) bytes */ } __attribute__((__packed__)) LOG_CLIENT_RECORD; /** * struct RECORD_PAGE_HEADER - Log page record page header. * * Each log page begins with this header and is followed by several LOG_RECORD * structures, starting at offset 0x40 (the size of this structure and the * following update sequence array and then aligned to 8 byte boundary, but is * this specified anywhere?). */ typedef struct { /* 0 NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */ NTFS_RECORD_TYPES magic;/* Usually the magic is "RCRD". */ le16 usa_ofs; /* See NTFS_RECORD definition in layout.h. When creating, set this to be immediately after this header structure (without any alignment). */ le16 usa_count; /* See NTFS_RECORD definition in layout.h. */ union { leLSN last_lsn; sle64 file_offset; } __attribute__((__packed__)) copy; le32 flags; le16 page_count; le16 page_position; le16 next_record_offset; le16 reserved[3]; leLSN last_end_lsn; } __attribute__((__packed__)) RECORD_PAGE_HEADER; /** * enum LOG_RECORD_FLAGS - Possible 16-bit flags for log records. * * Some flags describe what kind of update is being logged. * * (Or is it log record pages?) */ typedef enum { LOG_RECORD_MULTI_PAGE = const_cpu_to_le16(0x0001), /* ??? */ /* The flags below were introduced in Windows 10 */ LOG_RECORD_DELETING = const_cpu_to_le16(0x0002), LOG_RECORD_ADDING = const_cpu_to_le16(0x0004), LOG_RECORD_SIZE_PLACE_HOLDER = 0xffff, /* This has nothing to do with the log record. It is only so gcc knows to make the flags 16-bit. */ } __attribute__((__packed__)) LOG_RECORD_FLAGS; /** * struct LOG_CLIENT_ID - The log client id structure identifying a log client. */ typedef struct { le16 seq_number; le16 client_index; } __attribute__((__packed__)) LOG_CLIENT_ID; /* * LOG_RECORD_TYPE : types of log records */ enum { LOG_STANDARD = const_cpu_to_le32(1), LOG_CHECKPOINT = const_cpu_to_le32(2), LOG_RECORD_TYPE_PLACE_HOLDER = 0xffffffffU } ; typedef le32 LOG_RECORD_TYPE; /* * ATTRIBUTE_FLAGS : flags describing the kind of NTFS record * is being updated. * These flags were introduced in Vista, only two flags are known? */ enum { ACTS_ON_MFT = const_cpu_to_le16(2), ACTS_ON_INDX = const_cpu_to_le16(8), ATTRIBUTE_FLAGS_PLACE_HOLDER = 0xffff, } ; typedef le16 ATTRIBUTE_FLAGS; #define LOG_RECORD_HEAD_SZ 0x30 /* size of header of struct LOG_RECORD */ /** * struct LOG_RECORD - Log record header. * * Each log record seems to have a constant size of 0x70 bytes. */ typedef struct { leLSN this_lsn; leLSN client_previous_lsn; leLSN client_undo_next_lsn; le32 client_data_length; LOG_CLIENT_ID client_id; LOG_RECORD_TYPE record_type; le32 transaction_id; LOG_RECORD_FLAGS log_record_flags; le16 reserved_or_alignment[3]; /* Now are at ofs 0x30 into struct. */ le16 redo_operation; le16 undo_operation; le16 redo_offset; le16 redo_length; union { struct { le16 undo_offset; le16 undo_length; le16 target_attribute; le16 lcns_to_follow; /* Number of lcn_list entries following this entry. */ /* Now at ofs 0x40. */ le16 record_offset; le16 attribute_offset; le16 cluster_index; ATTRIBUTE_FLAGS attribute_flags; leVCN target_vcn; /* Now at ofs 0x50. */ leLCN lcn_list[0]; /* Only present if lcns_to_follow is not 0. */ } __attribute__((__packed__)); struct { leLSN transaction_lsn; leLSN attributes_lsn; leLSN names_lsn; leLSN dirty_pages_lsn; le64 unknown_list[0]; } __attribute__((__packed__)); } __attribute__((__packed__)); } __attribute__((__packed__)) LOG_RECORD; /** * struct BITMAP_ACTION - Bitmap change being logged */ struct BITMAP_ACTION { le32 firstbit; le32 count; } ; /** * struct ATTR - Attribute record. * * The format of an attribute record has changed from Windows 10. * The old format was 44 bytes long, despite having 8 bytes fields, * and this leads to alignment problems in arrays. * This problem does not occur in the new format, which is shorter. * The format being used can generally be determined from size. */ typedef struct { /* Format up to Win10 (44 bytes) */ le64 unknown1; le64 unknown2; le64 inode; leLSN lsn; le32 unknown3; le32 type; le32 unknown4; } __attribute__((__packed__)) ATTR_OLD; typedef struct { /* Format since Win10 (40 bytes) */ le64 unknown1; le64 unknown2; le32 type; le32 unknown3; le64 inode; leLSN lsn; } __attribute__((__packed__)) ATTR_NEW; extern BOOL ntfs_check_logfile(ntfs_attr *log_na, RESTART_PAGE_HEADER **rp); extern BOOL ntfs_is_logfile_clean(ntfs_attr *log_na, RESTART_PAGE_HEADER *rp); extern int ntfs_empty_logfile(ntfs_attr *na); #endif /* defined _NTFS_LOGFILE_H */ ntfsprogs-plus-1.0.0/include/logging.h000066400000000000000000000137771507404161300177600ustar00rootroot00000000000000/* * logging.h - Centralised logging. Originated from the Linux-NTFS project. * * Copyright (c) 2005 Richard Russon * Copyright (c) 2007-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _LOGGING_H_ #define _LOGGING_H_ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDARG_H #include #endif #include "types.h" /* Function prototype for the logging handlers */ typedef int (ntfs_log_handler)(const char *function, const char *file, int line, u32 level, void *data, const char *format, va_list args); /* Set the logging handler from one of the functions, below. */ void ntfs_log_set_handler(ntfs_log_handler *handler __attribute__((format(printf, 6, 0)))); /* Logging handlers */ ntfs_log_handler ntfs_log_handler_syslog __attribute__((format(printf, 6, 0))); ntfs_log_handler ntfs_log_handler_fprintf __attribute__((format(printf, 6, 0))); ntfs_log_handler ntfs_log_handler_null __attribute__((format(printf, 6, 0))); ntfs_log_handler ntfs_log_handler_stdout __attribute__((format(printf, 6, 0))); ntfs_log_handler ntfs_log_handler_outerr __attribute__((format(printf, 6, 0))); ntfs_log_handler ntfs_log_handler_stderr __attribute__((format(printf, 6, 0))); /* Enable/disable certain log levels */ u32 ntfs_log_set_levels(u32 levels); u32 ntfs_log_clear_levels(u32 levels); u32 ntfs_log_get_levels(void); /* Enable/disable certain log flags */ u32 ntfs_log_set_flags(u32 flags); u32 ntfs_log_clear_flags(u32 flags); u32 ntfs_log_get_flags(void); /* Turn command-line options into logging flags */ BOOL ntfs_log_parse_option(const char *option); int ntfs_log_redirect(const char *function, const char *file, int line, u32 level, void *data, const char *format, ...) __attribute__((format(printf, 6, 7))); /* Logging levels - Determine what gets logged */ #define NTFS_LOG_LEVEL_DEBUG (1 << 0) /* x = 42 */ #define NTFS_LOG_LEVEL_TRACE (1 << 1) /* Entering function x() */ #define NTFS_LOG_LEVEL_QUIET (1 << 2) /* Quietable output */ #define NTFS_LOG_LEVEL_INFO (1 << 3) /* Volume needs defragmenting */ #define NTFS_LOG_LEVEL_VERBOSE (1 << 4) /* Forced to continue */ #define NTFS_LOG_LEVEL_PROGRESS (1 << 5) /* 54% complete */ #define NTFS_LOG_LEVEL_WARNING (1 << 6) /* You should backup before starting */ #define NTFS_LOG_LEVEL_ERROR (1 << 7) /* Operation failed, no damage done */ #define NTFS_LOG_LEVEL_PERROR (1 << 8) /* Message : standard error description */ #define NTFS_LOG_LEVEL_CRITICAL (1 << 9) /* Operation failed,damage may have occurred */ #define NTFS_LOG_LEVEL_ENTER (1 << 10) /* Enter a function */ #define NTFS_LOG_LEVEL_LEAVE (1 << 11) /* Leave a function */ /* Logging style flags - Manage the style of the output */ #define NTFS_LOG_FLAG_PREFIX (1 << 0) /* Prefix messages with "ERROR: ", etc */ #define NTFS_LOG_FLAG_FILENAME (1 << 1) /* Show the file origin of the message */ #define NTFS_LOG_FLAG_LINE (1 << 2) /* Show the line number of the message */ #define NTFS_LOG_FLAG_FUNCTION (1 << 3) /* Show the function name containing the message */ #define NTFS_LOG_FLAG_ONLYNAME (1 << 4) /* Only display the filename, not the pathname */ /* Macros to simplify logging. One for each level defined above. * Note, ntfs_log_debug/trace have effect only if DEBUG is defined. */ #define ntfs_log_critical(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_CRITICAL,NULL,FORMAT,##ARGS) #define ntfs_log_error(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_ERROR,NULL,FORMAT,##ARGS) #define ntfs_log_info(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_INFO,NULL,FORMAT,##ARGS) #define ntfs_log_perror(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_PERROR,NULL,FORMAT,##ARGS) #define ntfs_log_progress(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_PROGRESS,NULL,FORMAT,##ARGS) #define ntfs_log_quiet(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_QUIET,NULL,FORMAT,##ARGS) #define ntfs_log_verbose(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_VERBOSE,NULL,FORMAT,##ARGS) #define ntfs_log_warning(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_WARNING,NULL,FORMAT,##ARGS) /* By default debug and trace messages are compiled into the program, * but not displayed. */ #ifdef DEBUG #define ntfs_log_debug(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_DEBUG,NULL,FORMAT,##ARGS) #define ntfs_log_trace(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_TRACE,NULL,FORMAT,##ARGS) #define ntfs_log_enter(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_ENTER,NULL,FORMAT,##ARGS) #define ntfs_log_leave(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_LEAVE,NULL,FORMAT,##ARGS) #else #define ntfs_log_debug(FORMAT, ARGS...)do {} while (0) #define ntfs_log_trace(FORMAT, ARGS...)do {} while (0) #define ntfs_log_enter(FORMAT, ARGS...)do {} while (0) #define ntfs_log_leave(FORMAT, ARGS...)do {} while (0) #endif /* DEBUG */ void ntfs_log_early_error(const char *format, ...) __attribute__((format(printf, 1, 2))); #endif /* _LOGGING_H_ */ ntfsprogs-plus-1.0.0/include/mft.h000066400000000000000000000113611507404161300171030ustar00rootroot00000000000000/* * mft.h - Exports for MFT record handling. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2002 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2006-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_MFT_H #define _NTFS_MFT_H #include "volume.h" #include "inode.h" #include "layout.h" #include "logging.h" extern int ntfs_mft_records_read(const ntfs_volume *vol, const MFT_REF mref, const s64 count, MFT_RECORD *b); /** * ntfs_mft_record_read - read a record from the mft * @vol: volume to read from * @mref: mft record number to read * @b: output data buffer * * Read the mft record specified by @mref from volume @vol into buffer @b. * Return 0 on success or -1 on error, with errno set to the error code. * * The read mft record is mst deprotected and is hence ready to use. The caller * should check the record with is_baad_record() in case mst deprotection * failed. * * NOTE: @b has to be at least of size vol->mft_record_size. */ static __inline__ int ntfs_mft_record_read(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *b) { int ret; ntfs_log_enter("Entering for inode %lld\n", (long long)MREF(mref)); ret = ntfs_mft_records_read(vol, mref, 1, b); ntfs_log_leave("\n"); return ret; } extern int ntfs_mft_record_check(ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *m); extern int ntfs_file_record_read(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD **mrec, ATTR_RECORD **attr); extern int ntfs_mft_records_write(const ntfs_volume *vol, const MFT_REF mref, const s64 count, MFT_RECORD *b); /** * ntfs_mft_record_write - write an mft record to disk * @vol: volume to write to * @mref: mft record number to write * @b: data buffer containing the mft record to write * * Write the mft record specified by @mref from buffer @b to volume @vol. * Return 0 on success or -1 on error, with errno set to the error code. * * Before the mft record is written, it is mst protected. After the write, it * is deprotected again, thus resulting in an increase in the update sequence * number inside the buffer @b. * * NOTE: @b has to be at least of size vol->mft_record_size. */ static __inline__ int ntfs_mft_record_write(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *b) { int ret; ntfs_log_enter("Entering for inode %lld\n", (long long)MREF(mref)); ret = ntfs_mft_records_write(vol, mref, 1, b); ntfs_log_leave("\n"); return ret; } /** * ntfs_mft_record_get_data_size - return number of bytes used in mft record @b * @m: mft record to get the data size of * * Takes the mft record @m and returns the number of bytes used in the record * or 0 on error (i.e. @m is not a valid mft record). Zero is not a valid size * for an mft record as it at least has to have the MFT_RECORD itself and a * zero length attribute of type AT_END, thus making the minimum size 56 bytes. * * Aside: The size is independent of NTFS versions 1.x/3.x because the 8-byte * alignment of the first attribute mask the difference in MFT_RECORD size * between NTFS 1.x and 3.x. Also, you would expect every mft record to * contain an update sequence array as well but that could in theory be * non-existent (don't know if Windows' NTFS driver/chkdsk wouldn't view this * as corruption in itself though). */ static __inline__ u32 ntfs_mft_record_get_data_size(const MFT_RECORD *m) { if (!m || !ntfs_is_mft_record(m->magic)) return 0; /* Get the number of used bytes and return it. */ return le32_to_cpu(m->bytes_in_use); } extern int ntfs_mft_record_layout(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *mrec); extern int ntfs_mft_record_format(const ntfs_volume *vol, const MFT_REF mref); extern ntfs_inode *ntfs_mft_record_alloc(ntfs_volume *vol, ntfs_inode *base_ni); extern ntfs_inode *ntfs_mft_rec_alloc(ntfs_volume *vol, BOOL mft_data); extern int ntfs_mft_record_free(ntfs_volume *vol, ntfs_inode *ni); extern int ntfs_mft_usn_dec(MFT_RECORD *mrec); #endif /* defined _NTFS_MFT_H */ ntfsprogs-plus-1.0.0/include/misc.h000066400000000000000000000021561507404161300172520ustar00rootroot00000000000000/* * misc.h : miscellaneous exports * - memory allocation * * Copyright (c) 2008 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_MISC_H_ #define _NTFS_MISC_H_ void *ntfs_calloc(size_t size); void *ntfs_malloc(size_t size); void *ntfs_realloc(void *ptr, size_t size); void ntfs_free(void *ptr); #endif /* _NTFS_MISC_H_ */ ntfsprogs-plus-1.0.0/include/mst.h000066400000000000000000000025751507404161300171270ustar00rootroot00000000000000/* * mst.h - Exports for multi sector transfer fixup functions. * Originated from the Linux-NTFS project. * * Copyright (c) 2000-2002 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_MST_H #define _NTFS_MST_H #include "types.h" #include "layout.h" #include "volume.h" extern int ntfs_mst_post_read_fixup(NTFS_RECORD *b, const u32 size); extern int ntfs_mst_post_read_fixup_warn(NTFS_RECORD *b, const u32 size, BOOL warn); extern int ntfs_mst_pre_write_fixup(NTFS_RECORD *b, const u32 size); extern void ntfs_mst_post_write_fixup(NTFS_RECORD *b); #endif /* defined _NTFS_MST_H */ ntfsprogs-plus-1.0.0/include/ntfstime.h000066400000000000000000000074641507404161300201570ustar00rootroot00000000000000/* * ntfstime.h - NTFS time related functions. Originated from the Linux-NTFS project. * * Copyright (c) 2005 Anton Altaparmakov * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_NTFSTIME_H #define _NTFS_NTFSTIME_H #ifdef HAVE_TIME_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_GETTIMEOFDAY #include #endif #include "types.h" /* * assume "struct timespec" is not defined if st_mtime is not defined */ #if !defined(st_mtime) & !defined(__timespec_defined) struct timespec { time_t tv_sec; long tv_nsec; } ; #endif /* * There are four times more conversions of internal representation * to ntfs representation than any other conversion, so the most * efficient internal representation is ntfs representation * (with low endianness) */ typedef sle64 ntfs_time; #define NTFS_TIME_OFFSET ((s64)(369 * 365 + 89) * 24 * 3600 * 10000000) /** * ntfs2timespec - Convert an NTFS time to Unix time * @ntfs_time: An NTFS time in 100ns units since 1601 * * NTFS stores times as the number of 100ns intervals since January 1st 1601 at * 00:00 UTC. This system will not suffer from Y2K problems until ~57000AD. * * Return: A Unix time (number of seconds since 1970, and nanoseconds) */ static __inline__ struct timespec ntfs2timespec(ntfs_time ntfstime) { struct timespec spec; s64 cputime; cputime = sle64_to_cpu(ntfstime); spec.tv_sec = (cputime - (NTFS_TIME_OFFSET)) / 10000000; spec.tv_nsec = (cputime - (NTFS_TIME_OFFSET) - (s64)spec.tv_sec*10000000)*100; /* force zero nsec for overflowing dates */ if ((spec.tv_nsec < 0) || (spec.tv_nsec > 999999999)) spec.tv_nsec = 0; return (spec); } /** * timespec2ntfs - Convert Linux time to NTFS time * @utc_time: Linux time to convert to NTFS * * Convert the Linux time @utc_time to its corresponding NTFS time. * * Linux stores time in a long at present and measures it as the number of * 1-second intervals since 1st January 1970, 00:00:00 UTC * with a separated non-negative nanosecond value * * NTFS uses Microsoft's standard time format which is stored in a sle64 and is * measured as the number of 100 nano-second intervals since 1st January 1601, * 00:00:00 UTC. * * Return: An NTFS time (100ns units since Jan 1601) */ static __inline__ ntfs_time timespec2ntfs(struct timespec spec) { s64 units; units = (s64)spec.tv_sec * 10000000 + NTFS_TIME_OFFSET + spec.tv_nsec/100; return (cpu_to_sle64(units)); } /* * Return the current time in ntfs format */ static __inline__ ntfs_time ntfs_current_time(void) { struct timespec now; #if defined(HAVE_CLOCK_GETTIME) || defined(HAVE_SYS_CLOCK_GETTIME) clock_gettime(CLOCK_REALTIME, &now); #elif defined(HAVE_GETTIMEOFDAY) struct timeval microseconds; gettimeofday(µseconds, (struct timezone*)NULL); now.tv_sec = microseconds.tv_sec; now.tv_nsec = microseconds.tv_usec*1000; #else now.tv_sec = time((time_t*)NULL); now.tv_nsec = 0; #endif return (timespec2ntfs(now)); } #endif /* _NTFS_NTFSTIME_H */ ntfsprogs-plus-1.0.0/include/object_id.h000066400000000000000000000022321507404161300202340ustar00rootroot00000000000000/* * * Copyright (c) 2008 Jean-Pierre Andre * */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef OBJECT_ID_H #define OBJECT_ID_H int ntfs_get_ntfs_object_id(ntfs_inode *ni, char *value, size_t size); int ntfs_set_ntfs_object_id(ntfs_inode *ni, const char *value, size_t size, int flags); int ntfs_remove_ntfs_object_id(ntfs_inode *ni); int ntfs_delete_object_id_index(ntfs_inode *ni); #endif /* OBJECT_ID_H */ ntfsprogs-plus-1.0.0/include/param.h000066400000000000000000000124321507404161300174150ustar00rootroot00000000000000/* * param.h - Parameter values for ntfs-3g * * Copyright (c) 2009-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_PARAM_H #define _NTFS_PARAM_H #define CACHE_INODE_SIZE 32 /* inode cache, zero or >= 3 and not too big */ #define CACHE_NIDATA_SIZE 64 /* idata cache, zero or >= 3 and not too big */ #define CACHE_LOOKUP_SIZE 64 /* lookup cache, zero or >= 3 and not too big */ #define CACHE_SECURID_SIZE 16 /* securid cache, zero or >= 3 and not too big */ #define CACHE_LEGACY_SIZE 8 /* legacy cache size, zero or >= 3 and not too big */ #define FORCE_FORMAT_v1x 0 /* Insert security data as in NTFS v1.x */ #define OWNERFROMACL 1 /* Get the owner from ACL (not Windows owner) */ /* default security sub-authorities */ enum { DEFSECAUTH1 = -1153374643, /* 3141592653 */ DEFSECAUTH2 = 589793238, DEFSECAUTH3 = 462843383, DEFSECBASE = 10000 }; /* * Parameters for formatting */ /* Up to Windows 10, the cluster size was limited to 64K */ #define NTFS_MAX_CLUSTER_SIZE 2097152 /* Windows 10 Creators allows 2MB */ /* * Parameters for compression */ /* default option for compression */ #define DEFAULT_COMPRESSION 1 /* (log2 of) number of clusters in a compression block for new files */ #define STANDARD_COMPRESSION_UNIT 4 /* maximum cluster size for allowing compression for new files */ #define MAX_COMPRESSION_CLUSTER_SIZE 4096 /* * Parameters for default options */ #define DEFAULT_DMTIME 60 /* default 1mn for delay_mtime */ /* * Use of big write buffers * * With small volumes, the cluster allocator may fail to allocate * enough clusters when the volume is nearly full. At most a run * can be allocated per bitmap chunk. So, there is a danger when the * number of chunks (capacity/(32768*clsiz)) is less than the number * of clusters in the biggest write buffer (131072/clsiz). Hence * a safe minimal capacity is 4GB */ #define SAFE_CAPACITY_FOR_BIG_WRITES 0x100000000LL /* * Parameters for runlists */ /* only update the final extent of a runlist when appending data */ #define PARTIAL_RUNLIST_UPDATING 1 /* * Parameters for upper-case table */ /* Create upper-case tables as defined by Windows 6.1 (Win7) */ #define UPCASE_MAJOR 6 #define UPCASE_MINOR 1 /* * Parameters for user and xattr mappings */ #define XATTRMAPPINGFILE ".NTFS-3G/XattrMapping" /* default mapping file */ /* * Parameters for path canonicalization */ #define MAPPERNAMELTH 256 /* * Permission checking modes for high level and low level * * The choices for high and low lowel are independent, they have * no effect on the library * * Stick to the recommended values unless you understand the consequences * on protection and performances. Use of cacheing is good for * performances, but bad on security with internal fuse or external * fuse older than 2.8 * * On Linux, cacheing is discouraged for the high level interface * in order to get proper support of hard links. As a consequence, * having access control in the file system leads to fewer requests * to the file system and fewer context switches. * * Irrespective of the selected mode, cacheing is always used * in read-only mounts * * Possible values for high level : * 1 : no cache, kernel control (recommended) * 4 : no cache, file system control * 6 : kernel/fuse cache, file system control (OpenIndiana only) * 7 : no cache, kernel control for ACLs * * Possible values for low level : * 2 : no cache, kernel control * 3 : use kernel/fuse cache, kernel control (recommended) * 5 : no cache, file system control * 6 : kernel/fuse cache, file system control (OpenIndiana only) * 8 : no cache, kernel control for ACLs * 9 : kernel/fuse cache, kernel control for ACLs (target) * * Use of options 7, 8 and 9 requires a fuse module upgrade * When Posix ACLs are selected in the configure options, a value * of 6 is added in the mount report. */ #define TIMEOUT_RO 600 /* Attribute time out for read-only mounts */ #if defined(__sun) && defined(__SVR4) /* * Access control by kernel is not implemented on OpenIndiana, * however care is taken of cacheing hard-linked files. */ #define HPERMSCONFIG 6 #define LPERMSCONFIG 6 #else /* defined(__sun) && defined(__SVR4) */ /* * Cacheing by kernel is buggy on Linux when access control is done * by the file system, and also when using hard-linked files on * the fuse high level interface. * Also ACL checks by recent kernels do not prove satisfactory. */ #define HPERMSCONFIG 1 #define LPERMSCONFIG 3 #endif /* defined(__sun) && defined(__SVR4) */ #endif /* defined _NTFS_PARAM_H */ ntfsprogs-plus-1.0.0/include/plugin.h000066400000000000000000000150501507404161300176120ustar00rootroot00000000000000/* * plugin.h : define interface for plugin development * * Copyright (c) 2015-2021 Jean-Pierre Andre * */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* * This file defines the interface to ntfs-3g plugins which * add support for processing some type of reparse points. */ #ifndef _NTFS_PLUGIN_H #define _NTFS_PLUGIN_H #include "layout.h" #include "inode.h" #include "dir.h" struct fuse_file_info; struct stat; /* * The plugin operations currently defined. * These functions should return a non-negative value when they * succeed, or a negative errno value when they fail. * They must not close or free their arguments. * The file system must be left in a consistent state after * each individual call. * If an operation is not defined, an EOPNOTSUPP error is * returned to caller. */ typedef struct plugin_operations { /* * Set the attributes st_size, st_blocks and st_mode * into a struct stat. The returned st_mode must at least * define the file type. Depending on the permissions options * used for mounting, the umask will be applied to the returned * permissions, or the permissions will be changed according * to the ACL set on the file. */ int (*getattr)(ntfs_inode *ni, const REPARSE_POINT *reparse, struct stat *stbuf); /* * Open a file for reading or writing * The field fi->flags indicates the kind of opening. * The field fi->fh may be used to store some information which * will be available to subsequent reads and writes. When used * this field must be non-null. * The returned value is zero for success and a negative errno * value for failure. */ int (*open)(ntfs_inode *ni, const REPARSE_POINT *reparse, struct fuse_file_info *fi); /* * Release an open file or directory * This is only called if fi->fh has been set to a non-null * value while opening. It may be used to free some context * specific to the open file or directory * The returned value is zero for success or a negative errno * value for failure. */ int (*release)(ntfs_inode *ni, const REPARSE_POINT *reparse, struct fuse_file_info *fi); /* * Read from an open file * The returned value is the count of bytes which were read * or a negative errno value for failure. * If the returned value is positive, the access time stamp * will be updated after the call. */ int (*read)(ntfs_inode *ni, const REPARSE_POINT *reparse, char *buf, size_t size, off_t offset, struct fuse_file_info *fi); /* * Write to an open file * The file system must be left consistent after each write call, * the file itself must be at least deletable if the application * writing to it is killed for some reason. * The returned value is the count of bytes which were written * or a negative errno value for failure. * If the returned value is positive, the modified time stamp * will be updated after the call. */ int (*write)(ntfs_inode *ni, const REPARSE_POINT *reparse, const char *buf, size_t size, off_t offset, struct fuse_file_info *fi); /* * Get a symbolic link * The symbolic link must be returned in an allocated buffer, * encoded in a zero terminated multibyte string compatible * with the locale mount option. * The returned value is zero for success or a negative errno * value for failure. */ int (*readlink)(ntfs_inode *ni, const REPARSE_POINT *reparse, char **pbuf); /* * Truncate a file (shorten or append zeroes) * The returned value is zero for success or a negative errno * value for failure. * If the returned value is zero, the modified time stamp * will be updated after the call. */ int (*truncate)(ntfs_inode *ni, const REPARSE_POINT *reparse, off_t size); /* * Open a directory * The field fi->flags indicates the kind of opening. * The field fi->fh may be used to store some information which * will be available to subsequent readdir(). When used * this field must be non-null and freed in release(). * The returned value is zero for success and a negative errno * value for failure. */ int (*opendir)(ntfs_inode *ni, const REPARSE_POINT *reparse, struct fuse_file_info *fi); /* * Get entries from a directory * * Use the filldir() function with fillctx argument to return * the directory entries. * Names "." and ".." are expected to be returned. * The returned value is zero for success and a negative errno * value for failure. */ int (*readdir)(ntfs_inode *ni, const REPARSE_POINT *reparse, s64 *pos, void *fillctx, ntfs_filldir_t filldir, struct fuse_file_info *fi); /* * Create a new file of any type * * The returned value is a pointer to the inode created, or * NULL if failed, with errno telling why. */ ntfs_inode *(*create)(ntfs_inode *dir_ni, const REPARSE_POINT *reparse, le32 securid, ntfschar *name, int name_len, mode_t type); /* * Link a new name to a file or directory * Linking a directory is needed for renaming a directory * The returned value is zero for success or a negative errno * value for failure. * If the returned value is zero, the modified time stamp * will be updated after the call. */ int (*link)(ntfs_inode *dir_ni, const REPARSE_POINT *reparse, ntfs_inode *ni, ntfschar *name, int name_len); /* * Unlink a name from a directory * The argument pathname may be NULL * The returned value is zero for success or a negative errno * value for failure. */ int (*unlink)(ntfs_inode *dir_ni, const REPARSE_POINT *reparse, const char *pathname, ntfs_inode *ni, ntfschar *name, int name_len); } plugin_operations_t; /* * Plugin initialization routine * Returns the entry table if successful, otherwise returns NULL * and sets errno (e.g. to EINVAL if the tag is not supported by * the plugin.) */ typedef const struct plugin_operations *(*plugin_init_t)(le32 tag); const struct plugin_operations *init(le32 tag); #endif /* _NTFS_PLUGIN_H */ ntfsprogs-plus-1.0.0/include/problem.h000066400000000000000000000047031507404161300177570ustar00rootroot00000000000000/* SPDX-License-Identifier : GPL-2.0 */ #ifndef PROBLEM_H #define PROBLEM_H #include "volume.h" typedef enum { PR_PREEN_NOMSG = 1 << 0, /* Don't print a message if preening */ PR_NO_NOMSG = 1 << 1, PR_FLAG_MAX = 1 << 6, } problem_flag_t; typedef enum { PR_PRE_SCAN_MFT = 0x000001, PR_RESET_LOG_FILE, PR_MFT_FLAG_MISMATCH, PR_DIR_NONZERO_SIZE, PR_MFT_REPARSE_TAG_MISMATCH, PR_MFT_ALLOCATED_SIZE_MISMATCH, PR_MFT_DATA_SIZE_MISMATCH, PR_DIR_FLAG_MISMATCH_IDX_FN, PR_DIR_FLAG_MISMATCH_MFT_FN, PR_DIR_IR_NOT_EXIST, PR_MFT_FLAG_MISMATCH_IDX_FN, PR_FILE_HAVE_IR, PR_ATTR_LOWEST_VCN_IS_NOT_ZERO, PR_ATTR_NON_RESIDENT_SIZES_MISMATCH, PR_ATTR_VALUE_OFFSET_BADLY_ALIGNED, PR_ATTR_VALUE_OFFSET_CORRUPTED, PR_ATTR_NAME_OFFSET_CORRUPTED, PR_ATTR_LENGTH_CORRUPTED, PR_ATTR_FN_FLAG_MISMATCH, PR_ATTR_IR_SIZE_MISMATCH, PR_IA_MAGIC_CORRUPTED, PR_MFT_MAGIC_CORRUPTED, PR_MFT_SIZE_CORRUPTED, PR_MFT_ATTR_OFFSET_CORRUPTED, PR_MFT_BIU_CORRUPTED, PR_IE_ZERO_LENGTH, PR_BOOT_SECTOR_INVALID, PR_MOUNT_LOAD_MFT_FAILURE, PR_MOUNT_LOAD_MFTMIRR_FAILURE, PR_MOUNT_REPAIRED_MFTMIRR_CORRUPTED, PR_IE_FLAG_SUB_NODE_CORRUPTED, PR_MOUNT_MFT_MFTMIRR_MISMATCH, PR_IE_END_FLAG_CORRUPTED, PR_LOG_APPLY_RUNLIST_TO_DISK, PR_DIR_HAVE_RESIDENT_IA, PR_ATTRLIST_LENGTH_CORRUPTED, PR_IDX_ENTRY_CORRUPTED, PR_IDX_BITMAP_SIZE_MISMATCH, PR_IDX_BITMAP_MISMATCH, PR_CLUSTER_BITMAP_MISMATCH, PR_ORPHANED_MFT_REPAIR, PR_DIR_IDX_INITIALIZE, PR_BITMAP_MFT_SIZE_MISMATCH, PR_DIR_EMPTY_IE_LENGTH_CORRUPTED, PR_CLUSTER_DUPLICATION_FOUND, /* pass 4 */ PR_ORPHANED_MFT_OPEN_FAILURE, PR_ORPHANED_MFT_CHECK_FAILURE, } problem_code_t; typedef struct problem_context { problem_code_t err_code; ntfs_inode *ni; ntfs_attr *na; ntfs_attr_search_ctx *ctx; ntfs_index_context *ictx; MFT_RECORD *m; ATTR_RECORD *a; FILE_NAME_ATTR *fn; union { u64 inum; u64 asize; u64 dsize; u64 vcn; u32 attr_type; }; char *filename; } problem_context_t; typedef struct ntfs_problem { problem_code_t code; const char *desc; problem_flag_t flags; int log_level; } ntfs_problem_t; void ntfs_init_problem_ctx(problem_context_t *pctx, ntfs_inode *ni, ntfs_attr *na, ntfs_attr_search_ctx *ctx, ntfs_index_context *ictx, MFT_RECORD *m, ATTR_RECORD *a, FILE_NAME_ATTR *fn); void ntfs_print_problem(ntfs_volume *vol, problem_code_t code, problem_context_t *pctx); BOOL ntfs_fix_problem(ntfs_volume *vol, problem_code_t code, problem_context_t *pctx); BOOL ntfs_ask_repair(const ntfs_volume *vol); #endif ntfsprogs-plus-1.0.0/include/realpath.h000066400000000000000000000007131507404161300201140ustar00rootroot00000000000000/* * realpath.h - realpath() aware of device mapper */ #ifndef REALPATH_H #define REALPATH_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_REALPATH #define ntfs_realpath realpath #else extern char *ntfs_realpath(const char *path, char *resolved_path); #endif #ifdef linux extern char *ntfs_realpath_canonicalize(const char *path, char *resolved_path); #else #define ntfs_realpath_canonicalize ntfs_realpath #endif #endif /* REALPATH_H */ ntfsprogs-plus-1.0.0/include/reparse.h000066400000000000000000000032371507404161300177610ustar00rootroot00000000000000/* * * Copyright (c) 2008 Jean-Pierre Andre * */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef REPARSE_H #define REPARSE_H char *ntfs_make_symlink(ntfs_inode *ni, const char *mnt_point); BOOL ntfs_possible_symlink(ntfs_inode *ni); int ntfs_get_ntfs_reparse_data(ntfs_inode *ni, char *value, size_t size); char *ntfs_get_abslink(ntfs_volume *vol, ntfschar *junction, int count, const char *mnt_point, BOOL isdir); REPARSE_POINT *ntfs_get_reparse_point(ntfs_inode *ni); int ntfs_reparse_check_wsl(ntfs_inode *ni, const REPARSE_POINT *reparse); int ntfs_reparse_set_wsl_symlink(ntfs_inode *ni, const ntfschar *target, int target_len); int ntfs_reparse_set_wsl_not_symlink(ntfs_inode *ni, mode_t mode); int ntfs_set_ntfs_reparse_data(ntfs_inode *ni, const char *value, size_t size, int flags); int ntfs_remove_ntfs_reparse_data(ntfs_inode *ni); int ntfs_delete_reparse_index(ntfs_inode *ni); #endif /* REPARSE_H */ ntfsprogs-plus-1.0.0/include/runlist.h000066400000000000000000000073641507404161300200250ustar00rootroot00000000000000/* * runlist.h - Exports for runlist handling. Originated from the Linux-NTFS project. * * Copyright (c) 2002 Anton Altaparmakov * Copyright (c) 2002 Richard Russon * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_RUNLIST_H #define _NTFS_RUNLIST_H #include "types.h" /* Forward declarations */ typedef struct _runlist_element runlist_element; typedef runlist_element runlist; #include "attrib.h" #include "volume.h" /** * struct _runlist_element - in memory vcn to lcn mapping array element. * @vcn: starting vcn of the current array element * @lcn: starting lcn of the current array element * @length: length in clusters of the current array element * * The last vcn (in fact the last vcn + 1) is reached when length == 0. * * When lcn == -1 this means that the count vcns starting at vcn are not * physically allocated (i.e. this is a hole / data is sparse). */ struct _runlist_element {/* In memory vcn to lcn mapping structure element. */ VCN vcn; /* vcn = Starting virtual cluster number. */ LCN lcn; /* lcn = Starting logical cluster number. */ s64 length; /* Run length in clusters. */ }; extern runlist_element *ntfs_rl_extend(ntfs_attr *na, runlist_element *rl, int more_entries); extern runlist_element *ntfs_rl_replace(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc); extern LCN ntfs_rl_vcn_to_lcn(const runlist_element *rl, const VCN vcn); extern s64 ntfs_rl_pread(const ntfs_volume *vol, const runlist_element *rl, const s64 pos, s64 count, void *b); extern s64 ntfs_rl_pwrite(const ntfs_volume *vol, const runlist_element *rl, s64 ofs, const s64 pos, s64 count, void *b); extern runlist_element *ntfs_runlists_merge(runlist_element *drl, runlist_element *srl); extern runlist_element *ntfs_mapping_pairs_decompress(const ntfs_volume *vol, const ATTR_RECORD *attr, runlist_element *old_rl); extern runlist_element *ntfs_decompress_cluster_run(const ntfs_volume *vol, const ATTR_RECORD *attr, runlist_element *old_rl, runlist_element **part_rl); extern int ntfs_get_nr_significant_bytes(const s64 n); extern int ntfs_get_size_for_mapping_pairs(const ntfs_volume *vol, const runlist_element *rl, const VCN start_vcn, int max_size); extern int ntfs_write_significant_bytes(u8 *dst, const u8 *dst_max, const s64 n); extern int ntfs_mapping_pairs_build(const ntfs_volume *vol, u8 *dst, const int dst_len, const runlist_element *rl, const VCN start_vcn, runlist_element const **stop_rl); extern int ntfs_rl_truncate(runlist **arl, const VCN start_vcn); extern int ntfs_rl_sparse(runlist *rl); extern s64 ntfs_rl_get_compressed_size(ntfs_volume *vol, runlist *rl); extern runlist_element *ntfs_rl_punch_hole(runlist_element *dst_rl, int dst_cnt, VCN start_vcn, s64 len, runlist_element **punch_rl); extern runlist *ntfs_copy_rl_clusters(ntfs_volume *vol, runlist *new_rl, int new_cnt, runlist *orig_rl, int orig_cnt); #ifdef NTFS_TEST int test_rl_main(int argc, char *argv[]); #endif #endif /* defined _NTFS_RUNLIST_H */ ntfsprogs-plus-1.0.0/include/security.h000066400000000000000000000226151507404161300201700ustar00rootroot00000000000000/* * security.h - Exports for handling security/ACLs in NTFS. * Originated from the Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2005-2006 Szabolcs Szakacsits * Copyright (c) 2007-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_SECURITY_H #define _NTFS_SECURITY_H #include "types.h" #include "layout.h" #include "inode.h" #include "dir.h" #include "endians.h" #ifndef POSIXACLS #define POSIXACLS 0 #endif /* * item in the mapping list */ struct MAPPING { struct MAPPING *next; int xid; /* linux id : uid or gid */ SID *sid; /* Windows id : usid or gsid */ int grcnt; /* group count (for users only) */ gid_t *groups; /* groups which the user is member of */ }; /* * Entry in the permissions cache * Note : this cache is not organized as a generic cache */ struct CACHED_PERMISSIONS { uid_t uid; gid_t gid; le32 inh_fileid; le32 inh_dirid; #if POSIXACLS struct POSIX_SECURITY *pxdesc; unsigned int pxdescsize:16; #endif unsigned int mode:12; unsigned int valid:1; } ; /* * Entry in the permissions cache for directories with no security_id */ struct CACHED_PERMISSIONS_LEGACY { struct CACHED_PERMISSIONS_LEGACY *next; struct CACHED_PERMISSIONS_LEGACY *previous; void *variable; size_t varsize; union ALIGNMENT payload[0]; /* above fields must match "struct CACHED_GENERIC" */ u64 mft_no; struct CACHED_PERMISSIONS perm; } ; /* * Entry in the securid cache */ struct CACHED_SECURID { struct CACHED_SECURID *next; struct CACHED_SECURID *previous; void *variable; size_t varsize; union ALIGNMENT payload[0]; /* above fields must match "struct CACHED_GENERIC" */ uid_t uid; gid_t gid; unsigned int dmode; le32 securid; } ; /* * Header of the security cache * (has no cache structure by itself) */ struct CACHED_PERMISSIONS_HEADER { unsigned int last; /* statistics for permissions */ unsigned long p_writes; unsigned long p_reads; unsigned long p_hits; } ; /* * The whole permissions cache */ struct PERMISSIONS_CACHE { struct CACHED_PERMISSIONS_HEADER head; struct CACHED_PERMISSIONS *cachetable[1]; /* array of variable size */ } ; /* * Security flags values */ enum { SECURITY_DEFAULT, /* rely on fuse for permissions checking */ SECURITY_RAW, /* force same ownership/permissions on files */ SECURITY_ACL, /* enable Posix ACLs (when compiled in) */ SECURITY_ADDSECURIDS, /* upgrade old security descriptors */ SECURITY_STATICGRPS, /* use static groups for access control */ SECURITY_WANTED /* a security related option was present */ } ; /* * Security context, needed by most security functions */ enum { MAPUSERS, MAPGROUPS, MAPCOUNT } ; struct SECURITY_CONTEXT { ntfs_volume *vol; struct MAPPING *mapping[MAPCOUNT]; struct PERMISSIONS_CACHE **pseccache; uid_t uid; /* uid of user requesting (not the mounter) */ gid_t gid; /* gid of user requesting (not the mounter) */ pid_t tid; /* thread id of thread requesting */ mode_t umask; /* umask of requesting thread */ } ; #if POSIXACLS /* * Posix ACL structures */ struct POSIX_ACE { u16 tag; u16 perms; s32 id; } __attribute__((__packed__)); struct POSIX_ACL { u8 version; u8 flags; u16 filler; struct POSIX_ACE ace[0]; } __attribute__((__packed__)); struct POSIX_SECURITY { mode_t mode; int acccnt; int defcnt; int firstdef; u16 tagsset; u16 filler; struct POSIX_ACL acl; } ; /* * Posix tags, cpu-endian 16 bits */ enum { POSIX_ACL_USER_OBJ = 1, POSIX_ACL_USER = 2, POSIX_ACL_GROUP_OBJ = 4, POSIX_ACL_GROUP = 8, POSIX_ACL_MASK = 16, POSIX_ACL_OTHER = 32, POSIX_ACL_SPECIAL = 64 /* internal use only */ } ; #define POSIX_ACL_EXTENSIONS (POSIX_ACL_USER | POSIX_ACL_GROUP | POSIX_ACL_MASK) /* * Posix permissions, cpu-endian 16 bits */ enum { POSIX_PERM_X = 1, POSIX_PERM_W = 2, POSIX_PERM_R = 4, POSIX_PERM_DENIAL = 64 /* internal use only */ } ; #define POSIX_VERSION 2 #endif extern BOOL ntfs_guid_is_zero(const GUID *guid); extern char *ntfs_guid_to_mbs(const GUID *guid, char *guid_str); extern int ntfs_sid_to_mbs_size(const SID *sid); extern char *ntfs_sid_to_mbs(const SID *sid, char *sid_str, size_t sid_str_size); extern void ntfs_generate_guid(GUID *guid); extern int ntfs_sd_add_everyone(ntfs_inode *ni); extern le32 ntfs_security_hash(const SECURITY_DESCRIPTOR_RELATIVE *sd, const u32 len); int ntfs_build_mapping(struct SECURITY_CONTEXT *scx, const char *usermap_path, BOOL allowdef); int ntfs_get_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, struct stat*); int ntfs_set_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, mode_t mode); BOOL ntfs_allowed_as_owner(struct SECURITY_CONTEXT *scx, ntfs_inode *ni); int ntfs_allowed_access(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, int accesstype); int ntfs_allowed_create(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, gid_t *pgid, mode_t *pdsetgid); BOOL old_ntfs_allowed_dir_access(struct SECURITY_CONTEXT *scx, const char *path, int accesstype); #if POSIXACLS le32 ntfs_alloc_securid(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid, ntfs_inode *dir_ni, mode_t mode, BOOL isdir); #else le32 ntfs_alloc_securid(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid, mode_t mode, BOOL isdir); #endif int ntfs_set_owner(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid); int ntfs_set_ownmod(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode); #if POSIXACLS int ntfs_set_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode, struct POSIX_SECURITY *pxdesc); #else int ntfs_set_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode); #endif le32 ntfs_inherited_id(struct SECURITY_CONTEXT *scx, ntfs_inode *dir_ni, BOOL fordir); int ntfs_open_secure(ntfs_volume *vol); int ntfs_close_secure(ntfs_volume *vol); void ntfs_destroy_security_context(struct SECURITY_CONTEXT *scx); #if POSIXACLS int ntfs_set_inherited_posix(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, ntfs_inode *dir_ni, mode_t mode); int ntfs_get_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name, char *value, size_t size); int ntfs_set_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name, const char *value, size_t size, int flags); int ntfs_remove_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name); #endif int ntfs_get_ntfs_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, char *value, size_t size); int ntfs_set_ntfs_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *value, size_t size, int flags); int ntfs_get_ntfs_attrib(ntfs_inode *ni, char *value, size_t size); int ntfs_set_ntfs_attrib(ntfs_inode *ni, const char *value, size_t size, int flags); /* * Security API for direct access to security descriptors * based on Win32 API */ #define MAGIC_API 0x09042009 struct SECURITY_API { u32 magic; struct SECURITY_CONTEXT security; struct PERMISSIONS_CACHE *seccache; } ; /* * The following constants are used in interfacing external programs. * They are not to be stored on disk and must be defined in their * native cpu representation. * When disk representation (le) is needed, use SE_DACL_PRESENT, etc. */ enum { OWNER_SECURITY_INFORMATION = 1, GROUP_SECURITY_INFORMATION = 2, DACL_SECURITY_INFORMATION = 4, SACL_SECURITY_INFORMATION = 8 } ; int ntfs_get_file_security(struct SECURITY_API *scapi, const char *path, u32 selection, char *buf, u32 buflen, u32 *psize); int ntfs_set_file_security(struct SECURITY_API *scapi, const char *path, u32 selection, const char *attr); int ntfs_get_file_attributes(struct SECURITY_API *scapi, const char *path); BOOL ntfs_set_file_attributes(struct SECURITY_API *scapi, const char *path, s32 attrib); BOOL ntfs_read_directory(struct SECURITY_API *scapi, const char *path, ntfs_filldir_t callback, void *context); int ntfs_read_sds(struct SECURITY_API *scapi, char *buf, u32 size, u32 offset); INDEX_ENTRY *ntfs_read_sii(struct SECURITY_API *scapi, INDEX_ENTRY *entry); INDEX_ENTRY *ntfs_read_sdh(struct SECURITY_API *scapi, INDEX_ENTRY *entry); struct SECURITY_API *ntfs_initialize_file_security(const char *device, unsigned long flags); BOOL ntfs_leave_file_security(struct SECURITY_API *scx); int ntfs_get_usid(struct SECURITY_API *scapi, uid_t uid, char *buf); int ntfs_get_gsid(struct SECURITY_API *scapi, gid_t gid, char *buf); int ntfs_get_user(struct SECURITY_API *scapi, const SID *usid); int ntfs_get_group(struct SECURITY_API *scapi, const SID *gsid); #endif /* defined _NTFS_SECURITY_H */ ntfsprogs-plus-1.0.0/include/support.h000066400000000000000000000055471507404161300200420ustar00rootroot00000000000000/* * support.h - Useful definitions and macros. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_SUPPORT_H #define _NTFS_SUPPORT_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDDEF_H #include #endif /* * Our mailing list. Use this define to prevent typos in email address. */ #define NTFS_DEV_LIST "ntfs-3g-devel@lists.sf.net" /* * Generic macro to convert pointers to values for comparison purposes. */ #ifndef p2n #define p2n(p) ((ptrdiff_t)((ptrdiff_t*)(p))) #endif /* * The classic min and max macros. */ #ifndef min #define min(a,b) ((a) <= (b) ? (a) : (b)) #endif #ifndef max #define max(a,b) ((a) >= (b) ? (a) : (b)) #endif /* * Useful macro for determining the offset of a struct member. */ #ifndef offsetof #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) #endif /* * Simple bit operation macros. NOTE: These are NOT atomic. */ #define test_bit(bit, var) ((var) & (1 << (bit))) #define set_bit(bit, var) (var) |= 1 << (bit) #define clear_bit(bit, var) (var) &= ~(1 << (bit)) #define test_and_set_bit(bit, var) \ ({ \ const BOOL old_state = test_bit(bit, var); \ set_bit(bit, var); \ old_state; \ }) #define test_and_clear_bit(bit, var) \ ({ \ const BOOL old_state = test_bit(bit, var); \ clear_bit(bit, var); \ old_state; \ }) /** * round_up - round up to next specified power of 2 * @x: the value to round * @y: multiple to round up to (must be a power of 2) * * Rounds @x up to next multiple of @y (which must be a power of 2). * To perform arbitrary rounding up, use roundup() below. */ #define round_up(x, y) ((((x) - 1) | ((y) - 1)) + 1) /** * round_down - round down to next specified power of 2 * @x: the value to round * @y: multiple to round down to (must be a power of 2) * * Rounds @x down to next multiple of @y (which must be a power of 2). * To perform arbitrary rounding down, use rounddown() below. */ #define round_down(x, y) ((x) & ~((y) - 1)) #endif /* defined _NTFS_SUPPORT_H */ ntfsprogs-plus-1.0.0/include/types.h000066400000000000000000000063101507404161300174570ustar00rootroot00000000000000/* * types.h - Misc type definitions not related to on-disk structure. * Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_TYPES_H #define _NTFS_TYPES_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #if HAVE_STDINT_H || !HAVE_CONFIG_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #include typedef uint8_t u8; /* Unsigned types of an exact size */ typedef uint16_t u16; typedef uint32_t u32; typedef uint64_t u64; typedef int8_t s8; /* Signed types of an exact size */ typedef int16_t s16; typedef int32_t s32; typedef int64_t s64; typedef u16 le16; typedef u32 le32; typedef u64 le64; typedef u16 be16; typedef u32 be32; typedef u64 be64; /* * Declare s{l,b}e{16,32,64} to be unsigned because we do not want sign * extension on BE architectures. */ typedef u16 sle16; typedef u32 sle32; typedef u64 sle64; typedef u16 sbe16; typedef u32 sbe32; typedef u64 sbe64; typedef le16 ntfschar; /* 2-byte Unicode character type. */ #define UCHAR_T_SIZE_BITS 1 /* * Clusters are signed 64-bit values on NTFS volumes. We define two types, LCN * and VCN, to allow for type checking and better code readability. */ typedef s64 VCN; typedef sle64 leVCN; typedef s64 LCN; typedef sle64 leLCN; /* * The NTFS journal $LogFile uses log sequence numbers which are signed 64-bit * values. We define our own type LSN, to allow for type checking and better * code readability. */ typedef s64 LSN; typedef sle64 leLSN; /* * Cygwin has a collision between our BOOL and 's * As long as this file will be included after were fine. */ #ifndef _WINDEF_H /** * enum BOOL - These are just to make the code more readable... */ typedef enum { #ifndef FALSE FALSE = 0, #endif #ifndef NO NO = 0, #endif #ifndef ZERO ZERO = 0, #endif #ifndef TRUE TRUE = 1, #endif #ifndef YES YES = 1, #endif #ifndef ONE ONE = 1, #endif } BOOL; #endif /* defined _WINDEF_H */ /** * enum IGNORE_CASE_BOOL - */ typedef enum { CASE_SENSITIVE = 0, IGNORE_CASE = 1, } IGNORE_CASE_BOOL; typedef enum { STATUS_FIXED = 1, STATUS_OK = 0, STATUS_ERROR = -1, STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT = -2, STATUS_KEEP_SEARCHING = -3, STATUS_NOT_FOUND = -4, } STATUS_T; /* * Force alignment in a struct if required by processor */ union ALIGNMENT { u64 u64align; void *ptralign; } ; #endif /* defined _NTFS_TYPES_H */ ntfsprogs-plus-1.0.0/include/unistr.h000066400000000000000000000117161507404161300176450ustar00rootroot00000000000000/* * unistr.h - Exports for Unicode string handling. Originated from the Linux-NTFS * project. * * Copyright (c) 2000-2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_UNISTR_H #define _NTFS_UNISTR_H #include "types.h" #include "layout.h" extern BOOL ntfs_names_are_equal(const ntfschar *s1, size_t s1_len, const ntfschar *s2, size_t s2_len, const IGNORE_CASE_BOOL ic, const ntfschar *upcase, const u32 upcase_size); extern int ntfs_names_full_collate(const ntfschar *name1, const u32 name1_len, const ntfschar *name2, const u32 name2_len, const IGNORE_CASE_BOOL ic, const ntfschar *upcase, const u32 upcase_len); extern int ntfs_ucsncmp(const ntfschar *s1, const ntfschar *s2, size_t n); extern int ntfs_ucsncasecmp(const ntfschar *s1, const ntfschar *s2, size_t n, const ntfschar *upcase, const u32 upcase_size); extern u32 ntfs_ucsnlen(const ntfschar *s, u32 maxlen); extern ntfschar *ntfs_ucsndup(const ntfschar *s, u32 maxlen); extern void ntfs_name_upcase(ntfschar *name, u32 name_len, const ntfschar *upcase, const u32 upcase_len); extern void ntfs_name_locase(ntfschar *name, u32 name_len, const ntfschar *locase, const u32 locase_len); extern void ntfs_file_value_upcase(FILE_NAME_ATTR *file_name_attr, const ntfschar *upcase, const u32 upcase_len); extern int ntfs_ucstombs(const ntfschar *ins, const int ins_len, char **outs, int outs_len); extern int ntfs_mbstoucs(const char *ins, ntfschar **outs); extern char *ntfs_uppercase_mbs(const char *low, const ntfschar *upcase, u32 upcase_len); extern void ntfs_upcase_table_build(ntfschar *uc, u32 uc_len); extern u32 ntfs_upcase_build_default(ntfschar **upcase); extern ntfschar *ntfs_locase_table_build(const ntfschar *uc, u32 uc_cnt); extern ntfschar *ntfs_str2ucs(const char *s, int *len); extern void ntfs_ucsfree(ntfschar *ucs); extern BOOL ntfs_forbidden_chars(const ntfschar *name, int len, BOOL strict); extern BOOL ntfs_forbidden_names(ntfs_volume *vol, const ntfschar *name, int len, BOOL strict); extern BOOL ntfs_collapsible_chars(ntfs_volume *vol, const ntfschar *shortname, int shortlen, const ntfschar *longname, int longlen); extern int ntfs_set_char_encoding(const char *locale); #if defined(__APPLE__) || defined(__DARWIN__) /** * Mac OS X only. * * Sets file name Unicode normalization form conversion on or off. * normalize=0 : Off * normalize=1 : On * If set to on, all filenames returned by ntfs-3g will be converted to the NFD * normalization form, while all filenames recieved by ntfs-3g will be converted to the NFC * normalization form. Since Windows and most other OS:es use the NFC form while Mac OS X * mostly uses NFD, this conversion increases compatibility between Mac applications and * NTFS-3G. * * @param normalize decides whether or not the string functions will do automatic filename * normalization when converting to and from UTF-8. 0 means normalization is disabled, * 1 means it is enabled. * @return -1 if the argument was invalid or an error occurred, 0 if all went well. */ extern int ntfs_macosx_normalize_filenames(int normalize); /** * Mac OS X only. * * Normalizes the input string "utf8_string" to one of the normalization forms NFD or NFC. * The parameter "composed" decides whether output should be in composed, NFC, form * (composed == 1) or decomposed, NFD, form (composed == 0). * Input is assumed to be properly UTF-8 encoded and null-terminated. Output will be a newly * ntfs_calloc'ed string encoded in UTF-8. It is the callers responsibility to free(...) the * allocated string when it's no longer needed. * * @param utf8_string the input string, which may be in any normalization form. * @param target a pointer where the resulting string will be stored. * @param composed decides which composition form to normalize the input string to. 0 means * composed form (NFC), 1 means decomposed form (NFD). * @return -1 if the normalization failed for some reason, otherwise the length of the * normalized string stored in target. */ extern int ntfs_macosx_normalize_utf8(const char *utf8_string, char **target, int composed); #endif /* defined(__APPLE__) || defined(__DARWIN__) */ #endif /* defined _NTFS_UNISTR_H */ ntfsprogs-plus-1.0.0/include/volume.h000066400000000000000000000353701507404161300176320ustar00rootroot00000000000000/* * volume.h - Exports for NTFS volume handling. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2005-2006 Yura Pakhuchiy * Copyright (c) 2005-2009 Szabolcs Szakacsits * Copyright (c) 2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_VOLUME_H #define _NTFS_VOLUME_H #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_SYS_PARAM_H #include #endif /* Do not #include here : conflicts with */ #ifdef HAVE_MNTENT_H #include #endif /* Forward declaration */ typedef struct _ntfs_volume ntfs_volume; #include "param.h" #include "types.h" #include "support.h" #include "device.h" #include "inode.h" #include "attrib.h" #include "index.h" extern int fsck_errors; extern int fsck_fixes; extern int parse_errors; /* It is called when found filesystem inconsistency */ #define check_failed(FORMAT, ARGS...) \ do { \ fsck_err_found(); \ ntfs_log_redirect(__FUNCTION__, __FILE__, __LINE__, \ NTFS_LOG_LEVEL_ERROR, NULL, FORMAT, ##ARGS); \ } while (0) #define fsck_err_found() \ do { \ fsck_errors++; \ } while (0) /* It is called when repairing is failed */ #define fsck_err_failed() \ do { \ fsck_errors++; \ } while (0) /* It is called after repair completed */ #define fsck_err_fixed() \ do { \ fsck_fixes++; \ } while (0) /* It is called when each fsck step start */ #define fsck_start_step(FORMAT, ARGS...) \ do { \ ntfs_log_info("Parse #%d: " FORMAT, parse_count++, ##ARGS); \ if (fsck_errors) \ ntfs_log_info(" (left:%d, errors:%d, fixed:%d)", \ fsck_errors - fsck_fixes, fsck_errors, fsck_fixes); \ ntfs_log_info("\n"); \ } while (0) /* It is called when each fsck step end */ #define fsck_end_step() \ do { \ if ((fsck_errors - fsck_fixes) != parse_errors) \ parse_errors = (fsck_errors - fsck_fixes); \ if (parse_errors) \ ntfs_log_info("Parse #%d Errors remains: %d\n", \ parse_count - 1, parse_errors); \ } while (0) /** * enum ntfs_mount_flags - * * Flags for the ntfs_mount() function. */ enum { NTFS_MNT_NONE = 0x00000000, NTFS_MNT_RDONLY = 0x00000001, NTFS_MNT_FS_NO_REPAIR = 0x00000010, NTFS_MNT_FS_AUTO_REPAIR = 0x00000020, NTFS_MNT_FS_PREEN_REPAIR = 0x00000020, /* same as AUTO_REPAIR */ NTFS_MNT_FS_YES_REPAIR = 0x00000040, NTFS_MNT_FS_ASK_REPAIR = 0x00000080, NTFS_MNT_FSCK = 0x00000100, NTFS_MNT_MAY_RDONLY = 0x02000000, /* Allow fallback to ro */ NTFS_MNT_FORENSIC = 0x04000000, /* No modification during * mount. */ NTFS_MNT_EXCLUSIVE = 0x08000000, NTFS_MNT_RECOVER = 0x10000000, NTFS_MNT_IGNORE_HIBERFILE = 0x20000000, }; typedef unsigned long ntfs_mount_flags; /** * enum ntfs_mounted_flags - * * Flags returned by the ntfs_check_if_mounted() function. */ typedef enum { NTFS_MF_MOUNTED = 1, /* Device is mounted. */ NTFS_MF_ISROOT = 2, /* Device is mounted as system root. */ NTFS_MF_READONLY = 4, /* Device is mounted read-only. */ } ntfs_mounted_flags; extern int ntfs_check_if_mounted(const char *file, unsigned long *mnt_flags); typedef enum { NTFS_VOLUME_OK = 0, NTFS_VOLUME_SYNTAX_ERROR = 11, NTFS_VOLUME_NOT_NTFS = 12, NTFS_VOLUME_CORRUPT = 13, NTFS_VOLUME_HIBERNATED = 14, NTFS_VOLUME_UNCLEAN_UNMOUNT = 15, NTFS_VOLUME_LOCKED = 16, NTFS_VOLUME_RAID = 17, NTFS_VOLUME_UNKNOWN_REASON = 18, NTFS_VOLUME_NO_PRIVILEGE = 19, NTFS_VOLUME_OUT_OF_MEMORY = 20, NTFS_VOLUME_FUSE_ERROR = 21, NTFS_VOLUME_INSECURE = 22 } ntfs_volume_status; typedef enum { NTFS_FILES_INTERIX, NTFS_FILES_WSL, } ntfs_volume_special_files; /** * enum ntfs_volume_state_bits - * * Defined bits for the state field in the ntfs_volume structure. */ typedef enum { NV_ReadOnly, /* 1: Volume is read-only. */ NV_CaseSensitive, /* 1: Volume is mounted case-sensitive. */ NV_LogFileEmpty, /* 1: $logFile journal is empty. */ NV_ShowSysFiles, /* 1: Show NTFS metafiles. */ NV_ShowHidFiles, /* 1: Show files marked hidden. */ NV_HideDotFiles, /* 1: Set hidden flag on dot files */ NV_Compression, /* 1: allow compression */ NV_NoFixupWarn, /* 1: Do not log fixup errors */ NV_FreeSpaceKnown, /* 1: The free space is now known */ NV_FsNoRepair, /* 1: Volume is for fsck */ NV_FsAutoRepair, /* 1: Volume is for fsck */ NV_FsYesRepair, /* 1: Volume is for fsck */ NV_FsAskRepair, /* 1: Volume is for fsck */ NV_Fsck, /* 1: Volume is on fsck */ } ntfs_volume_state_bits; #define test_nvol_flag(nv, flag) test_bit(NV_##flag, (nv)->state) #define set_nvol_flag(nv, flag) set_bit(NV_##flag, (nv)->state) #define clear_nvol_flag(nv, flag) clear_bit(NV_##flag, (nv)->state) #define NVolReadOnly(nv) test_nvol_flag(nv, ReadOnly) #define NVolSetReadOnly(nv) set_nvol_flag(nv, ReadOnly) #define NVolClearReadOnly(nv) clear_nvol_flag(nv, ReadOnly) #define NVolCaseSensitive(nv) test_nvol_flag(nv, CaseSensitive) #define NVolSetCaseSensitive(nv) set_nvol_flag(nv, CaseSensitive) #define NVolClearCaseSensitive(nv) clear_nvol_flag(nv, CaseSensitive) #define NVolLogFileEmpty(nv) test_nvol_flag(nv, LogFileEmpty) #define NVolSetLogFileEmpty(nv) set_nvol_flag(nv, LogFileEmpty) #define NVolClearLogFileEmpty(nv) clear_nvol_flag(nv, LogFileEmpty) #define NVolShowSysFiles(nv) test_nvol_flag(nv, ShowSysFiles) #define NVolSetShowSysFiles(nv) set_nvol_flag(nv, ShowSysFiles) #define NVolClearShowSysFiles(nv) clear_nvol_flag(nv, ShowSysFiles) #define NVolShowHidFiles(nv) test_nvol_flag(nv, ShowHidFiles) #define NVolSetShowHidFiles(nv) set_nvol_flag(nv, ShowHidFiles) #define NVolClearShowHidFiles(nv) clear_nvol_flag(nv, ShowHidFiles) #define NVolHideDotFiles(nv) test_nvol_flag(nv, HideDotFiles) #define NVolSetHideDotFiles(nv) set_nvol_flag(nv, HideDotFiles) #define NVolClearHideDotFiles(nv) clear_nvol_flag(nv, HideDotFiles) #define NVolCompression(nv) test_nvol_flag(nv, Compression) #define NVolSetCompression(nv) set_nvol_flag(nv, Compression) #define NVolClearCompression(nv) clear_nvol_flag(nv, Compression) #define NVolNoFixupWarn(nv) test_nvol_flag(nv, NoFixupWarn) #define NVolSetNoFixupWarn(nv) set_nvol_flag(nv, NoFixupWarn) #define NVolClearNoFixupWarn(nv) clear_nvol_flag(nv, NoFixupWarn) #define NVolFreeSpaceKnown(nv) test_nvol_flag(nv, FreeSpaceKnown) #define NVolSetFreeSpaceKnown(nv) set_nvol_flag(nv, FreeSpaceKnown) #define NVolClearFreeSpaceKnown(nv) clear_nvol_flag(nv, FreeSpaceKnown) #define NVolFsNoRepair(nv) test_nvol_flag(nv, FsNoRepair) #define NVolSetFsNoRepair(nv) set_nvol_flag(nv, FsNoRepair) #define NVolClearFsNoRepair(nv) clear_nvol_flag(nv, FsNoRepair) #define NVolFsAutoRepair(nv) test_nvol_flag(nv, FsAutoRepair) #define NVolSetFsAutoRepair(nv) set_nvol_flag(nv, FsAutoRepair) #define NVolClearFsAutoRepair(nv) clear_nvol_flag(nv, FsAutoRepair) #define NVolFsYesRepair(nv) test_nvol_flag(nv, FsYesRepair) #define NVolSetFsYesRepair(nv) set_nvol_flag(nv, FsYesRepair) #define NVolClearFsYesRepair(nv) clear_nvol_flag(nv, FsYesRepair) #define NVolFsAskRepair(nv) test_nvol_flag(nv, FsAskRepair) #define NVolSetFsAskRepair(nv) set_nvol_flag(nv, FsAskRepair) #define NVolClearFsAskRepair(nv) clear_nvol_flag(nv, FsAskRepair) #define NVolFsck(nv) test_nvol_flag(nv, Fsck) #define NVolSetFsck(nv) set_nvol_flag(nv, Fsck) #define NVolClearFsck(nv) clear_nvol_flag(nv, Fsck) #define NVolIsOnFsck(nv) NVolFsck(nv) /* * NTFS version 1.1 and 1.2 are used by Windows NT4. * NTFS version 2.x is used by Windows 2000 Beta * NTFS version 3.0 is used by Windows 2000. * NTFS version 3.1 is used by Windows XP, 2003 and Vista. */ #define NTFS_V1_1(major, minor) ((major) == 1 && (minor) == 1) #define NTFS_V1_2(major, minor) ((major) == 1 && (minor) == 2) #define NTFS_V2_X(major, minor) ((major) == 2) #define NTFS_V3_0(major, minor) ((major) == 3 && (minor) == 0) #define NTFS_V3_1(major, minor) ((major) == 3 && (minor) == 1) #define NTFS_BUF_SIZE (8192) #define MFTBMP_CACHE_SIZE (NTFS_BUF_SIZE) /** * struct _ntfs_volume - structure describing an open volume in memory. */ struct _ntfs_volume { union { struct ntfs_device *dev; /* NTFS device associated with the volume. */ void *sb; /* For kernel porting compatibility. */ }; char *vol_name; /* Name of the volume. */ unsigned long state; /* NTFS specific flags describing this volume. See ntfs_volume_state_bits above. */ ntfs_inode *vol_ni; /* ntfs_inode structure for FILE_Volume. */ u8 major_ver; /* Ntfs major version of volume. */ u8 minor_ver; /* Ntfs minor version of volume. */ le16 flags; /* Bit array of VOLUME_* flags. */ u16 sector_size; /* Byte size of a sector. */ u8 sector_size_bits; /* Log(2) of the byte size of a sector. */ u32 cluster_size; /* Byte size of a cluster. */ u32 mft_record_size; /* Byte size of a mft record. */ u32 indx_record_size; /* Byte size of a INDX record. */ u8 cluster_size_bits; /* Log(2) of the byte size of a cluster. */ u8 mft_record_size_bits;/* Log(2) of the byte size of a mft record. */ u8 indx_record_size_bits;/* Log(2) of the byte size of a INDX record. */ /* Variables used by the cluster and mft allocators. */ u8 mft_zone_multiplier; /* Initial mft zone multiplier. */ u8 full_zones; /* cluster zones which are full */ s64 mft_data_pos; /* Mft record number at which to allocate the next mft record. */ LCN mft_zone_start; /* First cluster of the mft zone. */ LCN mft_zone_end; /* First cluster beyond the mft zone. */ LCN mft_zone_pos; /* Current position in the mft zone. */ LCN data1_zone_pos; /* Current position in the first data zone. */ LCN data2_zone_pos; /* Current position in the second data zone. */ s64 nr_clusters; /* Volume size in clusters, hence also the number of bits in lcn_bitmap. */ s64 nr_sectors; /* total number of sectors */ ntfs_inode *lcnbmp_ni; /* ntfs_inode structure for FILE_Bitmap. */ ntfs_attr *lcnbmp_na; /* ntfs_attr structure for the data attribute of FILE_Bitmap. Each bit represents a cluster on the volume, bit 0 representing lcn 0 and so on. A set bit means that the cluster and vice versa. */ LCN mft_lcn; /* Logical cluster number of the data attribute for FILE_MFT. */ ntfs_inode *mft_ni; /* ntfs_inode structure for FILE_MFT. */ ntfs_attr *mft_na; /* ntfs_attr structure for the data attribute of FILE_MFT. */ ntfs_attr *mftbmp_na; /* ntfs_attr structure for the bitmap attribute of FILE_MFT. Each bit represents an mft record in the $DATA attribute, bit 0 representing mft record 0 and so on. A set bit means that the mft record is in use and vice versa. */ ntfs_inode *secure_ni; /* ntfs_inode structure for FILE $Secure */ ntfs_index_context *secure_xsii; /* index for using $Secure:$SII */ ntfs_index_context *secure_xsdh; /* index for using $Secure:$SDH */ int secure_reentry; /* check for non-rentries */ unsigned int secure_flags; /* flags, see security.h for values */ int mftmirr_size; /* Size of the FILE_MFTMirr in mft records. */ LCN mftmirr_lcn; /* Logical cluster number of the data attribute for FILE_MFTMirr. */ ntfs_inode *mftmirr_ni; /* ntfs_inode structure for FILE_MFTMirr. */ ntfs_attr *mftmirr_na; /* ntfs_attr structure for the data attribute of FILE_MFTMirr. */ ntfschar *upcase; /* Upper case equivalents of all 65536 2-byte Unicode characters. Obtained from FILE_UpCase. */ u32 upcase_len; /* Length in Unicode characters of the upcase table. */ ntfschar *locase; /* Lower case equivalents of all 65536 2-byte Unicode characters. Only if option case_ignore is set. */ ATTR_DEF *attrdef; /* Attribute definitions. Obtained from FILE_AttrDef. */ s32 attrdef_len; /* Size of the attribute definition table in bytes. */ s64 free_clusters; /* Track the number of free clusters which greatly improves statfs() performance */ s64 free_mft_records; /* Same for free mft records (see above) */ BOOL efs_raw; /* volume is mounted for raw access to efs-encrypted files */ ntfs_volume_special_files special_files; /* Implementation of special files */ const char *abs_mnt_point; /* Mount point */ /* TODO: separate fields related with 'fsck' from volume structure */ u64 lost_found; /* mft record number for lost_found directory */ u8 **fsck_lcn_bitmap; /* lcn bitmap of fsck */ u64 max_flb_cnt; u8 **fsck_mft_bitmap; /* mft bitmap of fsck */ u64 max_fmb_cnt; ntfs_mount_flags option_flags; /* fsck option flags */ #ifdef XATTR_MAPPINGS struct XATTRMAPPING *xattr_mapping; #endif /* XATTR_MAPPINGS */ #if CACHE_INODE_SIZE struct CACHE_HEADER *xinode_cache; #endif #if CACHE_NIDATA_SIZE struct CACHE_HEADER *nidata_cache; #endif #if CACHE_LOOKUP_SIZE struct CACHE_HEADER *lookup_cache; #endif struct CACHE_HEADER *securid_cache; #if CACHE_LEGACY_SIZE struct CACHE_HEADER *legacy_cache; #endif }; extern const char *ntfs_home; extern ntfs_volume *ntfs_volume_alloc(void); extern ntfs_volume *ntfs_volume_startup(struct ntfs_device *dev, ntfs_mount_flags flags); extern ntfs_volume *ntfs_device_mount(struct ntfs_device *dev, ntfs_mount_flags flags); extern ntfs_volume *ntfs_mount(const char *name, ntfs_mount_flags flags); extern int ntfs_umount(ntfs_volume *vol, const BOOL force); extern int ntfs_version_is_supported(ntfs_volume *vol); extern int ntfs_volume_check_hiberfile(ntfs_volume *vol, int verbose); extern int ntfs_logfile_reset(ntfs_volume *vol); extern int ntfs_volume_write_flags(ntfs_volume *vol, const le16 flags); extern int ntfs_volume_error(int err); extern void ntfs_mount_error(const char *vol, const char *mntpoint, int err); extern int ntfs_volume_get_free_space(ntfs_volume *vol); extern int ntfs_volume_rename(ntfs_volume *vol, const ntfschar *label, int label_len); extern int ntfs_set_shown_files(ntfs_volume *vol, BOOL show_sys_files, BOOL show_hid_files, BOOL hide_dot_files); extern int ntfs_set_locale(void); extern int ntfs_set_ignore_case(ntfs_volume *vol); #endif /* defined _NTFS_VOLUME_H */ ntfsprogs-plus-1.0.0/include/xattrs.h000066400000000000000000000060021507404161300176360ustar00rootroot00000000000000/* * xattrs.h : definitions related to system extended attributes * * Copyright (c) 2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFS_XATTRS_H_ #define _NTFS_XATTRS_H_ /* * Flags that modify setxattr() semantics. These flags are also used by a * number of libntfs-3g functions, such as ntfs_set_ntfs_acl(), which were * originally tied to extended attributes support but now can be used by * applications even if the platform does not support extended attributes. * * Careful: applications including this header should define HAVE_SETXATTR or * HAVE_SYS_XATTR_H if the platform supports extended attributes. Otherwise the * defined flags values may be incorrect (they will be correct for Linux but not * necessarily for other platforms). */ #if defined(HAVE_SETXATTR) || defined(HAVE_SYS_XATTR_H) #include #else #include "compat.h" /* may be needed for ENODATA definition */ #define XATTR_CREATE 1 #define XATTR_REPLACE 2 #endif /* * Identification of data mapped to the system name space */ enum SYSTEMXATTRS { XATTR_UNMAPPED, XATTR_NTFS_ACL, XATTR_NTFS_ATTRIB, XATTR_NTFS_ATTRIB_BE, XATTR_NTFS_EFSINFO, XATTR_NTFS_REPARSE_DATA, XATTR_NTFS_OBJECT_ID, XATTR_NTFS_DOS_NAME, XATTR_NTFS_TIMES, XATTR_NTFS_TIMES_BE, XATTR_NTFS_CRTIME, XATTR_NTFS_CRTIME_BE, XATTR_NTFS_EA, XATTR_POSIX_ACC, XATTR_POSIX_DEF } ; struct XATTRMAPPING { struct XATTRMAPPING *next; enum SYSTEMXATTRS xattr; char name[1]; /* variable length */ } ; #ifdef XATTR_MAPPINGS struct XATTRMAPPING *ntfs_xattr_build_mapping(ntfs_volume *vol, const char *path); void ntfs_xattr_free_mapping(struct XATTRMAPPING*); #endif /* XATTR_MAPPINGS */ enum SYSTEMXATTRS ntfs_xattr_system_type(const char *name, ntfs_volume *vol); struct SECURITY_CONTEXT; int ntfs_xattr_system_getxattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni, char *value, size_t size); int ntfs_xattr_system_setxattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni, const char *value, size_t size, int flags); int ntfs_xattr_system_removexattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni); #endif /* _NTFS_XATTRS_H_ */ ntfsprogs-plus-1.0.0/libntfs/000077500000000000000000000000001507404161300161605ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/libntfs/Makefile.am000066400000000000000000000033361507404161300202210ustar00rootroot00000000000000 MAINTAINERCLEANFILES = $(srcdir)/Makefile.in if INSTALL_LIBRARY rootlib_LTLIBRARIES=#Create directory lib_LTLIBRARIES = libntfs.la else noinst_LTLIBRARIES = libntfs.la endif libntfs_la_CFLAGS = $(AM_CFLAGS) libntfs_la_CPPFLAGS= $(AM_CPPFLAGS) $(LIBNTFS_CPPFLAGS) -I$(top_srcdir)/include libntfs_la_LIBADD = $(LIBNTFS_LIBS) libntfs_la_LDFLAGS = -version-info $(LIBNTFS_VERSION) -no-undefined libntfs_la_SOURCES = \ acls.c \ attrib.c \ attrlist.c \ bitmap.c \ bootsect.c \ cache.c \ collate.c \ compat.c \ compress.c \ debug.c \ device.c \ dir.c \ ea.c \ efs.c \ fsck.c \ index.c \ inode.c \ ioctl.c \ lcnalloc.c \ lib_utils.c \ logfile.c \ logging.c \ mft.c \ misc.c \ mst.c \ object_id.c \ problem.c \ realpath.c \ reparse.c \ runlist.c \ security.c \ unistr.c \ volume.c \ xattrs.c if NTFS_DEVICE_DEFAULT_IO_OPS if WINDOWS libntfs_la_SOURCES += win32_io.c else libntfs_la_SOURCES += unix_io.c endif endif # We may need to move .so files to root # And create ldscript or symbolic link from /usr install-exec-hook: install-rootlibLTLIBRARIES if INSTALL_LIBRARY if [ ! "$(DESTDIR)/$(rootlibdir)" -ef "$(DESTDIR)/$(libdir)" ]; then \ $(MV) -f "$(DESTDIR)/$(libdir)"/libntfs.so* "$(DESTDIR)/$(rootlibdir)"; \ fi if GENERATE_LDSCRIPT if [ ! "$(DESTDIR)/$(rootlibdir)" -ef "$(DESTDIR)/$(libdir)" ]; then \ $(install_sh_PROGRAM) "libntfs.script.so" "$(DESTDIR)/$(libdir)/libntfs.so"; \ fi else if [ ! "$(DESTDIR)/$(rootlibdir)" -ef "$(DESTDIR)/$(libdir)" ]; then \ $(LN_S) "$(rootlibdir)/libntfs.so" "$(DESTDIR)/$(libdir)/libntfs.so"; \ fi endif endif uninstall-local: if INSTALL_LIBRARY $(RM) -f "$(DESTDIR)/$(rootlibdir)"/libntfs.so* endif libs: $(lib_LTLIBRARIES) ntfsprogs-plus-1.0.0/libntfs/acls.c000066400000000000000000003477041507404161300172650ustar00rootroot00000000000000/** * acls.c - General function to process NTFS ACLs * * This module is part of ntfs-3g library, but may also be * integrated in tools running over Linux or Windows * * Copyright (c) 2007-2017 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_SYSLOG_H #include #endif #include #include #include #include "types.h" #include "layout.h" #include "security.h" #include "acls.h" #include "misc.h" /* * A few useful constants */ /* * null SID (S-1-0-0) */ static const char nullsidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 0, /* base */ 0, 0, 0, 0 /* 1st level */ }; static const SID *nullsid = (const SID*)nullsidbytes; /* * SID for world (S-1-1-0) */ static const char worldsidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 1, /* base */ 0, 0, 0, 0 /* 1st level */ } ; const SID *worldsid = (const SID*)worldsidbytes; /* * SID for authenticated user (S-1-5-11) */ static const char authsidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 5, /* base */ 11, 0, 0, 0 /* 1st level */ }; static const SID *authsid = (const SID*)authsidbytes; /* * SID for administrator */ static const char adminsidbytes[] = { 1, /* revision */ 2, /* auth count */ 0, 0, 0, 0, 0, 5, /* base */ 32, 0, 0, 0, /* 1st level */ 32, 2, 0, 0 /* 2nd level */ }; const SID *adminsid = (const SID*)adminsidbytes; /* * SID for system */ static const char systemsidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 5, /* base */ 18, 0, 0, 0 /* 1st level */ }; static const SID *systemsid = (const SID*)systemsidbytes; /* * SID for generic creator-owner * S-1-3-0 */ static const char ownersidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 3, /* base */ 0, 0, 0, 0 /* 1st level */ } ; static const SID *ownersid = (const SID*)ownersidbytes; /* * SID for generic creator-group * S-1-3-1 */ static const char groupsidbytes[] = { 1, /* revision */ 1, /* auth count */ 0, 0, 0, 0, 0, 3, /* base */ 1, 0, 0, 0 /* 1st level */ } ; static const SID *groupsid = (const SID*)groupsidbytes; /* * Determine the size of a SID */ int ntfs_sid_size(const SID * sid) { return (sid->sub_authority_count * 4 + 8); } /* * Test whether two SID are equal */ BOOL ntfs_same_sid(const SID *first, const SID *second) { int size; size = ntfs_sid_size(first); return ((ntfs_sid_size(second) == size) && !memcmp(first, second, size)); } /* * Test whether a SID means "world user" * Local users group recognized as world * Also interactive users so that /Users/Public is world accessible, * but only if Posix ACLs are not enabled (if Posix ACLs are enabled, * access to /Users/Public should be done by defining interactive users * as a mapped group.) */ static int is_world_sid(const SID * usid) { return ( /* check whether S-1-1-0 : world */ ((usid->sub_authority_count == 1) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(1)) && (usid->sub_authority[0] == const_cpu_to_le32(0))) /* check whether S-1-5-32-545 : local user */ || ((usid->sub_authority_count == 2) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(5)) && (usid->sub_authority[0] == const_cpu_to_le32(32)) && (usid->sub_authority[1] == const_cpu_to_le32(545))) /* check whether S-1-5-11 : authenticated user */ || ((usid->sub_authority_count == 1) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(5)) && (usid->sub_authority[0] == const_cpu_to_le32(11))) #if !POSIXACLS /* check whether S-1-5-4 : interactive user */ || ((usid->sub_authority_count == 1) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(5)) && (usid->sub_authority[0] == const_cpu_to_le32(4))) #endif /* !POSIXACLS */ ); } /* * Test whether a SID means "some user (or group)" * Currently we only check for S-1-5-21... but we should * probably test for other configurations */ BOOL ntfs_is_user_sid(const SID *usid) { return ((usid->sub_authority_count == 5) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(5)) && (usid->sub_authority[0] == const_cpu_to_le32(21))); } /* * Test whether a SID means "some special group" * Currently we only check for a few S-1-5-n but we should * probably test for other configurations. * * This is useful for granting access to /Users/Public for * specific users when the Posix ACLs are enabled. */ static BOOL ntfs_known_group_sid(const SID *usid) { /* count == 1 excludes S-1-5-5-X-Y (logon) */ return ((usid->sub_authority_count == 1) && (usid->identifier_authority.high_part == const_cpu_to_be16(0)) && (usid->identifier_authority.low_part == const_cpu_to_be32(5)) && (le32_to_cpu(usid->sub_authority[0]) >= 1) && (le32_to_cpu(usid->sub_authority[0]) <= 6)); } /* * Determine the size of a security attribute * whatever the order of fields */ unsigned int ntfs_attr_size(const char *attr) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pdacl; const ACL *psacl; const SID *psid; unsigned int offdacl; unsigned int offsacl; unsigned int offowner; unsigned int offgroup; unsigned int endsid; unsigned int endacl; unsigned int attrsz; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)attr; /* * First check group, which is the last field in all descriptors * we build, and in most descriptors built by Windows */ attrsz = sizeof(SECURITY_DESCRIPTOR_RELATIVE); offgroup = le32_to_cpu(phead->group); if (offgroup >= attrsz) { /* find end of GSID */ psid = (const SID*)&attr[offgroup]; endsid = offgroup + ntfs_sid_size(psid); if (endsid > attrsz) attrsz = endsid; } offowner = le32_to_cpu(phead->owner); if (offowner >= attrsz) { /* find end of USID */ psid = (const SID*)&attr[offowner]; endsid = offowner + ntfs_sid_size(psid); attrsz = endsid; } offsacl = le32_to_cpu(phead->sacl); if (offsacl >= attrsz) { /* find end of SACL */ psacl = (const ACL*)&attr[offsacl]; endacl = offsacl + le16_to_cpu(psacl->size); if (endacl > attrsz) attrsz = endacl; } /* find end of DACL */ offdacl = le32_to_cpu(phead->dacl); if (offdacl >= attrsz) { pdacl = (const ACL*)&attr[offdacl]; endacl = offdacl + le16_to_cpu(pdacl->size); if (endacl > attrsz) attrsz = endacl; } return (attrsz); } /** * ntfs_valid_sid - determine if a SID is valid * @sid: SID for which to determine if it is valid * * Determine if the SID pointed to by @sid is valid. * * Return TRUE if it is valid and FALSE otherwise. */ BOOL ntfs_valid_sid(const SID *sid) { return sid && sid->revision == SID_REVISION && sid->sub_authority_count <= SID_MAX_SUB_AUTHORITIES; } /* * Check whether a SID is acceptable for an implicit * mapping pattern. * It should have been already checked it is a valid user SID. * * The last authority reference has to be >= 1000 (Windows usage) * and <= 0x7fffffff, so that 30 bits from a uid and 30 more bits * from a gid an be inserted with no overflow. */ BOOL ntfs_valid_pattern(const SID *sid) { int cnt; u32 auth; le32 leauth; cnt = sid->sub_authority_count; leauth = sid->sub_authority[cnt-1]; auth = le32_to_cpu(leauth); return ((auth >= 1000) && (auth <= 0x7fffffff)); } /* * Compute the uid or gid associated to a SID * through an implicit mapping * * Returns 0 (root) if it does not match pattern */ static u32 findimplicit(const SID *xsid, const SID *pattern, int parity) { BIGSID defsid; SID *psid; u32 xid; /* uid or gid */ int cnt; u32 carry; le32 leauth; u32 uauth; u32 xlast; u32 rlast; memcpy(&defsid,pattern,ntfs_sid_size(pattern)); psid = (SID*)&defsid; cnt = psid->sub_authority_count; xid = 0; if (xsid->sub_authority_count == cnt) { psid->sub_authority[cnt-1] = xsid->sub_authority[cnt-1]; leauth = xsid->sub_authority[cnt-1]; xlast = le32_to_cpu(leauth); leauth = pattern->sub_authority[cnt-1]; rlast = le32_to_cpu(leauth); if ((xlast > rlast) && !((xlast ^ rlast ^ parity) & 1)) { /* direct check for basic situation */ if (ntfs_same_sid(psid,xsid)) xid = ((xlast - rlast) >> 1) & 0x3fffffff; else { /* * check whether part of mapping had to be * recorded in a higher level authority */ carry = 1; do { leauth = psid->sub_authority[cnt-2]; uauth = le32_to_cpu(leauth) + 1; psid->sub_authority[cnt-2] = cpu_to_le32(uauth); } while (!ntfs_same_sid(psid,xsid) && (++carry < 4)); if (carry < 4) xid = (((xlast - rlast) >> 1) & 0x3fffffff) | (carry << 30); } } } return (xid); } /* * Find usid mapped to a Linux user * Returns NULL if not found */ const SID *ntfs_find_usid(const struct MAPPING* usermapping, uid_t uid, SID *defusid) { const struct MAPPING *p; const SID *sid; le32 leauth; u32 uauth; int cnt; if (!uid) sid = adminsid; else { p = usermapping; while (p && p->xid && ((uid_t)p->xid != uid)) p = p->next; if (p && !p->xid) { /* * default pattern has been reached : * build an implicit SID according to pattern * (the pattern format was checked while reading * the mapping file) */ memcpy(defusid, p->sid, ntfs_sid_size(p->sid)); cnt = defusid->sub_authority_count; leauth = defusid->sub_authority[cnt-1]; uauth = le32_to_cpu(leauth) + 2*(uid & 0x3fffffff); defusid->sub_authority[cnt-1] = cpu_to_le32(uauth); if (uid & 0xc0000000) { leauth = defusid->sub_authority[cnt-2]; uauth = le32_to_cpu(leauth) + ((uid >> 30) & 3); defusid->sub_authority[cnt-2] = cpu_to_le32(uauth); } sid = defusid; } else sid = (p ? p->sid : (const SID*)NULL); } return (sid); } /* * Find Linux group mapped to a gsid * Returns 0 (root) if not found */ const SID *ntfs_find_gsid(const struct MAPPING* groupmapping, gid_t gid, SID *defgsid) { const struct MAPPING *p; const SID *sid; le32 leauth; u32 uauth; int cnt; if (!gid) sid = adminsid; else { p = groupmapping; while (p && p->xid && ((gid_t)p->xid != gid)) p = p->next; if (p && !p->xid) { /* * default pattern has been reached : * build an implicit SID according to pattern * (the pattern format was checked while reading * the mapping file) */ memcpy(defgsid, p->sid, ntfs_sid_size(p->sid)); cnt = defgsid->sub_authority_count; leauth = defgsid->sub_authority[cnt-1]; uauth = le32_to_cpu(leauth) + 2*(gid & 0x3fffffff) + 1; defgsid->sub_authority[cnt-1] = cpu_to_le32(uauth); if (gid & 0xc0000000) { leauth = defgsid->sub_authority[cnt-2]; uauth = le32_to_cpu(leauth) + ((gid >> 30) & 3); defgsid->sub_authority[cnt-2] = cpu_to_le32(uauth); } sid = defgsid; } else sid = (p ? p->sid : (const SID*)NULL); } return (sid); } /* * Find Linux owner mapped to a usid * Returns 0 (root) if not found */ uid_t ntfs_find_user(const struct MAPPING* usermapping, const SID *usid) { uid_t uid; const struct MAPPING *p; p = usermapping; while (p && p->xid && !ntfs_same_sid(usid, p->sid)) p = p->next; if (p && !p->xid) /* * No explicit mapping found, try implicit mapping */ uid = findimplicit(usid,p->sid,0); else uid = (p ? p->xid : 0); return (uid); } /* * Find Linux group mapped to a gsid * Returns 0 (root) if not found */ gid_t ntfs_find_group(const struct MAPPING* groupmapping, const SID * gsid) { gid_t gid; const struct MAPPING *p; p = groupmapping; while (p && p->xid && !ntfs_same_sid(gsid, p->sid)) p = p->next; if (p && !p->xid) /* * No explicit mapping found, try implicit mapping */ gid = findimplicit(gsid,p->sid,1); else gid = (p ? p->xid : 0); return (gid); } /* * Check the validity of the ACEs in a DACL or SACL */ static BOOL valid_acl(const ACL *pacl, unsigned int end) { const ACCESS_ALLOWED_ACE *pace; unsigned int offace; unsigned int acecnt; unsigned int acesz; unsigned int nace; unsigned int wantsz; BOOL ok; ok = TRUE; acecnt = le16_to_cpu(pacl->ace_count); offace = sizeof(ACL); for (nace = 0; (nace < acecnt) && ok; nace++) { /* be sure the beginning is within range */ if ((offace + sizeof(ACCESS_ALLOWED_ACE)) > end) ok = FALSE; else { pace = (const ACCESS_ALLOWED_ACE*) &((const char*)pacl)[offace]; acesz = le16_to_cpu(pace->size); switch (pace->type) { case ACCESS_ALLOWED_ACE_TYPE : case ACCESS_DENIED_ACE_TYPE : wantsz = ntfs_sid_size(&pace->sid) + 8; if (((offace + acesz) > end) || !ntfs_valid_sid(&pace->sid) || (wantsz != acesz)) ok = FALSE; break; case SYSTEM_AUDIT_ACE_TYPE : case ACCESS_ALLOWED_CALLBACK_ACE_TYPE : case ACCESS_DENIED_CALLBACK_ACE_TYPE : case SYSTEM_AUDIT_CALLBACK_ACE_TYPE : case SYSTEM_MANDATORY_LABEL_ACE_TYPE : case SYSTEM_RESOURCE_ATTRIBUTE_ACE_TYPE : case SYSTEM_SCOPED_POLICY_ID_ACE_TYPE : /* Extra data after the SID */ wantsz = ntfs_sid_size(&pace->sid) + 8; if (((offace + acesz) > end) || !ntfs_valid_sid(&pace->sid) || (wantsz > acesz)) ok = FALSE; break; default : /* SID at a different location */ if ((offace + acesz) > end) ok = FALSE; break; } offace += acesz; } } return (ok); } /* * Do sanity checks on security descriptors read from storage * basically, we make sure that every field holds within * allocated storage * Should not be called with a NULL argument * returns TRUE if considered safe * if not, error should be logged by caller */ BOOL ntfs_valid_descr(const char *securattr, unsigned int attrsz) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pdacl; const ACL *psacl; unsigned int offdacl; unsigned int offsacl; unsigned int offowner; unsigned int offgroup; BOOL ok; ok = TRUE; /* * first check overall size if within allocation range * and a DACL is present * and owner and group SID are valid */ phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); offsacl = le32_to_cpu(phead->sacl); offowner = le32_to_cpu(phead->owner); offgroup = le32_to_cpu(phead->group); pdacl = (const ACL*)&securattr[offdacl]; psacl = (const ACL*)&securattr[offsacl]; /* * size check occurs before the above pointers are used * * "DR Watson" standard directory on WinXP has an * old revision and no DACL though SE_DACL_PRESENT is set */ if ((attrsz >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) && (phead->revision == SECURITY_DESCRIPTOR_REVISION) && (offowner >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) && ((offowner + 2) < attrsz) && (offgroup >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) && ((offgroup + 2) < attrsz) && (!offdacl || ((offdacl >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) && (offdacl+sizeof(ACL) <= attrsz))) && (!offsacl || ((offsacl >= sizeof(SECURITY_DESCRIPTOR_RELATIVE)) && (offsacl+sizeof(ACL) <= attrsz))) && !(phead->owner & const_cpu_to_le32(3)) && !(phead->group & const_cpu_to_le32(3)) && !(phead->dacl & const_cpu_to_le32(3)) && !(phead->sacl & const_cpu_to_le32(3)) && (ntfs_attr_size(securattr) <= attrsz) && ntfs_valid_sid((const SID*)&securattr[offowner]) && ntfs_valid_sid((const SID*)&securattr[offgroup]) /* * if there is an ACL, as indicated by offdacl, * require SE_DACL_PRESENT * but "Dr Watson" has SE_DACL_PRESENT though no DACL */ && (!offdacl || ((phead->control & SE_DACL_PRESENT) && ((pdacl->revision == ACL_REVISION) || (pdacl->revision == ACL_REVISION_DS)))) /* same for SACL */ && (!offsacl || ((phead->control & SE_SACL_PRESENT) && ((psacl->revision == ACL_REVISION) || (psacl->revision == ACL_REVISION_DS))))) { /* * Check the DACL and SACL if present */ if ((offdacl && !valid_acl(pdacl,attrsz - offdacl)) || (offsacl && !valid_acl(psacl,attrsz - offsacl))) ok = FALSE; } else ok = FALSE; return (ok); } /* * Copy the inheritable parts of an ACL * * Returns the size of the new ACL * or zero if nothing is inheritable */ int ntfs_inherit_acl(const ACL *oldacl, ACL *newacl, const SID *usid, const SID *gsid, BOOL fordir, le16 inherited) { unsigned int src; unsigned int dst; int oldcnt; int newcnt; unsigned int selection; int nace; int acesz; int usidsz; int gsidsz; BOOL acceptable; const ACCESS_ALLOWED_ACE *poldace; ACCESS_ALLOWED_ACE *pnewace; ACCESS_ALLOWED_ACE *pauthace; ACCESS_ALLOWED_ACE *pownerace; pauthace = (ACCESS_ALLOWED_ACE*)NULL; pownerace = (ACCESS_ALLOWED_ACE*)NULL; usidsz = ntfs_sid_size(usid); gsidsz = ntfs_sid_size(gsid); /* ACL header */ newacl->revision = ACL_REVISION; newacl->alignment1 = 0; newacl->alignment2 = const_cpu_to_le16(0); src = dst = sizeof(ACL); selection = (fordir ? CONTAINER_INHERIT_ACE : OBJECT_INHERIT_ACE); newcnt = 0; oldcnt = le16_to_cpu(oldacl->ace_count); for (nace = 0; nace < oldcnt; nace++) { poldace = (const ACCESS_ALLOWED_ACE*)((const char*)oldacl + src); acesz = le16_to_cpu(poldace->size); src += acesz; /* * Currently only ACE for file or directory access are * processed. More information needed about what to do * for other types (whose SID may be at a different location) */ switch (poldace->type) { case ACCESS_ALLOWED_ACE_TYPE : case ACCESS_DENIED_ACE_TYPE : acceptable = TRUE; break; default : acceptable = FALSE; break; } /* * Extract inheritance for access, including inheritance for * access from an ACE with is both applied and inheritable. * * must not output OBJECT_INHERIT_ACE or CONTAINER_INHERIT_ACE * * According to MSDN : * "For a case in which a container object inherits an ACE * "that is both effective on the container and inheritable * "by its descendants, the container may inherit two ACEs. * "This occurs if the inheritable ACE contains generic * "information." */ if ((poldace->flags & selection) && acceptable && (!fordir || (poldace->flags & NO_PROPAGATE_INHERIT_ACE) || (poldace->mask & (GENERIC_ALL | GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE))) && !ntfs_same_sid(&poldace->sid, ownersid) && !ntfs_same_sid(&poldace->sid, groupsid)) { pnewace = (ACCESS_ALLOWED_ACE*) ((char*)newacl + dst); memcpy(pnewace,poldace,acesz); /* reencode GENERIC_ALL */ if (pnewace->mask & GENERIC_ALL) { pnewace->mask &= ~GENERIC_ALL; if (fordir) pnewace->mask |= OWNER_RIGHTS | DIR_READ | DIR_WRITE | DIR_EXEC; else /* * The last flag is not defined for a file, * however Windows sets it, so do the same */ pnewace->mask |= OWNER_RIGHTS | FILE_READ | FILE_WRITE | FILE_EXEC | const_cpu_to_le32(0x40); } /* reencode GENERIC_READ (+ EXECUTE) */ if (pnewace->mask & GENERIC_READ) { if (fordir) pnewace->mask |= OWNER_RIGHTS | DIR_READ | DIR_EXEC; else pnewace->mask |= OWNER_RIGHTS | FILE_READ | FILE_EXEC; pnewace->mask &= ~(GENERIC_READ | GENERIC_EXECUTE | WRITE_DAC | WRITE_OWNER | DELETE | FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES); } /* reencode GENERIC_WRITE */ if (pnewace->mask & GENERIC_WRITE) { if (fordir) pnewace->mask |= OWNER_RIGHTS | DIR_WRITE; else pnewace->mask |= OWNER_RIGHTS | FILE_WRITE; pnewace->mask &= ~(GENERIC_WRITE | WRITE_DAC | WRITE_OWNER | FILE_DELETE_CHILD); } /* remove inheritance flags */ pnewace->flags &= ~(OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE | INHERIT_ONLY_ACE); /* * Group similar ACE for authenticated users * (should probably be done for other SIDs) */ if ((poldace->type == ACCESS_ALLOWED_ACE_TYPE) && ntfs_same_sid(&poldace->sid, authsid)) { if (pauthace) { pauthace->flags |= pnewace->flags; pauthace->mask |= pnewace->mask; } else { pauthace = pnewace; if (inherited) pnewace->flags |= INHERITED_ACE; dst += acesz; newcnt++; } } else { if (inherited) pnewace->flags |= INHERITED_ACE; dst += acesz; newcnt++; } } /* * Inheritance for access, specific to * creator-owner (and creator-group) */ if ((fordir || !inherited || (poldace->flags & (CONTAINER_INHERIT_ACE | OBJECT_INHERIT_ACE))) && acceptable) { pnewace = (ACCESS_ALLOWED_ACE*) ((char*)newacl + dst); memcpy(pnewace,poldace,acesz); /* * Replace generic creator-owner and * creator-group by owner and group * (but keep for further inheritance) */ if (ntfs_same_sid(&pnewace->sid, ownersid)) { memcpy(&pnewace->sid, usid, usidsz); pnewace->size = cpu_to_le16(usidsz + 8); /* remove inheritance flags */ pnewace->flags &= ~(OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE | INHERIT_ONLY_ACE); if (inherited) pnewace->flags |= INHERITED_ACE; if ((pnewace->type == ACCESS_ALLOWED_ACE_TYPE) && pownerace && !(pnewace->flags & ~pownerace->flags)) { pownerace->mask |= pnewace->mask; } else { dst += usidsz + 8; newcnt++; } } if (ntfs_same_sid(&pnewace->sid, groupsid)) { memcpy(&pnewace->sid, gsid, gsidsz); pnewace->size = cpu_to_le16(gsidsz + 8); /* remove inheritance flags */ pnewace->flags &= ~(OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE | INHERIT_ONLY_ACE); if (inherited) pnewace->flags |= INHERITED_ACE; dst += gsidsz + 8; newcnt++; } } /* * inheritance for further inheritance * * Situations leading to output CONTAINER_INHERIT_ACE * or OBJECT_INHERIT_ACE */ if (fordir && (poldace->flags & (CONTAINER_INHERIT_ACE | OBJECT_INHERIT_ACE))) { pnewace = (ACCESS_ALLOWED_ACE*) ((char*)newacl + dst); memcpy(pnewace,poldace,acesz); if ((poldace->flags & OBJECT_INHERIT_ACE) && !(poldace->flags & (CONTAINER_INHERIT_ACE | NO_PROPAGATE_INHERIT_ACE))) pnewace->flags |= INHERIT_ONLY_ACE; if (acceptable && (poldace->flags & CONTAINER_INHERIT_ACE) && !(poldace->flags & NO_PROPAGATE_INHERIT_ACE) && !ntfs_same_sid(&poldace->sid, ownersid) && !ntfs_same_sid(&poldace->sid, groupsid)) { if ((poldace->mask & (GENERIC_ALL | GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE))) pnewace->flags |= INHERIT_ONLY_ACE; else pnewace->flags &= ~INHERIT_ONLY_ACE; } if (inherited) pnewace->flags |= INHERITED_ACE; /* * Prepare grouping similar ACE for authenticated users */ if ((poldace->type == ACCESS_ALLOWED_ACE_TYPE) && !pauthace && !(pnewace->flags & INHERIT_ONLY_ACE) && ntfs_same_sid(&poldace->sid, authsid)) { pauthace = pnewace; } /* * Prepare grouping similar ACE for owner */ if ((poldace->type == ACCESS_ALLOWED_ACE_TYPE) && !pownerace && !(pnewace->flags & INHERIT_ONLY_ACE) && ntfs_same_sid(&poldace->sid, usid)) { pownerace = pnewace; } dst += acesz; newcnt++; } } /* * Adjust header if something was inherited */ if (dst > sizeof(ACL)) { newacl->ace_count = cpu_to_le16(newcnt); newacl->size = cpu_to_le16(dst); } else dst = 0; return (dst); } #if POSIXACLS /* * Do sanity checks on a Posix descriptor * Should not be called with a NULL argument * returns TRUE if considered safe * if not, error should be logged by caller */ BOOL ntfs_valid_posix(const struct POSIX_SECURITY *pxdesc) { const struct POSIX_ACL *pacl; int i; BOOL ok; u16 tag; u32 id; int perms; struct { u16 previous; u32 previousid; u16 tagsset; mode_t mode; int owners; int groups; int others; } checks[2], *pchk; for (i=0; i<2; i++) { checks[i].mode = 0; checks[i].tagsset = 0; checks[i].owners = 0; checks[i].groups = 0; checks[i].others = 0; checks[i].previous = 0; checks[i].previousid = 0; } ok = TRUE; pacl = &pxdesc->acl; /* * header (strict for now) */ if ((pacl->version != POSIX_VERSION) || (pacl->flags != 0) || (pacl->filler != 0)) ok = FALSE; /* * Reject multiple owner, group or other * but do not require them to be present * Also check the ACEs are in correct order * which implies there is no duplicates */ for (i=0; iacccnt + pxdesc->defcnt; i++) { if (i >= pxdesc->firstdef) pchk = &checks[1]; else pchk = &checks[0]; perms = pacl->ace[i].perms; tag = pacl->ace[i].tag; pchk->tagsset |= tag; id = pacl->ace[i].id; if (perms & ~7) ok = FALSE; if ((tag < pchk->previous) || ((tag == pchk->previous) && (id <= pchk->previousid))) ok = FALSE; pchk->previous = tag; pchk->previousid = id; switch (tag) { case POSIX_ACL_USER_OBJ : if (pchk->owners++) ok = FALSE; if (id != (u32)-1) ok = FALSE; pchk->mode |= perms << 6; break; case POSIX_ACL_GROUP_OBJ : if (pchk->groups++) ok = FALSE; if (id != (u32)-1) ok = FALSE; pchk->mode = (pchk->mode & 07707) | (perms << 3); break; case POSIX_ACL_OTHER : if (pchk->others++) ok = FALSE; if (id != (u32)-1) ok = FALSE; pchk->mode |= perms; break; case POSIX_ACL_USER : case POSIX_ACL_GROUP : if (id == (u32)-1) ok = FALSE; break; case POSIX_ACL_MASK : if (id != (u32)-1) ok = FALSE; pchk->mode = (pchk->mode & 07707) | (perms << 3); break; default : ok = FALSE; break; } } if ((pxdesc->acccnt > 0) && ((checks[0].owners != 1) || (checks[0].groups != 1) || (checks[0].others != 1))) ok = FALSE; /* do not check owner, group or other are present in */ /* the default ACL, Windows does not necessarily set them */ /* descriptor */ if (pxdesc->defcnt && (pxdesc->acccnt > pxdesc->firstdef)) ok = FALSE; if ((pxdesc->acccnt < 0) || (pxdesc->defcnt < 0)) ok = FALSE; /* check mode, unless null or no tag set */ if (pxdesc->mode && checks[0].tagsset && (checks[0].mode != (pxdesc->mode & 0777))) ok = FALSE; /* check tagsset */ if (pxdesc->tagsset != checks[0].tagsset) ok = FALSE; return (ok); } /* * Set standard header data into a Posix ACL * The mode argument should provide the 3 upper bits of target mode */ static mode_t posix_header(struct POSIX_SECURITY *pxdesc, mode_t basemode) { mode_t mode; u16 tagsset; struct POSIX_ACE *pace; int i; mode = basemode & 07000; tagsset = 0; for (i=0; iacccnt; i++) { pace = &pxdesc->acl.ace[i]; tagsset |= pace->tag; switch(pace->tag) { case POSIX_ACL_USER_OBJ : mode |= (pace->perms & 7) << 6; break; case POSIX_ACL_GROUP_OBJ : case POSIX_ACL_MASK : mode = (mode & 07707) | ((pace->perms & 7) << 3); break; case POSIX_ACL_OTHER : mode |= pace->perms & 7; break; default : break; } } pxdesc->tagsset = tagsset; pxdesc->mode = mode; pxdesc->acl.version = POSIX_VERSION; pxdesc->acl.flags = 0; pxdesc->acl.filler = 0; return (mode); } /* * Sort ACEs in a Posix ACL * This is useful for always getting reusable converted ACLs, * it also helps in merging ACEs. * Repeated tag+id are allowed and not merged here. * * Tags should be in ascending sequence and for a repeatable tag * ids should be in ascending sequence. */ void ntfs_sort_posix(struct POSIX_SECURITY *pxdesc) { struct POSIX_ACL *pacl; struct POSIX_ACE ace; int i; int offs; BOOL done; u16 tag; u16 previous; u32 id; u32 previousid; /* * Check sequencing of tag+id in access ACE's */ pacl = &pxdesc->acl; do { done = TRUE; previous = pacl->ace[0].tag; previousid = pacl->ace[0].id; for (i=1; iacccnt; i++) { tag = pacl->ace[i].tag; id = pacl->ace[i].id; if ((tag < previous) || ((tag == previous) && (id < previousid))) { done = FALSE; memcpy(&ace,&pacl->ace[i-1],sizeof(struct POSIX_ACE)); memcpy(&pacl->ace[i-1],&pacl->ace[i],sizeof(struct POSIX_ACE)); memcpy(&pacl->ace[i],&ace,sizeof(struct POSIX_ACE)); } else { previous = tag; previousid = id; } } } while (!done); /* * Same for default ACEs */ do { done = TRUE; if ((pxdesc->defcnt) > 1) { offs = pxdesc->firstdef; previous = pacl->ace[offs].tag; previousid = pacl->ace[offs].id; for (i=offs+1; idefcnt; i++) { tag = pacl->ace[i].tag; id = pacl->ace[i].id; if ((tag < previous) || ((tag == previous) && (id < previousid))) { done = FALSE; memcpy(&ace,&pacl->ace[i-1],sizeof(struct POSIX_ACE)); memcpy(&pacl->ace[i-1],&pacl->ace[i],sizeof(struct POSIX_ACE)); memcpy(&pacl->ace[i],&ace,sizeof(struct POSIX_ACE)); } else { previous = tag; previousid = id; } } } } while (!done); } /* * Merge a new mode into a Posix descriptor * The Posix descriptor is not reallocated, its size is unchanged * * returns 0 if ok */ int ntfs_merge_mode_posix(struct POSIX_SECURITY *pxdesc, mode_t mode) { int i; BOOL maskfound; struct POSIX_ACE *pace; int todo; maskfound = FALSE; todo = POSIX_ACL_USER_OBJ | POSIX_ACL_GROUP_OBJ | POSIX_ACL_OTHER; for (i=pxdesc->acccnt-1; i>=0; i--) { pace = &pxdesc->acl.ace[i]; switch(pace->tag) { case POSIX_ACL_USER_OBJ : pace->perms = (mode >> 6) & 7; todo &= ~POSIX_ACL_USER_OBJ; break; case POSIX_ACL_GROUP_OBJ : if (!maskfound) pace->perms = (mode >> 3) & 7; todo &= ~POSIX_ACL_GROUP_OBJ; break; case POSIX_ACL_MASK : pace->perms = (mode >> 3) & 7; maskfound = TRUE; break; case POSIX_ACL_OTHER : pace->perms = mode & 7; todo &= ~POSIX_ACL_OTHER; break; default : break; } } pxdesc->mode = mode; return (todo ? -1 : 0); } /* * Replace an access or default Posix ACL * The resulting ACL is checked for validity * * Returns a new ACL or NULL if there is a problem */ struct POSIX_SECURITY *ntfs_replace_acl(const struct POSIX_SECURITY *oldpxdesc, const struct POSIX_ACL *newacl, int count, BOOL deflt) { struct POSIX_SECURITY *newpxdesc; size_t newsize; int offset; int oldoffset; int i; if (deflt) newsize = sizeof(struct POSIX_SECURITY) + (oldpxdesc->acccnt + count)*sizeof(struct POSIX_ACE); else newsize = sizeof(struct POSIX_SECURITY) + (oldpxdesc->defcnt + count)*sizeof(struct POSIX_ACE); newpxdesc = (struct POSIX_SECURITY*)malloc(newsize); if (newpxdesc) { if (deflt) { offset = oldpxdesc->acccnt; newpxdesc->acccnt = oldpxdesc->acccnt; newpxdesc->defcnt = count; newpxdesc->firstdef = offset; /* copy access ACEs */ for (i=0; iacccnt; i++) newpxdesc->acl.ace[i] = oldpxdesc->acl.ace[i]; /* copy default ACEs */ for (i=0; iacl.ace[i + offset] = newacl->ace[i]; } else { offset = count; newpxdesc->acccnt = count; newpxdesc->defcnt = oldpxdesc->defcnt; newpxdesc->firstdef = count; /* copy access ACEs */ for (i=0; iacl.ace[i] = newacl->ace[i]; /* copy default ACEs */ oldoffset = oldpxdesc->firstdef; for (i=0; idefcnt; i++) newpxdesc->acl.ace[i + offset] = oldpxdesc->acl.ace[i + oldoffset]; } /* assume special flags unchanged */ posix_header(newpxdesc, oldpxdesc->mode); if (!ntfs_valid_posix(newpxdesc)) { /* do not log, this is an application error */ free(newpxdesc); newpxdesc = (struct POSIX_SECURITY*)NULL; errno = EINVAL; } } else errno = ENOMEM; return (newpxdesc); } /* * Build a basic Posix ACL from a mode and umask, * ignoring inheritance from the parent directory */ struct POSIX_SECURITY *ntfs_build_basic_posix( const struct POSIX_SECURITY *pxdesc __attribute__((unused)), mode_t mode, mode_t mask, BOOL isdir __attribute__((unused))) { struct POSIX_SECURITY *pydesc; struct POSIX_ACE *pyace; pydesc = (struct POSIX_SECURITY*)malloc( sizeof(struct POSIX_SECURITY) + 3*sizeof(struct POSIX_ACE)); if (pydesc) { pyace = &pydesc->acl.ace[0]; pyace->tag = POSIX_ACL_USER_OBJ; pyace->perms = ((mode & ~mask) >> 6) & 7; pyace->id = -1; pyace = &pydesc->acl.ace[1]; pyace->tag = POSIX_ACL_GROUP_OBJ; pyace->perms = ((mode & ~mask) >> 3) & 7; pyace->id = -1; pyace = &pydesc->acl.ace[2]; pyace->tag = POSIX_ACL_OTHER; pyace->perms = (mode & ~mask) & 7; pyace->id = -1; pydesc->mode = mode; pydesc->tagsset = POSIX_ACL_USER_OBJ | POSIX_ACL_GROUP_OBJ | POSIX_ACL_OTHER; pydesc->acccnt = 3; pydesc->defcnt = 0; pydesc->firstdef = 6; pydesc->filler = 0; pydesc->acl.version = POSIX_VERSION; pydesc->acl.flags = 0; pydesc->acl.filler = 0; } else errno = ENOMEM; return (pydesc); } /* * Build an inherited Posix descriptor from parent * descriptor (if any) restricted to creation mode * * Returns the inherited descriptor or NULL if there is a problem */ struct POSIX_SECURITY *ntfs_build_inherited_posix( const struct POSIX_SECURITY *pxdesc, mode_t mode, mode_t mask, BOOL isdir) { struct POSIX_SECURITY *pydesc; struct POSIX_ACE *pyace; int count; int defcnt; int size; int i; s16 tagsset; if (pxdesc && pxdesc->defcnt) { if (isdir) count = 2*pxdesc->defcnt + 3; else count = pxdesc->defcnt + 3; } else count = 3; pydesc = (struct POSIX_SECURITY*)malloc( sizeof(struct POSIX_SECURITY) + count*sizeof(struct POSIX_ACE)); if (pydesc) { /* * Copy inherited tags and adapt perms * Use requested mode, ignoring umask * (not possible with older versions of fuse) */ tagsset = 0; defcnt = (pxdesc ? pxdesc->defcnt : 0); for (i=defcnt-1; i>=0; i--) { pyace = &pydesc->acl.ace[i]; *pyace = pxdesc->acl.ace[pxdesc->firstdef + i]; switch (pyace->tag) { case POSIX_ACL_USER_OBJ : pyace->perms &= (mode >> 6) & 7; break; case POSIX_ACL_GROUP_OBJ : if (!(tagsset & POSIX_ACL_MASK)) pyace->perms &= (mode >> 3) & 7; break; case POSIX_ACL_OTHER : pyace->perms &= mode & 7; break; case POSIX_ACL_MASK : pyace->perms &= (mode >> 3) & 7; break; default : break; } tagsset |= pyace->tag; } pydesc->acccnt = defcnt; /* * If some standard tags were missing, append them from mode * and sort the list * Here we have to use the umask'ed mode */ if (~tagsset & (POSIX_ACL_USER_OBJ | POSIX_ACL_GROUP_OBJ | POSIX_ACL_OTHER)) { i = defcnt; /* owner was missing */ if (!(tagsset & POSIX_ACL_USER_OBJ)) { pyace = &pydesc->acl.ace[i]; pyace->tag = POSIX_ACL_USER_OBJ; pyace->id = -1; pyace->perms = ((mode & ~mask) >> 6) & 7; tagsset |= POSIX_ACL_USER_OBJ; i++; } /* owning group was missing */ if (!(tagsset & POSIX_ACL_GROUP_OBJ)) { pyace = &pydesc->acl.ace[i]; pyace->tag = POSIX_ACL_GROUP_OBJ; pyace->id = -1; pyace->perms = ((mode & ~mask) >> 3) & 7; tagsset |= POSIX_ACL_GROUP_OBJ; i++; } /* other was missing */ if (!(tagsset & POSIX_ACL_OTHER)) { pyace = &pydesc->acl.ace[i]; pyace->tag = POSIX_ACL_OTHER; pyace->id = -1; pyace->perms = mode & ~mask & 7; tagsset |= POSIX_ACL_OTHER; i++; } pydesc->acccnt = i; pydesc->firstdef = i; pydesc->defcnt = 0; ntfs_sort_posix(pydesc); } /* * append as a default ACL if a directory */ pydesc->firstdef = pydesc->acccnt; if (defcnt && isdir) { size = sizeof(struct POSIX_ACE)*defcnt; memcpy(&pydesc->acl.ace[pydesc->firstdef], &pxdesc->acl.ace[pxdesc->firstdef],size); pydesc->defcnt = defcnt; } else { pydesc->defcnt = 0; } /* assume special bits are not inherited */ posix_header(pydesc, mode & 07000); if (!ntfs_valid_posix(pydesc)) { ntfs_log_error("Error building an inherited Posix desc\n"); errno = EIO; free(pydesc); pydesc = (struct POSIX_SECURITY*)NULL; } } else errno = ENOMEM; return (pydesc); } static int merge_lists_posix(struct POSIX_ACE *targetace, const struct POSIX_ACE *firstace, const struct POSIX_ACE *secondace, int firstcnt, int secondcnt) { int k; k = 0; /* * No list is exhausted : * if same tag+id in both list : * ignore ACE from second list * else take the one with smaller tag+id */ while ((firstcnt > 0) && (secondcnt > 0)) if ((firstace->tag == secondace->tag) && (firstace->id == secondace->id)) { secondace++; secondcnt--; } else if ((firstace->tag < secondace->tag) || ((firstace->tag == secondace->tag) && (firstace->id < secondace->id))) { targetace->tag = firstace->tag; targetace->id = firstace->id; targetace->perms = firstace->perms; firstace++; targetace++; firstcnt--; k++; } else { targetace->tag = secondace->tag; targetace->id = secondace->id; targetace->perms = secondace->perms; secondace++; targetace++; secondcnt--; k++; } /* * One list is exhausted, copy the other one */ while (firstcnt > 0) { targetace->tag = firstace->tag; targetace->id = firstace->id; targetace->perms = firstace->perms; firstace++; targetace++; firstcnt--; k++; } while (secondcnt > 0) { targetace->tag = secondace->tag; targetace->id = secondace->id; targetace->perms = secondace->perms; secondace++; targetace++; secondcnt--; k++; } return (k); } /* * Merge two Posix ACLs * The input ACLs have to be adequately sorted * * Returns the merged ACL, which is allocated and has to be freed by caller, * or NULL if failed */ struct POSIX_SECURITY *ntfs_merge_descr_posix(const struct POSIX_SECURITY *first, const struct POSIX_SECURITY *second) { struct POSIX_SECURITY *pxdesc; struct POSIX_ACE *targetace; const struct POSIX_ACE *firstace; const struct POSIX_ACE *secondace; size_t size; int k; size = sizeof(struct POSIX_SECURITY) + (first->acccnt + first->defcnt + second->acccnt + second->defcnt)*sizeof(struct POSIX_ACE); pxdesc = (struct POSIX_SECURITY*)malloc(size); if (pxdesc) { /* * merge access ACEs */ firstace = first->acl.ace; secondace = second->acl.ace; targetace = pxdesc->acl.ace; k = merge_lists_posix(targetace,firstace,secondace, first->acccnt,second->acccnt); pxdesc->acccnt = k; /* * merge default ACEs */ pxdesc->firstdef = k; firstace = &first->acl.ace[first->firstdef]; secondace = &second->acl.ace[second->firstdef]; targetace = &pxdesc->acl.ace[k]; k = merge_lists_posix(targetace,firstace,secondace, first->defcnt,second->defcnt); pxdesc->defcnt = k; /* * build header */ pxdesc->acl.version = POSIX_VERSION; pxdesc->acl.flags = 0; pxdesc->acl.filler = 0; pxdesc->mode = 0; pxdesc->tagsset = 0; } else errno = ENOMEM; return (pxdesc); } struct BUILD_CONTEXT { BOOL isdir; BOOL adminowns; BOOL groupowns; u16 selfuserperms; u16 selfgrpperms; u16 grpperms; u16 othperms; u16 mask; u16 designates; u16 withmask; u16 rootspecial; } ; static BOOL build_user_denials(ACL *pacl, const SID *usid, struct MAPPING* const mapping[], ACE_FLAGS flags, const struct POSIX_ACE *pxace, struct BUILD_CONTEXT *pset) { BIGSID defsid; ACCESS_ALLOWED_ACE *pdace; const SID *sid; int sidsz; int pos; int acecnt; le32 grants; le32 denials; u16 perms; u16 mixperms; u16 tag; BOOL rejected; BOOL rootuser; BOOL avoidmask; rejected = FALSE; tag = pxace->tag; perms = pxace->perms; rootuser = FALSE; pos = le16_to_cpu(pacl->size); acecnt = le16_to_cpu(pacl->ace_count); avoidmask = (pset->mask == (POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X)) && ((pset->designates && pset->withmask) || (!pset->designates && !pset->withmask)); if (tag == POSIX_ACL_USER_OBJ) { sid = usid; sidsz = ntfs_sid_size(sid); grants = OWNER_RIGHTS; } else { if (pxace->id) { sid = ntfs_find_usid(mapping[MAPUSERS], pxace->id, (SID*)&defsid); grants = WORLD_RIGHTS; } else { sid = adminsid; rootuser = TRUE; grants = WORLD_RIGHTS & ~ROOT_OWNER_UNMARK; } if (sid) { sidsz = ntfs_sid_size(sid); /* * Insert denial of complement of mask for * each designated user (except root) * WRITE_OWNER is inserted so that * the mask can be identified */ if (!avoidmask && !rootuser) { denials = WRITE_OWNER; pdace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; if (pset->isdir) { if (!(pset->mask & POSIX_PERM_X)) denials |= DIR_EXEC; if (!(pset->mask & POSIX_PERM_W)) denials |= DIR_WRITE; if (!(pset->mask & POSIX_PERM_R)) denials |= DIR_READ; } else { if (!(pset->mask & POSIX_PERM_X)) denials |= FILE_EXEC; if (!(pset->mask & POSIX_PERM_W)) denials |= FILE_WRITE; if (!(pset->mask & POSIX_PERM_R)) denials |= FILE_READ; } if (rootuser) grants &= ~ROOT_OWNER_UNMARK; pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = flags; pdace->size = cpu_to_le16(sidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, sid, sidsz); pos += sidsz + 8; acecnt++; } } else rejected = TRUE; } if (!rejected) { if (pset->isdir) { if (perms & POSIX_PERM_X) grants |= DIR_EXEC; if (perms & POSIX_PERM_W) grants |= DIR_WRITE; if (perms & POSIX_PERM_R) grants |= DIR_READ; } else { if (perms & POSIX_PERM_X) grants |= FILE_EXEC; if (perms & POSIX_PERM_W) grants |= FILE_WRITE; if (perms & POSIX_PERM_R) grants |= FILE_READ; } /* a possible ACE to deny owner what he/she would */ /* induely get from administrator, group or world */ /* unless owner is administrator or group */ denials = const_cpu_to_le32(0); pdace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; if (!pset->adminowns && !rootuser) { if (!pset->groupowns) { mixperms = pset->grpperms | pset->othperms; if (tag == POSIX_ACL_USER_OBJ) mixperms |= pset->selfuserperms; if (pset->isdir) { if (mixperms & POSIX_PERM_X) denials |= DIR_EXEC; if (mixperms & POSIX_PERM_W) denials |= DIR_WRITE; if (mixperms & POSIX_PERM_R) denials |= DIR_READ; } else { if (mixperms & POSIX_PERM_X) denials |= FILE_EXEC; if (mixperms & POSIX_PERM_W) denials |= FILE_WRITE; if (mixperms & POSIX_PERM_R) denials |= FILE_READ; } } else { mixperms = ~pset->grpperms & pset->othperms; if (tag == POSIX_ACL_USER_OBJ) mixperms |= pset->selfuserperms; if (pset->isdir) { if (mixperms & POSIX_PERM_X) denials |= DIR_EXEC; if (mixperms & POSIX_PERM_W) denials |= DIR_WRITE; if (mixperms & POSIX_PERM_R) denials |= DIR_READ; } else { if (mixperms & POSIX_PERM_X) denials |= FILE_EXEC; if (mixperms & POSIX_PERM_W) denials |= FILE_WRITE; if (mixperms & POSIX_PERM_R) denials |= FILE_READ; } } denials &= ~grants; if (denials) { pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = flags; pdace->size = cpu_to_le16(sidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, sid, sidsz); pos += sidsz + 8; acecnt++; } } } pacl->size = cpu_to_le16(pos); pacl->ace_count = cpu_to_le16(acecnt); return (!rejected); } static BOOL build_user_grants(ACL *pacl, const SID *usid, struct MAPPING* const mapping[], ACE_FLAGS flags, const struct POSIX_ACE *pxace, struct BUILD_CONTEXT *pset) { BIGSID defsid; ACCESS_ALLOWED_ACE *pgace; const SID *sid; int sidsz; int pos; int acecnt; le32 grants; u16 perms; u16 tag; BOOL rejected; BOOL rootuser; rejected = FALSE; tag = pxace->tag; perms = pxace->perms; rootuser = FALSE; pos = le16_to_cpu(pacl->size); acecnt = le16_to_cpu(pacl->ace_count); if (tag == POSIX_ACL_USER_OBJ) { sid = usid; sidsz = ntfs_sid_size(sid); grants = OWNER_RIGHTS; } else { if (pxace->id) { sid = ntfs_find_usid(mapping[MAPUSERS], pxace->id, (SID*)&defsid); if (sid) sidsz = ntfs_sid_size(sid); else rejected = TRUE; grants = WORLD_RIGHTS; } else { sid = adminsid; sidsz = ntfs_sid_size(sid); rootuser = TRUE; grants = WORLD_RIGHTS & ~ROOT_OWNER_UNMARK; } } if (!rejected) { if (pset->isdir) { if (perms & POSIX_PERM_X) grants |= DIR_EXEC; if (perms & POSIX_PERM_W) grants |= DIR_WRITE; if (perms & POSIX_PERM_R) grants |= DIR_READ; } else { if (perms & POSIX_PERM_X) grants |= FILE_EXEC; if (perms & POSIX_PERM_W) grants |= FILE_WRITE; if (perms & POSIX_PERM_R) grants |= FILE_READ; } if (rootuser) grants &= ~ROOT_OWNER_UNMARK; pgace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->size = cpu_to_le16(sidsz + 8); pgace->flags = flags; pgace->mask = grants; memcpy((char*)&pgace->sid, sid, sidsz); pos += sidsz + 8; acecnt = le16_to_cpu(pacl->ace_count) + 1; pacl->ace_count = cpu_to_le16(acecnt); pacl->size = cpu_to_le16(pos); } return (!rejected); } /* a grant ACE for group */ /* unless group-obj has the same rights as world */ /* but present if group is owner or owner is administrator */ /* this ACE will be inserted after denials for group */ static BOOL build_group_denials_grant(ACL *pacl, const SID *gsid, struct MAPPING* const mapping[], ACE_FLAGS flags, const struct POSIX_ACE *pxace, struct BUILD_CONTEXT *pset) { BIGSID defsid; ACCESS_ALLOWED_ACE *pdace; ACCESS_ALLOWED_ACE *pgace; const SID *sid; int sidsz; int pos; int acecnt; le32 grants; le32 denials; u16 perms; u16 mixperms; u16 tag; BOOL avoidmask; BOOL rootgroup; BOOL rejected; rejected = FALSE; tag = pxace->tag; perms = pxace->perms; pos = le16_to_cpu(pacl->size); acecnt = le16_to_cpu(pacl->ace_count); rootgroup = FALSE; avoidmask = (pset->mask == (POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X)) && ((pset->designates && pset->withmask) || (!pset->designates && !pset->withmask)); if (tag == POSIX_ACL_GROUP_OBJ) sid = gsid; else if (pxace->id) sid = ntfs_find_gsid(mapping[MAPGROUPS], pxace->id, (SID*)&defsid); else { sid = adminsid; rootgroup = TRUE; } if (sid) { sidsz = ntfs_sid_size(sid); /* * Insert denial of complement of mask for * each group * WRITE_OWNER is inserted so that * the mask can be identified * Note : this mask may lead on Windows to * deny rights to administrators belonging * to some user group */ if ((!avoidmask && !rootgroup) || (pset->rootspecial && (tag == POSIX_ACL_GROUP_OBJ))) { denials = WRITE_OWNER; pdace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; if (pset->isdir) { if (!(pset->mask & POSIX_PERM_X)) denials |= DIR_EXEC; if (!(pset->mask & POSIX_PERM_W)) denials |= DIR_WRITE; if (!(pset->mask & POSIX_PERM_R)) denials |= DIR_READ; } else { if (!(pset->mask & POSIX_PERM_X)) denials |= FILE_EXEC; if (!(pset->mask & POSIX_PERM_W)) denials |= FILE_WRITE; if (!(pset->mask & POSIX_PERM_R)) denials |= FILE_READ; } pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = flags; pdace->size = cpu_to_le16(sidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, sid, sidsz); pos += sidsz + 8; acecnt++; } } else rejected = TRUE; if (!rejected && (pset->adminowns || pset->groupowns || avoidmask || rootgroup || (perms != pset->othperms))) { grants = WORLD_RIGHTS; if (rootgroup) grants &= ~ROOT_GROUP_UNMARK; if (pset->isdir) { if (perms & POSIX_PERM_X) grants |= DIR_EXEC; if (perms & POSIX_PERM_W) grants |= DIR_WRITE; if (perms & POSIX_PERM_R) grants |= DIR_READ; } else { if (perms & POSIX_PERM_X) grants |= FILE_EXEC; if (perms & POSIX_PERM_W) grants |= FILE_WRITE; if (perms & POSIX_PERM_R) grants |= FILE_READ; } /* a possible ACE to deny group what it would get from world */ /* or administrator, unless owner is administrator or group */ denials = const_cpu_to_le32(0); pdace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; if (!pset->adminowns && !pset->groupowns && !rootgroup) { mixperms = pset->othperms; if (tag == POSIX_ACL_GROUP_OBJ) mixperms |= pset->selfgrpperms; if (pset->isdir) { if (mixperms & POSIX_PERM_X) denials |= DIR_EXEC; if (mixperms & POSIX_PERM_W) denials |= DIR_WRITE; if (mixperms & POSIX_PERM_R) denials |= DIR_READ; } else { if (mixperms & POSIX_PERM_X) denials |= FILE_EXEC; if (mixperms & POSIX_PERM_W) denials |= FILE_WRITE; if (mixperms & POSIX_PERM_R) denials |= FILE_READ; } denials &= ~(grants | OWNER_RIGHTS); if (denials) { pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = flags; pdace->size = cpu_to_le16(sidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, sid, sidsz); pos += sidsz + 8; acecnt++; } } /* now insert grants to group if more than world */ if (pset->adminowns || pset->groupowns || (avoidmask && (pset->designates || pset->withmask)) || (perms & ~pset->othperms) || (pset->rootspecial && (tag == POSIX_ACL_GROUP_OBJ)) || (tag == POSIX_ACL_GROUP)) { if (rootgroup) grants &= ~ROOT_GROUP_UNMARK; pgace = (ACCESS_DENIED_ACE*)&((char*)pacl)[pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = flags; pgace->size = cpu_to_le16(sidsz + 8); pgace->mask = grants; memcpy((char*)&pgace->sid, sid, sidsz); pos += sidsz + 8; acecnt++; } } pacl->size = cpu_to_le16(pos); pacl->ace_count = cpu_to_le16(acecnt); return (!rejected); } /* * Build an ACL composed of several ACE's * returns size of ACL or zero if failed * * Three schemes are defined : * * 1) if root is neither owner nor group up to 7 ACE's are set up : * - denials to owner (preventing grants to world or group to apply) * + mask denials to designated user (unless mask allows all) * + denials to designated user * - grants to owner (always present - first grant) * + grants to designated user * + mask denial to group (unless mask allows all) * - denials to group (preventing grants to world to apply) * - grants to group (unless group has no more than world rights) * + mask denials to designated group (unless mask allows all) * + grants to designated group * + denials to designated group * - grants to world (unless none) * - full privileges to administrator, always present * - full privileges to system, always present * * The same scheme is applied for Posix ACLs, with the mask represented * as denials prepended to grants for designated users and groups * * This is inspired by an Internet Draft from Marius Aamodt Eriksen * for mapping NFSv4 ACLs to Posix ACLs (draft-ietf-nfsv4-acl-mapping-00.txt) * More recent versions of the draft (draft-ietf-nfsv4-acl-mapping-05.txt) * are not followed, as they ignore the Posix mask and lead to * loss of compatibility with Linux implementations on other fs. * * Note that denials to group are located after grants to owner. * This only occurs in the unfrequent situation where world * has more rights than group and cannot be avoided if owner and other * have some common right which is denied to group (eg for mode 745 * executing has to be denied to group, but not to owner or world). * This rare situation is processed by Windows correctly, but * Windows utilities may want to change the order, with a * consequence of applying the group denials to the Windows owner. * The interpretation on Linux is not affected by the order change. * * 2) if root is either owner or group, two problems arise : * - granting full rights to administrator (as needed to transpose * to Windows rights bypassing granting to root) would imply * Linux permissions to always be seen as rwx, no matter the chmod * - there is no different SID to separate an administrator owner * from an administrator group. Hence Linux permissions for owner * would always be similar to permissions to group. * * as a work-around, up to 5 ACE's are set up if owner or group : * - grants to owner, always present at first position * - grants to group, always present * - grants to world, unless none * - full privileges to administrator, always present * - full privileges to system, always present * * On Windows, these ACE's are processed normally, though they * are redundant (owner, group and administrator are the same, * as a consequence any denials would damage administrator rights) * but on Linux, privileges to administrator are ignored (they * are not needed as root has always full privileges), and * neither grants to group are applied to owner, nor grants to * world are applied to owner or group. * * 3) finally a similar situation arises when group is owner (they * have the same SID), but is not root. * In this situation up to 6 ACE's are set up : * * - denials to owner (preventing grants to world to apply) * - grants to owner (always present) * - grants to group (unless groups has same rights as world) * - grants to world (unless none) * - full privileges to administrator, always present * - full privileges to system, always present * * On Windows, these ACE's are processed normally, though they * are redundant (as owner and group are the same), but this has * no impact on administrator rights * * Special flags (S_ISVTX, S_ISGID, S_ISUID) : * an extra null ACE is inserted to hold these flags, using * the same conventions as cygwin. * */ static int buildacls_posix(struct MAPPING* const mapping[], char *secattr, int offs, const struct POSIX_SECURITY *pxdesc, int isdir, const SID *usid, const SID *gsid) { struct BUILD_CONTEXT aceset[2], *pset; BOOL adminowns; BOOL groupowns; ACL *pacl; ACCESS_ALLOWED_ACE *pgace; ACCESS_ALLOWED_ACE *pdace; const struct POSIX_ACE *pxace; BOOL ok; mode_t mode; u16 tag; u16 perms; ACE_FLAGS flags; int pos; int i; int k; BIGSID defsid; const SID *sid; int acecnt; int usidsz; int wsidsz; int asidsz; int ssidsz; int nsidsz; le32 grants; usidsz = ntfs_sid_size(usid); wsidsz = ntfs_sid_size(worldsid); asidsz = ntfs_sid_size(adminsid); ssidsz = ntfs_sid_size(systemsid); mode = pxdesc->mode; /* adminowns and groupowns are used for both lists */ adminowns = ntfs_same_sid(usid, adminsid) || ntfs_same_sid(gsid, adminsid); groupowns = !adminowns && ntfs_same_sid(usid, gsid); ok = TRUE; /* ACL header */ pacl = (ACL*)&secattr[offs]; pacl->revision = ACL_REVISION; pacl->alignment1 = 0; pacl->size = cpu_to_le16(sizeof(ACL) + usidsz + 8); pacl->ace_count = const_cpu_to_le16(0); pacl->alignment2 = const_cpu_to_le16(0); /* * Determine what is allowed to some group or world * to prevent designated users or other groups to get * rights from groups or world * Do the same if owner and group appear as designated * user or group * Also get global mask */ for (k=0; k<2; k++) { pset = &aceset[k]; pset->selfuserperms = 0; pset->selfgrpperms = 0; pset->grpperms = 0; pset->othperms = 0; pset->mask = (POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X); pset->designates = 0; pset->withmask = 0; pset->rootspecial = 0; pset->adminowns = adminowns; pset->groupowns = groupowns; pset->isdir = isdir; } for (i=pxdesc->acccnt+pxdesc->defcnt-1; i>=0; i--) { if (i >= pxdesc->acccnt) { pset = &aceset[1]; pxace = &pxdesc->acl.ace[i + pxdesc->firstdef - pxdesc->acccnt]; } else { pset = &aceset[0]; pxace = &pxdesc->acl.ace[i]; } switch (pxace->tag) { case POSIX_ACL_USER : pset->designates++; if (pxace->id) { sid = ntfs_find_usid(mapping[MAPUSERS], pxace->id, (SID*)&defsid); if (sid && ntfs_same_sid(sid,usid)) pset->selfuserperms |= pxace->perms; } else /* root as designated user is processed apart */ pset->rootspecial = TRUE; break; case POSIX_ACL_GROUP : pset->designates++; if (pxace->id) { sid = ntfs_find_gsid(mapping[MAPUSERS], pxace->id, (SID*)&defsid); if (sid && ntfs_same_sid(sid,gsid)) pset->selfgrpperms |= pxace->perms; } else /* root as designated group is processed apart */ pset->rootspecial = TRUE; /* fall through */ case POSIX_ACL_GROUP_OBJ : pset->grpperms |= pxace->perms; break; case POSIX_ACL_OTHER : pset->othperms = pxace->perms; break; case POSIX_ACL_MASK : pset->withmask++; pset->mask = pxace->perms; default : break; } } if (pxdesc->defcnt && (pxdesc->firstdef != pxdesc->acccnt)) { ntfs_log_error("** error : access and default not consecutive\n"); return (0); } /* * First insert all denials for owner and each * designated user (with mask if needed) */ pacl->ace_count = const_cpu_to_le16(0); pacl->size = const_cpu_to_le16(sizeof(ACL)); for (i=0; (i<(pxdesc->acccnt + pxdesc->defcnt)) && ok; i++) { if (i >= pxdesc->acccnt) { flags = INHERIT_ONLY_ACE | OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE; pset = &aceset[1]; pxace = &pxdesc->acl.ace[i + pxdesc->firstdef - pxdesc->acccnt]; } else { if (pxdesc->defcnt) flags = NO_PROPAGATE_INHERIT_ACE; else flags = (isdir ? DIR_INHERITANCE : FILE_INHERITANCE); pset = &aceset[0]; pxace = &pxdesc->acl.ace[i]; } tag = pxace->tag; perms = pxace->perms; switch (tag) { /* insert denial ACEs for each owner or allowed user */ case POSIX_ACL_USER : case POSIX_ACL_USER_OBJ : ok = build_user_denials(pacl, usid, mapping, flags, pxace, pset); break; default : break; } } /* * for directories, insert a world execution denial * inherited to plain files. * This is to prevent Windows from granting execution * of files through inheritance from parent directory */ if (isdir && ok) { pos = le16_to_cpu(pacl->size); pdace = (ACCESS_DENIED_ACE*) &secattr[offs + pos]; pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = INHERIT_ONLY_ACE | OBJECT_INHERIT_ACE; pdace->size = cpu_to_le16(wsidsz + 8); pdace->mask = FILE_EXEC; memcpy((char*)&pdace->sid, worldsid, wsidsz); pos += wsidsz + 8; acecnt = le16_to_cpu(pacl->ace_count) + 1; pacl->ace_count = cpu_to_le16(acecnt); pacl->size = cpu_to_le16(pos); } /* * now insert (if needed) * - grants to owner and designated users * - mask and denials for all groups * - grants to other */ for (i=0; (i<(pxdesc->acccnt + pxdesc->defcnt)) && ok; i++) { if (i >= pxdesc->acccnt) { flags = INHERIT_ONLY_ACE | OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE; pset = &aceset[1]; pxace = &pxdesc->acl.ace[i + pxdesc->firstdef - pxdesc->acccnt]; } else { if (pxdesc->defcnt) flags = NO_PROPAGATE_INHERIT_ACE; else flags = (isdir ? DIR_INHERITANCE : FILE_INHERITANCE); pset = &aceset[0]; pxace = &pxdesc->acl.ace[i]; } tag = pxace->tag; perms = pxace->perms; switch (tag) { /* ACE for each owner or allowed user */ case POSIX_ACL_USER : case POSIX_ACL_USER_OBJ : ok = build_user_grants(pacl,usid, mapping,flags,pxace,pset); break; case POSIX_ACL_GROUP_OBJ : /* denials and grants for group when needed */ if (pset->groupowns && !pset->adminowns && (pset->grpperms == pset->othperms) && !pset->designates && !pset->withmask) { ok = TRUE; } else { ok = build_group_denials_grant(pacl,gsid, mapping,flags,pxace,pset); } break; case POSIX_ACL_GROUP : /* denials and grants for designated groups */ ok = build_group_denials_grant(pacl,gsid, mapping,flags,pxace,pset); break; case POSIX_ACL_OTHER : /* grants for other users */ pos = le16_to_cpu(pacl->size); pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; grants = WORLD_RIGHTS; if (isdir) { if (perms & POSIX_PERM_X) grants |= DIR_EXEC; if (perms & POSIX_PERM_W) grants |= DIR_WRITE; if (perms & POSIX_PERM_R) grants |= DIR_READ; } else { if (perms & POSIX_PERM_X) grants |= FILE_EXEC; if (perms & POSIX_PERM_W) grants |= FILE_WRITE; if (perms & POSIX_PERM_R) grants |= FILE_READ; } pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = flags; pgace->size = cpu_to_le16(wsidsz + 8); pgace->mask = grants; memcpy((char*)&pgace->sid, worldsid, wsidsz); pos += wsidsz + 8; acecnt = le16_to_cpu(pacl->ace_count) + 1; pacl->ace_count = cpu_to_le16(acecnt); pacl->size = cpu_to_le16(pos); break; } } if (!ok) { errno = EINVAL; pos = 0; } else { /* an ACE for administrators */ /* always full access */ pos = le16_to_cpu(pacl->size); acecnt = le16_to_cpu(pacl->ace_count); if (isdir) flags = OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE; else flags = NO_PROPAGATE_INHERIT_ACE; pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = flags; pgace->size = cpu_to_le16(asidsz + 8); grants = OWNER_RIGHTS | FILE_READ | FILE_WRITE | FILE_EXEC; pgace->mask = grants; memcpy((char*)&pgace->sid, adminsid, asidsz); pos += asidsz + 8; acecnt++; /* an ACE for system (needed ?) */ /* always full access */ pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = flags; pgace->size = cpu_to_le16(ssidsz + 8); grants = OWNER_RIGHTS | FILE_READ | FILE_WRITE | FILE_EXEC; pgace->mask = grants; memcpy((char*)&pgace->sid, systemsid, ssidsz); pos += ssidsz + 8; acecnt++; /* a null ACE to hold special flags */ /* using the same representation as cygwin */ if (mode & (S_ISVTX | S_ISGID | S_ISUID)) { nsidsz = ntfs_sid_size(nullsid); pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = NO_PROPAGATE_INHERIT_ACE; pgace->size = cpu_to_le16(nsidsz + 8); grants = const_cpu_to_le32(0); if (mode & S_ISUID) grants |= FILE_APPEND_DATA; if (mode & S_ISGID) grants |= FILE_WRITE_DATA; if (mode & S_ISVTX) grants |= FILE_READ_DATA; pgace->mask = grants; memcpy((char*)&pgace->sid, nullsid, nsidsz); pos += nsidsz + 8; acecnt++; } /* fix ACL header */ pacl->size = cpu_to_le16(pos); pacl->ace_count = cpu_to_le16(acecnt); } return (ok ? pos : 0); } #endif /* POSIXACLS */ static int buildacls(char *secattr, int offs, mode_t mode, int isdir, const SID * usid, const SID * gsid) { ACL *pacl; ACCESS_ALLOWED_ACE *pgace; ACCESS_ALLOWED_ACE *pdace; BOOL adminowns; BOOL groupowns; ACE_FLAGS gflags; int pos; int acecnt; int usidsz; int gsidsz; int wsidsz; int asidsz; int ssidsz; int nsidsz; le32 grants; le32 denials; usidsz = ntfs_sid_size(usid); gsidsz = ntfs_sid_size(gsid); wsidsz = ntfs_sid_size(worldsid); asidsz = ntfs_sid_size(adminsid); ssidsz = ntfs_sid_size(systemsid); adminowns = ntfs_same_sid(usid, adminsid) || ntfs_same_sid(gsid, adminsid); groupowns = !adminowns && ntfs_same_sid(usid, gsid); /* ACL header */ pacl = (ACL*)&secattr[offs]; pacl->revision = ACL_REVISION; pacl->alignment1 = 0; pacl->size = cpu_to_le16(sizeof(ACL) + usidsz + 8); pacl->ace_count = const_cpu_to_le16(1); pacl->alignment2 = const_cpu_to_le16(0); pos = sizeof(ACL); acecnt = 0; /* compute a grant ACE for owner */ /* this ACE will be inserted after denial for owner */ grants = OWNER_RIGHTS; if (isdir) { gflags = DIR_INHERITANCE; if (mode & S_IXUSR) grants |= DIR_EXEC; if (mode & S_IWUSR) grants |= DIR_WRITE; if (mode & S_IRUSR) grants |= DIR_READ; } else { gflags = FILE_INHERITANCE; if (mode & S_IXUSR) grants |= FILE_EXEC; if (mode & S_IWUSR) grants |= FILE_WRITE; if (mode & S_IRUSR) grants |= FILE_READ; } /* a possible ACE to deny owner what he/she would */ /* induely get from administrator, group or world */ /* unless owner is administrator or group */ denials = const_cpu_to_le32(0); pdace = (ACCESS_DENIED_ACE*) &secattr[offs + pos]; if (!adminowns) { if (!groupowns) { if (isdir) { pdace->flags = DIR_INHERITANCE; if (mode & (S_IXGRP | S_IXOTH)) denials |= DIR_EXEC; if (mode & (S_IWGRP | S_IWOTH)) denials |= DIR_WRITE; if (mode & (S_IRGRP | S_IROTH)) denials |= DIR_READ; } else { pdace->flags = FILE_INHERITANCE; if (mode & (S_IXGRP | S_IXOTH)) denials |= FILE_EXEC; if (mode & (S_IWGRP | S_IWOTH)) denials |= FILE_WRITE; if (mode & (S_IRGRP | S_IROTH)) denials |= FILE_READ; } } else { if (isdir) { pdace->flags = DIR_INHERITANCE; if ((mode & S_IXOTH) && !(mode & S_IXGRP)) denials |= DIR_EXEC; if ((mode & S_IWOTH) && !(mode & S_IWGRP)) denials |= DIR_WRITE; if ((mode & S_IROTH) && !(mode & S_IRGRP)) denials |= DIR_READ; } else { pdace->flags = FILE_INHERITANCE; if ((mode & S_IXOTH) && !(mode & S_IXGRP)) denials |= FILE_EXEC; if ((mode & S_IWOTH) && !(mode & S_IWGRP)) denials |= FILE_WRITE; if ((mode & S_IROTH) && !(mode & S_IRGRP)) denials |= FILE_READ; } } denials &= ~grants; if (denials) { pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->size = cpu_to_le16(usidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, usid, usidsz); pos += usidsz + 8; acecnt++; } } /* * for directories, a world execution denial * inherited to plain files */ if (isdir) { pdace = (ACCESS_DENIED_ACE*) &secattr[offs + pos]; pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->flags = INHERIT_ONLY_ACE | OBJECT_INHERIT_ACE; pdace->size = cpu_to_le16(wsidsz + 8); pdace->mask = FILE_EXEC; memcpy((char*)&pdace->sid, worldsid, wsidsz); pos += wsidsz + 8; acecnt++; } /* now insert grants to owner */ pgace = (ACCESS_ALLOWED_ACE*) &secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->size = cpu_to_le16(usidsz + 8); pgace->flags = gflags; pgace->mask = grants; memcpy((char*)&pgace->sid, usid, usidsz); pos += usidsz + 8; acecnt++; /* a grant ACE for group */ /* unless group has the same rights as world */ /* but present if group is owner or owner is administrator */ /* this ACE will be inserted after denials for group */ if (adminowns || (((mode >> 3) ^ mode) & 7)) { grants = WORLD_RIGHTS; if (isdir) { gflags = DIR_INHERITANCE; if (mode & S_IXGRP) grants |= DIR_EXEC; if (mode & S_IWGRP) grants |= DIR_WRITE; if (mode & S_IRGRP) grants |= DIR_READ; } else { gflags = FILE_INHERITANCE; if (mode & S_IXGRP) grants |= FILE_EXEC; if (mode & S_IWGRP) grants |= FILE_WRITE; if (mode & S_IRGRP) grants |= FILE_READ; } /* a possible ACE to deny group what it would get from world */ /* or administrator, unless owner is administrator or group */ denials = const_cpu_to_le32(0); pdace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; if (!adminowns && !groupowns) { if (isdir) { pdace->flags = DIR_INHERITANCE; if (mode & S_IXOTH) denials |= DIR_EXEC; if (mode & S_IWOTH) denials |= DIR_WRITE; if (mode & S_IROTH) denials |= DIR_READ; } else { pdace->flags = FILE_INHERITANCE; if (mode & S_IXOTH) denials |= FILE_EXEC; if (mode & S_IWOTH) denials |= FILE_WRITE; if (mode & S_IROTH) denials |= FILE_READ; } denials &= ~(grants | OWNER_RIGHTS); if (denials) { pdace->type = ACCESS_DENIED_ACE_TYPE; pdace->size = cpu_to_le16(gsidsz + 8); pdace->mask = denials; memcpy((char*)&pdace->sid, gsid, gsidsz); pos += gsidsz + 8; acecnt++; } } if (adminowns || groupowns || ((mode >> 3) & ~mode & 7)) { /* now insert grants to group */ /* if more rights than other */ pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = gflags; pgace->size = cpu_to_le16(gsidsz + 8); pgace->mask = grants; memcpy((char*)&pgace->sid, gsid, gsidsz); pos += gsidsz + 8; acecnt++; } } /* an ACE for world users */ pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; grants = WORLD_RIGHTS; if (isdir) { pgace->flags = DIR_INHERITANCE; if (mode & S_IXOTH) grants |= DIR_EXEC; if (mode & S_IWOTH) grants |= DIR_WRITE; if (mode & S_IROTH) grants |= DIR_READ; } else { pgace->flags = FILE_INHERITANCE; if (mode & S_IXOTH) grants |= FILE_EXEC; if (mode & S_IWOTH) grants |= FILE_WRITE; if (mode & S_IROTH) grants |= FILE_READ; } pgace->size = cpu_to_le16(wsidsz + 8); pgace->mask = grants; memcpy((char*)&pgace->sid, worldsid, wsidsz); pos += wsidsz + 8; acecnt++; /* an ACE for administrators */ /* always full access */ pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; if (isdir) pgace->flags = DIR_INHERITANCE; else pgace->flags = FILE_INHERITANCE; pgace->size = cpu_to_le16(asidsz + 8); grants = OWNER_RIGHTS | FILE_READ | FILE_WRITE | FILE_EXEC; pgace->mask = grants; memcpy((char*)&pgace->sid, adminsid, asidsz); pos += asidsz + 8; acecnt++; /* an ACE for system (needed ?) */ /* always full access */ pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; if (isdir) pgace->flags = DIR_INHERITANCE; else pgace->flags = FILE_INHERITANCE; pgace->size = cpu_to_le16(ssidsz + 8); grants = OWNER_RIGHTS | FILE_READ | FILE_WRITE | FILE_EXEC; pgace->mask = grants; memcpy((char*)&pgace->sid, systemsid, ssidsz); pos += ssidsz + 8; acecnt++; /* a null ACE to hold special flags */ /* using the same representation as cygwin */ if (mode & (S_ISVTX | S_ISGID | S_ISUID)) { nsidsz = ntfs_sid_size(nullsid); pgace = (ACCESS_ALLOWED_ACE*)&secattr[offs + pos]; pgace->type = ACCESS_ALLOWED_ACE_TYPE; pgace->flags = NO_PROPAGATE_INHERIT_ACE; pgace->size = cpu_to_le16(nsidsz + 8); grants = const_cpu_to_le32(0); if (mode & S_ISUID) grants |= FILE_APPEND_DATA; if (mode & S_ISGID) grants |= FILE_WRITE_DATA; if (mode & S_ISVTX) grants |= FILE_READ_DATA; pgace->mask = grants; memcpy((char*)&pgace->sid, nullsid, nsidsz); pos += nsidsz + 8; acecnt++; } /* fix ACL header */ pacl->size = cpu_to_le16(pos); pacl->ace_count = cpu_to_le16(acecnt); return (pos); } #if POSIXACLS /* * Build a full security descriptor from a Posix ACL * returns descriptor in allocated memory, must free() after use */ char *ntfs_build_descr_posix(struct MAPPING* const mapping[], struct POSIX_SECURITY *pxdesc, int isdir, const SID *usid, const SID *gsid) { int newattrsz; SECURITY_DESCRIPTOR_RELATIVE *pnhead; char *newattr; int aclsz; int usidsz; int gsidsz; int wsidsz; int asidsz; int ssidsz; int k; usidsz = ntfs_sid_size(usid); gsidsz = ntfs_sid_size(gsid); wsidsz = ntfs_sid_size(worldsid); asidsz = ntfs_sid_size(adminsid); ssidsz = ntfs_sid_size(systemsid); /* allocate enough space for the new security attribute */ newattrsz = sizeof(SECURITY_DESCRIPTOR_RELATIVE) /* header */ + usidsz + gsidsz /* usid and gsid */ + sizeof(ACL) /* acl header */ + 2*(8 + usidsz) /* two possible ACE for user */ + 3*(8 + gsidsz) /* three possible ACE for group and mask */ + 8 + wsidsz /* one ACE for world */ + 8 + asidsz /* one ACE for admin */ + 8 + ssidsz; /* one ACE for system */ if (isdir) /* a world denial for directories */ newattrsz += 8 + wsidsz; if (pxdesc->mode & 07000) /* a NULL ACE for special modes */ newattrsz += 8 + ntfs_sid_size(nullsid); /* account for non-owning users and groups */ for (k=0; kacccnt; k++) { if ((pxdesc->acl.ace[k].tag == POSIX_ACL_USER) || (pxdesc->acl.ace[k].tag == POSIX_ACL_GROUP)) newattrsz += 3*MAX_SID_SIZE; } /* account for default ACE's */ newattrsz += 2*MAX_SID_SIZE*pxdesc->defcnt; newattr = (char*)ntfs_malloc(newattrsz); if (newattr) { /* build the main header part */ pnhead = (SECURITY_DESCRIPTOR_RELATIVE*)newattr; pnhead->revision = SECURITY_DESCRIPTOR_REVISION; pnhead->alignment = 0; /* * The flag SE_DACL_PROTECTED prevents the ACL * to be changed in an inheritance after creation */ pnhead->control = SE_DACL_PRESENT | SE_DACL_PROTECTED | SE_SELF_RELATIVE; /* * Windows prefers ACL first, do the same to * get the same hash value and avoid duplication */ /* build permissions */ aclsz = buildacls_posix(mapping,newattr, sizeof(SECURITY_DESCRIPTOR_RELATIVE), pxdesc, isdir, usid, gsid); if (aclsz && ((int)(sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz + gsidsz) <= newattrsz)) { /* append usid and gsid */ memcpy(&newattr[sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz], usid, usidsz); memcpy(&newattr[sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz], gsid, gsidsz); /* positions of ACL, USID and GSID into header */ pnhead->owner = cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz); pnhead->group = cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz); pnhead->sacl = const_cpu_to_le32(0); pnhead->dacl = const_cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE)); } else { /* ACL failure (errno set) or overflow */ free(newattr); newattr = (char*)NULL; if (aclsz) { /* hope error was detected before overflowing */ ntfs_log_error("Security descriptor is longer than expected\n"); errno = EIO; } } } else errno = ENOMEM; return (newattr); } #endif /* POSIXACLS */ /* * Build a full security descriptor * returns descriptor in allocated memory, must free() after use */ char *ntfs_build_descr(mode_t mode, int isdir, const SID * usid, const SID * gsid) { int newattrsz; SECURITY_DESCRIPTOR_RELATIVE *pnhead; char *newattr; int aclsz; int usidsz; int gsidsz; int wsidsz; int asidsz; int ssidsz; usidsz = ntfs_sid_size(usid); gsidsz = ntfs_sid_size(gsid); wsidsz = ntfs_sid_size(worldsid); asidsz = ntfs_sid_size(adminsid); ssidsz = ntfs_sid_size(systemsid); /* allocate enough space for the new security attribute */ newattrsz = sizeof(SECURITY_DESCRIPTOR_RELATIVE) /* header */ + usidsz + gsidsz /* usid and gsid */ + sizeof(ACL) /* acl header */ + 2*(8 + usidsz) /* two possible ACE for user */ + 2*(8 + gsidsz) /* two possible ACE for group */ + 8 + wsidsz /* one ACE for world */ + 8 + asidsz /* one ACE for admin */ + 8 + ssidsz; /* one ACE for system */ if (isdir) /* a world denial for directories */ newattrsz += 8 + wsidsz; if (mode & 07000) /* a NULL ACE for special modes */ newattrsz += 8 + ntfs_sid_size(nullsid); newattr = (char*)ntfs_malloc(newattrsz); if (newattr) { /* build the main header part */ pnhead = (SECURITY_DESCRIPTOR_RELATIVE*) newattr; pnhead->revision = SECURITY_DESCRIPTOR_REVISION; pnhead->alignment = 0; /* * The flag SE_DACL_PROTECTED prevents the ACL * to be changed in an inheritance after creation */ pnhead->control = SE_DACL_PRESENT | SE_DACL_PROTECTED | SE_SELF_RELATIVE; /* * Windows prefers ACL first, do the same to * get the same hash value and avoid duplication */ /* build permissions */ aclsz = buildacls(newattr, sizeof(SECURITY_DESCRIPTOR_RELATIVE), mode, isdir, usid, gsid); if (((int)sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz + gsidsz) <= newattrsz) { /* append usid and gsid */ memcpy(&newattr[sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz], usid, usidsz); memcpy(&newattr[sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz], gsid, gsidsz); /* positions of ACL, USID and GSID into header */ pnhead->owner = cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz); pnhead->group = cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE) + aclsz + usidsz); pnhead->sacl = const_cpu_to_le32(0); pnhead->dacl = const_cpu_to_le32(sizeof(SECURITY_DESCRIPTOR_RELATIVE)); } else { /* hope error was detected before overflowing */ free(newattr); newattr = (char*)NULL; ntfs_log_error("Security descriptor is longer than expected\n"); errno = EIO; } } else errno = ENOMEM; return (newattr); } /* * Create a mode_t permission set * from owner, group and world grants as represented in ACEs */ static int merge_permissions(BOOL isdir, le32 owner, le32 group, le32 world, le32 special) { int perm; perm = 0; /* build owner permission */ if (owner) { if (isdir) { /* exec if any of list, traverse */ if (owner & DIR_GEXEC) perm |= S_IXUSR; /* write if any of addfile, adddir, delchild */ if (owner & DIR_GWRITE) perm |= S_IWUSR; /* read if any of list */ if (owner & DIR_GREAD) perm |= S_IRUSR; } else { /* exec if execute or generic execute */ if (owner & FILE_GEXEC) perm |= S_IXUSR; /* write if any of writedata or generic write */ if (owner & FILE_GWRITE) perm |= S_IWUSR; /* read if any of readdata or generic read */ if (owner & FILE_GREAD) perm |= S_IRUSR; } } /* build group permission */ if (group) { if (isdir) { /* exec if any of list, traverse */ if (group & DIR_GEXEC) perm |= S_IXGRP; /* write if any of addfile, adddir, delchild */ if (group & DIR_GWRITE) perm |= S_IWGRP; /* read if any of list */ if (group & DIR_GREAD) perm |= S_IRGRP; } else { /* exec if execute */ if (group & FILE_GEXEC) perm |= S_IXGRP; /* write if any of writedata, appenddata */ if (group & FILE_GWRITE) perm |= S_IWGRP; /* read if any of readdata */ if (group & FILE_GREAD) perm |= S_IRGRP; } } /* build world permission */ if (world) { if (isdir) { /* exec if any of list, traverse */ if (world & DIR_GEXEC) perm |= S_IXOTH; /* write if any of addfile, adddir, delchild */ if (world & DIR_GWRITE) perm |= S_IWOTH; /* read if any of list */ if (world & DIR_GREAD) perm |= S_IROTH; } else { /* exec if execute */ if (world & FILE_GEXEC) perm |= S_IXOTH; /* write if any of writedata, appenddata */ if (world & FILE_GWRITE) perm |= S_IWOTH; /* read if any of readdata */ if (world & FILE_GREAD) perm |= S_IROTH; } } /* build special permission flags */ if (special) { if (special & FILE_APPEND_DATA) perm |= S_ISUID; if (special & FILE_WRITE_DATA) perm |= S_ISGID; if (special & FILE_READ_DATA) perm |= S_ISVTX; } return (perm); } #if POSIXACLS /* * Normalize a Posix ACL either from a sorted raw set of * access ACEs or default ACEs * (standard case : different owner, group and administrator) */ static int norm_std_permissions_posix(struct POSIX_SECURITY *posix_desc, BOOL groupowns, int start, int count, int target) { int j,k; s32 id; u16 tag; u16 tagsset; struct POSIX_ACE *pxace; mode_t grantgrps; mode_t grantwrld; mode_t denywrld; mode_t allow; mode_t deny; mode_t perms; mode_t mode; mode = 0; tagsset = 0; /* * Determine what is granted to some group or world * Also get denials to world which are meant to prevent * execution flags to be inherited by plain files */ pxace = posix_desc->acl.ace; grantgrps = 0; grantwrld = 0; denywrld = 0; for (j=start; j<(start + count); j++) { if (pxace[j].perms & POSIX_PERM_DENIAL) { /* deny world exec unless for default */ if ((pxace[j].tag == POSIX_ACL_OTHER) && !start) denywrld = pxace[j].perms; } else { switch (pxace[j].tag) { case POSIX_ACL_GROUP_OBJ : grantgrps |= pxace[j].perms; break; case POSIX_ACL_GROUP : if (pxace[j].id) grantgrps |= pxace[j].perms; break; case POSIX_ACL_OTHER : grantwrld = pxace[j].perms; break; default : break; } } } /* * Collect groups of ACEs related to the same id * and determine what is granted and what is denied. * It is important the ACEs have been sorted */ j = start; k = target; while (j < (start + count)) { tag = pxace[j].tag; id = pxace[j].id; if (pxace[j].perms & POSIX_PERM_DENIAL) { deny = pxace[j].perms | denywrld; allow = 0; } else { deny = denywrld; allow = pxace[j].perms; } j++; while ((j < (start + count)) && (pxace[j].tag == tag) && (pxace[j].id == id)) { if (pxace[j].perms & POSIX_PERM_DENIAL) deny |= pxace[j].perms; else allow |= pxace[j].perms; j++; } /* * Build the permissions equivalent to grants and denials */ if (groupowns) { if (tag == POSIX_ACL_MASK) perms = ~deny; else perms = allow & ~deny; } else switch (tag) { case POSIX_ACL_USER_OBJ : perms = (allow | grantgrps | grantwrld) & ~deny; break; case POSIX_ACL_USER : if (id) perms = (allow | grantgrps | grantwrld) & ~deny; else perms = allow; break; case POSIX_ACL_GROUP_OBJ : perms = (allow | grantwrld) & ~deny; break; case POSIX_ACL_GROUP : if (id) perms = (allow | grantwrld) & ~deny; else perms = allow; break; case POSIX_ACL_MASK : perms = ~deny; break; default : perms = allow & ~deny; break; } /* * Store into a Posix ACE */ if (tag != POSIX_ACL_SPECIAL) { pxace[k].tag = tag; pxace[k].id = id; pxace[k].perms = perms & (POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X); tagsset |= tag; k++; } switch (tag) { case POSIX_ACL_USER_OBJ : mode |= ((perms & 7) << 6); break; case POSIX_ACL_GROUP_OBJ : case POSIX_ACL_MASK : mode = (mode & 07707) | ((perms & 7) << 3); break; case POSIX_ACL_OTHER : mode |= perms & 7; break; case POSIX_ACL_SPECIAL : mode |= (perms & (S_ISVTX | S_ISUID | S_ISGID)); break; default : break; } } if (!start) { /* not satisfactory */ posix_desc->mode = mode; posix_desc->tagsset = tagsset; } return (k - target); } #endif /* POSIXACLS */ /* * Interpret an ACL and extract meaningful grants * (standard case : different owner, group and administrator) */ static int build_std_permissions(const char *securattr, const SID *usid, const SID *gsid, BOOL isdir) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; int offdacl; int offace; int acecnt; int nace; BOOL noown; le32 special; le32 allowown, allowgrp, allowall; le32 denyown, denygrp, denyall; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); pacl = (const ACL*)&securattr[offdacl]; special = const_cpu_to_le32(0); allowown = allowgrp = allowall = const_cpu_to_le32(0); denyown = denygrp = denyall = const_cpu_to_le32(0); noown = TRUE; if (offdacl) { acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); } else { acecnt = 0; offace = 0; } for (nace = 0; nace < acecnt; nace++) { pace = (const ACCESS_ALLOWED_ACE*)&securattr[offace]; if (!(pace->flags & INHERIT_ONLY_ACE)) { if (ntfs_same_sid(usid, &pace->sid) || ntfs_same_sid(ownersid, &pace->sid)) { noown = FALSE; if (pace->type == ACCESS_ALLOWED_ACE_TYPE) allowown |= pace->mask; else if (pace->type == ACCESS_DENIED_ACE_TYPE) denyown |= pace->mask; } else if (ntfs_same_sid(gsid, &pace->sid) && !(pace->mask & WRITE_OWNER)) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) allowgrp |= pace->mask; else if (pace->type == ACCESS_DENIED_ACE_TYPE) denygrp |= pace->mask; } else if (is_world_sid((const SID*)&pace->sid)) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) allowall |= pace->mask; else if (pace->type == ACCESS_DENIED_ACE_TYPE) denyall |= pace->mask; } else if ((ntfs_same_sid((const SID*)&pace->sid,nullsid)) && (pace->type == ACCESS_ALLOWED_ACE_TYPE)) special |= pace->mask; } offace += le16_to_cpu(pace->size); } /* * No indication about owner's rights : grant basic rights * This happens for files created by Windows in directories * created by Linux and owned by root, because Windows * merges the admin ACEs */ if (noown) allowown = (FILE_READ_DATA | FILE_WRITE_DATA | FILE_EXECUTE); /* * Add to owner rights granted to group or world * unless denied personaly, and add to group rights * granted to world unless denied specifically */ allowown |= (allowgrp | allowall); allowgrp |= allowall; return (merge_permissions(isdir, allowown & ~(denyown | denyall), allowgrp & ~(denygrp | denyall), allowall & ~denyall, special)); } /* * Interpret an ACL and extract meaningful grants * (special case : owner and group are the same, * and not administrator) */ static int build_owngrp_permissions(const char *securattr, const SID *usid, BOOL isdir) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; int offdacl; int offace; int acecnt; int nace; le32 special; BOOL grppresent; BOOL ownpresent; le32 allowown, allowgrp, allowall; le32 denyown, denygrp, denyall; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); pacl = (const ACL*)&securattr[offdacl]; special = const_cpu_to_le32(0); allowown = allowgrp = allowall = const_cpu_to_le32(0); denyown = denygrp = denyall = const_cpu_to_le32(0); ownpresent = FALSE; grppresent = FALSE; if (offdacl) { acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); } else { acecnt = 0; offace = 0; } for (nace = 0; nace < acecnt; nace++) { pace = (const ACCESS_ALLOWED_ACE*)&securattr[offace]; if (!(pace->flags & INHERIT_ONLY_ACE)) { if ((ntfs_same_sid(usid, &pace->sid) || ntfs_same_sid(ownersid, &pace->sid)) && (pace->mask & WRITE_OWNER)) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) { allowown |= pace->mask; ownpresent = TRUE; } } else if (ntfs_same_sid(usid, &pace->sid) && (!(pace->mask & WRITE_OWNER))) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) { allowgrp |= pace->mask; grppresent = TRUE; } } else if (is_world_sid((const SID*)&pace->sid)) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) allowall |= pace->mask; else if (pace->type == ACCESS_DENIED_ACE_TYPE) denyall |= pace->mask; } else if ((ntfs_same_sid((const SID*)&pace->sid,nullsid)) && (pace->type == ACCESS_ALLOWED_ACE_TYPE)) special |= pace->mask; } offace += le16_to_cpu(pace->size); } if (!ownpresent) allowown = allowall; if (!grppresent) allowgrp = allowall; return (merge_permissions(isdir, allowown & ~(denyown | denyall), allowgrp & ~(denygrp | denyall), allowall & ~denyall, special)); } #if POSIXACLS /* * Normalize a Posix ACL either from a sorted raw set of * access ACEs or default ACEs * (special case : owner or/and group is administrator) */ static int norm_ownadmin_permissions_posix(struct POSIX_SECURITY *posix_desc, int start, int count, int target) { int j,k; s32 id; u16 tag; u16 tagsset; struct POSIX_ACE *pxace; mode_t denywrld; mode_t allow; mode_t deny; mode_t perms; mode_t mode; mode = 0; pxace = posix_desc->acl.ace; tagsset = 0; denywrld = 0; /* * Get denials to world which are meant to prevent * execution flags to be inherited by plain files */ for (j=start; j<(start + count); j++) { if (pxace[j].perms & POSIX_PERM_DENIAL) { /* deny world exec not for default */ if ((pxace[j].tag == POSIX_ACL_OTHER) && !start) denywrld = pxace[j].perms; } } /* * Collect groups of ACEs related to the same id * and determine what is granted (denials are ignored) * It is important the ACEs have been sorted */ j = start; k = target; deny = 0; while (j < (start + count)) { allow = 0; tag = pxace[j].tag; id = pxace[j].id; if (tag == POSIX_ACL_MASK) { deny = pxace[j].perms; j++; while ((j < (start + count)) && (pxace[j].tag == POSIX_ACL_MASK)) j++; } else { if (!(pxace[j].perms & POSIX_PERM_DENIAL)) allow = pxace[j].perms; j++; while ((j < (start + count)) && (pxace[j].tag == tag) && (pxace[j].id == id)) { if (!(pxace[j].perms & POSIX_PERM_DENIAL)) allow |= pxace[j].perms; j++; } } /* * Store the grants into a Posix ACE */ if (tag == POSIX_ACL_MASK) perms = ~deny; else perms = allow & ~denywrld; if (tag != POSIX_ACL_SPECIAL) { pxace[k].tag = tag; pxace[k].id = id; pxace[k].perms = perms & (POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X); tagsset |= tag; k++; } switch (tag) { case POSIX_ACL_USER_OBJ : mode |= ((perms & 7) << 6); break; case POSIX_ACL_GROUP_OBJ : case POSIX_ACL_MASK : mode = (mode & 07707) | ((perms & 7) << 3); break; case POSIX_ACL_OTHER : mode |= perms & 7; break; case POSIX_ACL_SPECIAL : mode |= perms & (S_ISVTX | S_ISUID | S_ISGID); break; default : break; } } if (!start) { /* not satisfactory */ posix_desc->mode = mode; posix_desc->tagsset = tagsset; } return (k - target); } #endif /* POSIXACLS */ /* * Interpret an ACL and extract meaningful grants * (special case : owner or/and group is administrator) */ static int build_ownadmin_permissions(const char *securattr, const SID *usid, const SID *gsid, BOOL isdir) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; int offdacl; int offace; int acecnt; int nace; BOOL firstapply; int isforeign; le32 special; le32 allowown, allowgrp, allowall; le32 denyown, denygrp, denyall; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); pacl = (const ACL*)&securattr[offdacl]; special = const_cpu_to_le32(0); allowown = allowgrp = allowall = const_cpu_to_le32(0); denyown = denygrp = denyall = const_cpu_to_le32(0); if (offdacl) { acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); } else { acecnt = 0; offace = 0; } firstapply = TRUE; isforeign = 3; for (nace = 0; nace < acecnt; nace++) { pace = (const ACCESS_ALLOWED_ACE*)&securattr[offace]; if (!(pace->flags & INHERIT_ONLY_ACE) && !(~pace->mask & (ROOT_OWNER_UNMARK | ROOT_GROUP_UNMARK))) { if ((ntfs_same_sid(usid, &pace->sid) || ntfs_same_sid(ownersid, &pace->sid)) && (((pace->mask & WRITE_OWNER) && firstapply))) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) { allowown |= pace->mask; isforeign &= ~1; } else if (pace->type == ACCESS_DENIED_ACE_TYPE) denyown |= pace->mask; } else if (ntfs_same_sid(gsid, &pace->sid) && (!(pace->mask & WRITE_OWNER))) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) { allowgrp |= pace->mask; isforeign &= ~2; } else if (pace->type == ACCESS_DENIED_ACE_TYPE) denygrp |= pace->mask; } else if (is_world_sid((const SID*)&pace->sid)) { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) allowall |= pace->mask; else if (pace->type == ACCESS_DENIED_ACE_TYPE) denyall |= pace->mask; } firstapply = FALSE; } else if (!(pace->flags & INHERIT_ONLY_ACE)) if ((ntfs_same_sid((const SID*)&pace->sid,nullsid)) && (pace->type == ACCESS_ALLOWED_ACE_TYPE)) special |= pace->mask; offace += le16_to_cpu(pace->size); } if (isforeign) { allowown |= (allowgrp | allowall); allowgrp |= allowall; } return (merge_permissions(isdir, allowown & ~(denyown | denyall), allowgrp & ~(denygrp | denyall), allowall & ~denyall, special)); } #if OWNERFROMACL /* * Define the owner of a file as the first user allowed * to change the owner, instead of the user defined as owner. * * This produces better approximations for files written by a * Windows user in an inheritable directory owned by another user, * as the access rights are inheritable but the ownership is not. * * An important case is the directories "Documents and Settings/user" * which the users must have access to, though Windows considers them * as owned by administrator. */ const SID *ntfs_acl_owner(const char *securattr) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const SID *usid; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; int offdacl; int offace; int acecnt; int nace; BOOL found; found = FALSE; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); if (offdacl) { pacl = (const ACL*)&securattr[offdacl]; acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); nace = 0; do { pace = (const ACCESS_ALLOWED_ACE*)&securattr[offace]; if ((pace->mask & WRITE_OWNER) && (pace->type == ACCESS_ALLOWED_ACE_TYPE) && ntfs_is_user_sid(&pace->sid)) found = TRUE; offace += le16_to_cpu(pace->size); } while (!found && (++nace < acecnt)); } if (found) usid = &pace->sid; else usid = (const SID*)&securattr[le32_to_cpu(phead->owner)]; return (usid); } #else /* * Special case for files owned by administrator with full * access granted to a mapped user : consider this user as the tenant * of the file. * * This situation cannot be represented with Linux concepts and can * only be found for files or directories created by Windows. * Typical situation : directory "Documents and Settings/user" which * is on the path to user's files and must be given access to user * only. * * Check file is owned by administrator and no user has rights before * calling. * Returns the uid of tenant or zero if none */ static uid_t find_tenant(struct MAPPING *const mapping[], const char *securattr) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; int offdacl; int offace; int acecnt; int nace; uid_t tid; uid_t xid; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); pacl = (const ACL*)&securattr[offdacl]; tid = 0; if (offdacl) { acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); } else acecnt = 0; for (nace = 0; nace < acecnt; nace++) { pace = (const ACCESS_ALLOWED_ACE*)&securattr[offace]; if ((pace->type == ACCESS_ALLOWED_ACE_TYPE) && (pace->mask & DIR_WRITE)) { xid = ntfs_find_user(mapping[MAPUSERS], &pace->sid); if (xid) tid = xid; } offace += le16_to_cpu(pace->size); } return (tid); } #endif /* OWNERFROMACL */ #if POSIXACLS /* * Build Posix permissions from an ACL * returns a pointer to the requested permissions * or a null pointer (with errno set) if there is a problem * * If the NTFS ACL was created according to our rules, the retrieved * Posix ACL should be the exact ACL which was set. However if * the NTFS ACL was built by a different tool, the result could * be a a poor approximation of what was expected */ struct POSIX_SECURITY *ntfs_build_permissions_posix( struct MAPPING *const mapping[], const char *securattr, const SID *usid, const SID *gsid, BOOL isdir) { const SECURITY_DESCRIPTOR_RELATIVE *phead; struct POSIX_SECURITY *pxdesc; const ACL *pacl; const ACCESS_ALLOWED_ACE *pace; struct POSIX_ACE *pxace; struct { uid_t prevuid; gid_t prevgid; int groupmasks; s16 tagsset; BOOL gotowner; BOOL gotownermask; BOOL gotgroup; mode_t permswrld; } ctx[2], *pctx; int offdacl; int offace; int alloccnt; int acecnt; uid_t uid; gid_t gid; int i,j; int k,l; BOOL ignore; BOOL adminowns; BOOL groupowns; BOOL firstinh; BOOL genericinh; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; offdacl = le32_to_cpu(phead->dacl); if (offdacl) { pacl = (const ACL*)&securattr[offdacl]; acecnt = le16_to_cpu(pacl->ace_count); offace = offdacl + sizeof(ACL); } else { acecnt = 0; offace = 0; } adminowns = FALSE; groupowns = ntfs_same_sid(gsid,usid); firstinh = FALSE; genericinh = FALSE; /* * Build a raw posix security descriptor * by just translating permissions and ids * Add 2 to the count of ACE to be able to insert * a group ACE later in access and default ACLs * and add 2 more to be able to insert ACEs for owner * and 2 more for other */ alloccnt = acecnt + 6; pxdesc = (struct POSIX_SECURITY*)malloc( sizeof(struct POSIX_SECURITY) + alloccnt*sizeof(struct POSIX_ACE)); k = 0; l = alloccnt; for (i=0; i<2; i++) { pctx = &ctx[i]; pctx->permswrld = 0; pctx->prevuid = -1; pctx->prevgid = -1; pctx->groupmasks = 0; pctx->tagsset = 0; pctx->gotowner = FALSE; pctx->gotgroup = FALSE; pctx->gotownermask = FALSE; } for (j=0; jflags & INHERIT_ONLY_ACE) { pxace = &pxdesc->acl.ace[l - 1]; pctx = &ctx[1]; } else { pxace = &pxdesc->acl.ace[k]; pctx = &ctx[0]; } ignore = FALSE; /* * grants for root as a designated user or group */ if ((~pace->mask & (ROOT_OWNER_UNMARK | ROOT_GROUP_UNMARK)) && (pace->type == ACCESS_ALLOWED_ACE_TYPE) && ntfs_same_sid(&pace->sid, adminsid)) { pxace->tag = (pace->mask & ROOT_OWNER_UNMARK ? POSIX_ACL_GROUP : POSIX_ACL_USER); pxace->id = 0; if ((pace->mask & (GENERIC_ALL | WRITE_OWNER)) && (pace->flags & INHERIT_ONLY_ACE)) ignore = genericinh = TRUE; } else if (ntfs_same_sid(usid, &pace->sid)) { pxace->id = -1; /* * Owner has no write-owner right : * a group was defined same as owner * or admin was owner or group : * denials are meant to owner * and grants are meant to group */ if (!(pace->mask & (WRITE_OWNER | GENERIC_ALL)) && (pace->type == ACCESS_ALLOWED_ACE_TYPE)) { if (ntfs_same_sid(gsid,usid)) { pxace->tag = POSIX_ACL_GROUP_OBJ; pxace->id = -1; } else { if (ntfs_same_sid(&pace->sid,usid)) groupowns = TRUE; gid = ntfs_find_group(mapping[MAPGROUPS],&pace->sid); if (gid) { pxace->tag = POSIX_ACL_GROUP; pxace->id = gid; pctx->prevgid = gid; } else { uid = ntfs_find_user(mapping[MAPUSERS],&pace->sid); if (uid) { pxace->tag = POSIX_ACL_USER; pxace->id = uid; } else ignore = TRUE; } } } else { /* * when group owns, late denials for owner * mean group mask */ if ((pace->type == ACCESS_DENIED_ACE_TYPE) && (pace->mask & WRITE_OWNER)) { pxace->tag = POSIX_ACL_MASK; pctx->gotownermask = TRUE; if (pctx->gotowner) pctx->groupmasks++; } else { if (pace->type == ACCESS_ALLOWED_ACE_TYPE) pctx->gotowner = TRUE; if (pctx->gotownermask && !pctx->gotowner) { uid = ntfs_find_user(mapping[MAPUSERS],&pace->sid); pxace->id = uid; pxace->tag = POSIX_ACL_USER; } else pxace->tag = POSIX_ACL_USER_OBJ; /* system ignored, and admin */ /* ignored at first position */ if (pace->flags & INHERIT_ONLY_ACE) { if ((firstinh && ntfs_same_sid(&pace->sid,adminsid)) || ntfs_same_sid(&pace->sid,systemsid)) ignore = TRUE; if (!firstinh) { firstinh = TRUE; } } else { if ((adminowns && ntfs_same_sid(&pace->sid,adminsid)) || ntfs_same_sid(&pace->sid,systemsid)) ignore = TRUE; if (ntfs_same_sid(usid,adminsid)) adminowns = TRUE; } } } } else if (ntfs_same_sid(gsid, &pace->sid)) { if ((pace->type == ACCESS_DENIED_ACE_TYPE) && (pace->mask & WRITE_OWNER)) { pxace->tag = POSIX_ACL_MASK; pxace->id = -1; if (pctx->gotowner) pctx->groupmasks++; } else { if (pctx->gotgroup || (pctx->groupmasks > 1)) { gid = ntfs_find_group(mapping[MAPGROUPS],&pace->sid); if (gid) { pxace->id = gid; pxace->tag = POSIX_ACL_GROUP; pctx->prevgid = gid; } else ignore = TRUE; } else { pxace->id = -1; pxace->tag = POSIX_ACL_GROUP_OBJ; if (pace->type == ACCESS_ALLOWED_ACE_TYPE) pctx->gotgroup = TRUE; } if (ntfs_same_sid(gsid,adminsid) || ntfs_same_sid(gsid,systemsid)) { if (pace->mask & (WRITE_OWNER | GENERIC_ALL)) ignore = TRUE; if (ntfs_same_sid(gsid,adminsid)) adminowns = TRUE; else genericinh = ignore; } } } else if (is_world_sid((const SID*)&pace->sid)) { pxace->id = -1; pxace->tag = POSIX_ACL_OTHER; if ((pace->type == ACCESS_DENIED_ACE_TYPE) && (pace->flags & INHERIT_ONLY_ACE)) ignore = TRUE; } else if (ntfs_same_sid((const SID*)&pace->sid,nullsid)) { pxace->id = -1; pxace->tag = POSIX_ACL_SPECIAL; } else { uid = ntfs_find_user(mapping[MAPUSERS],&pace->sid); if (uid) { if ((pace->type == ACCESS_DENIED_ACE_TYPE) && (pace->mask & WRITE_OWNER) && (pctx->prevuid != uid)) { pxace->id = -1; pxace->tag = POSIX_ACL_MASK; } else { pxace->id = uid; pxace->tag = POSIX_ACL_USER; } pctx->prevuid = uid; } else { gid = ntfs_find_group(mapping[MAPGROUPS],&pace->sid); if (gid) { if ((pace->type == ACCESS_DENIED_ACE_TYPE) && (pace->mask & WRITE_OWNER) && (pctx->prevgid != gid)) { pxace->tag = POSIX_ACL_MASK; pctx->groupmasks++; } else { pxace->tag = POSIX_ACL_GROUP; } pxace->id = gid; pctx->prevgid = gid; } else { /* * do not grant rights to unknown * people and do not define root as a * designated user or group */ ignore = TRUE; } } } if (((pace->type == ACCESS_ALLOWED_ACE_TYPE) || (pace->type == ACCESS_DENIED_ACE_TYPE)) && !ignore) { pxace->perms = 0; /* specific decoding for vtx/uid/gid */ if (pxace->tag == POSIX_ACL_SPECIAL) { if (pace->mask & FILE_APPEND_DATA) pxace->perms |= S_ISUID; if (pace->mask & FILE_WRITE_DATA) pxace->perms |= S_ISGID; if (pace->mask & FILE_READ_DATA) pxace->perms |= S_ISVTX; } else if (isdir) { if (pace->mask & DIR_GEXEC) pxace->perms |= POSIX_PERM_X; if (pace->mask & DIR_GWRITE) pxace->perms |= POSIX_PERM_W; if (pace->mask & DIR_GREAD) pxace->perms |= POSIX_PERM_R; if ((pace->mask & GENERIC_ALL) && (pace->flags & INHERIT_ONLY_ACE)) pxace->perms |= POSIX_PERM_X | POSIX_PERM_W | POSIX_PERM_R; } else { if (pace->mask & FILE_GEXEC) pxace->perms |= POSIX_PERM_X; if (pace->mask & FILE_GWRITE) pxace->perms |= POSIX_PERM_W; if (pace->mask & FILE_GREAD) pxace->perms |= POSIX_PERM_R; } if (pace->type != ACCESS_ALLOWED_ACE_TYPE) pxace->perms |= POSIX_PERM_DENIAL; else if (pxace->tag == POSIX_ACL_OTHER) pctx->permswrld |= pxace->perms; pctx->tagsset |= pxace->tag; if (pace->flags & INHERIT_ONLY_ACE) { l--; } else { k++; } } offace += le16_to_cpu(pace->size); } /* * Create world perms if none (both lists) */ for (i=0; i<2; i++) if ((genericinh || !i) && !(ctx[i].tagsset & POSIX_ACL_OTHER)) { if (i) pxace = &pxdesc->acl.ace[--l]; else pxace = &pxdesc->acl.ace[k++]; pxace->tag = POSIX_ACL_OTHER; pxace->id = -1; pxace->perms = 0; ctx[i].tagsset |= POSIX_ACL_OTHER; ctx[i].permswrld = 0; } /* * Set basic owner perms if none (both lists) * This happens for files created by Windows in directories * created by Linux and owned by root, because Windows * merges the admin ACEs */ for (i=0; i<2; i++) if (!(ctx[i].tagsset & POSIX_ACL_USER_OBJ) && (ctx[i].tagsset & POSIX_ACL_OTHER)) { if (i) pxace = &pxdesc->acl.ace[--l]; else pxace = &pxdesc->acl.ace[k++]; pxace->tag = POSIX_ACL_USER_OBJ; pxace->id = -1; pxace->perms = POSIX_PERM_R | POSIX_PERM_W | POSIX_PERM_X; ctx[i].tagsset |= POSIX_ACL_USER_OBJ; } /* * Duplicate world perms as group_obj perms if none */ for (i=0; i<2; i++) if ((ctx[i].tagsset & POSIX_ACL_OTHER) && !(ctx[i].tagsset & POSIX_ACL_GROUP_OBJ)) { if (i) pxace = &pxdesc->acl.ace[--l]; else pxace = &pxdesc->acl.ace[k++]; pxace->tag = POSIX_ACL_GROUP_OBJ; pxace->id = -1; pxace->perms = ctx[i].permswrld; ctx[i].tagsset |= POSIX_ACL_GROUP_OBJ; } /* * Also duplicate world perms as group perms if they * were converted to mask and not followed by a group entry */ if (ctx[0].groupmasks) { for (j=k-2; j>=0; j--) { if ((pxdesc->acl.ace[j].tag == POSIX_ACL_MASK) && (pxdesc->acl.ace[j].id != -1) && ((pxdesc->acl.ace[j+1].tag != POSIX_ACL_GROUP) || (pxdesc->acl.ace[j+1].id != pxdesc->acl.ace[j].id))) { pxace = &pxdesc->acl.ace[k]; pxace->tag = POSIX_ACL_GROUP; pxace->id = pxdesc->acl.ace[j].id; pxace->perms = ctx[0].permswrld; ctx[0].tagsset |= POSIX_ACL_GROUP; k++; } if (pxdesc->acl.ace[j].tag == POSIX_ACL_MASK) pxdesc->acl.ace[j].id = -1; } } if (ctx[1].groupmasks) { for (j=l; j<(alloccnt-1); j++) { if ((pxdesc->acl.ace[j].tag == POSIX_ACL_MASK) && (pxdesc->acl.ace[j].id != -1) && ((pxdesc->acl.ace[j+1].tag != POSIX_ACL_GROUP) || (pxdesc->acl.ace[j+1].id != pxdesc->acl.ace[j].id))) { pxace = &pxdesc->acl.ace[l - 1]; pxace->tag = POSIX_ACL_GROUP; pxace->id = pxdesc->acl.ace[j].id; pxace->perms = ctx[1].permswrld; ctx[1].tagsset |= POSIX_ACL_GROUP; l--; } if (pxdesc->acl.ace[j].tag == POSIX_ACL_MASK) pxdesc->acl.ace[j].id = -1; } } /* * Insert default mask if none present and * there are designated users or groups * (the space for it has not beed used) */ for (i=0; i<2; i++) if ((ctx[i].tagsset & (POSIX_ACL_USER | POSIX_ACL_GROUP)) && !(ctx[i].tagsset & POSIX_ACL_MASK)) { if (i) pxace = &pxdesc->acl.ace[--l]; else pxace = &pxdesc->acl.ace[k++]; pxace->tag = POSIX_ACL_MASK; pxace->id = -1; pxace->perms = POSIX_PERM_DENIAL; ctx[i].tagsset |= POSIX_ACL_MASK; } if (k > l) { ntfs_log_error("Posix descriptor is longer than expected\n"); errno = EIO; free(pxdesc); pxdesc = (struct POSIX_SECURITY*)NULL; } else { pxdesc->acccnt = k; pxdesc->defcnt = alloccnt - l; pxdesc->firstdef = l; pxdesc->tagsset = ctx[0].tagsset; pxdesc->acl.version = POSIX_VERSION; pxdesc->acl.flags = 0; pxdesc->acl.filler = 0; ntfs_sort_posix(pxdesc); if (adminowns) { k = norm_ownadmin_permissions_posix(pxdesc, 0, pxdesc->acccnt, 0); pxdesc->acccnt = k; l = norm_ownadmin_permissions_posix(pxdesc, pxdesc->firstdef, pxdesc->defcnt, k); pxdesc->firstdef = k; pxdesc->defcnt = l; } else { k = norm_std_permissions_posix(pxdesc,groupowns, 0, pxdesc->acccnt, 0); pxdesc->acccnt = k; l = norm_std_permissions_posix(pxdesc,groupowns, pxdesc->firstdef, pxdesc->defcnt, k); pxdesc->firstdef = k; pxdesc->defcnt = l; } } if (pxdesc && !ntfs_valid_posix(pxdesc)) { ntfs_log_error("Invalid Posix descriptor built\n"); errno = EIO; free(pxdesc); pxdesc = (struct POSIX_SECURITY*)NULL; } return (pxdesc); } #endif /* POSIXACLS */ /* * Build unix-style (mode_t) permissions from an ACL * returns the requested permissions * or a negative result (with errno set) if there is a problem */ int ntfs_build_permissions(const char *securattr, const SID *usid, const SID *gsid, BOOL isdir) { int perm; BOOL adminowns; BOOL groupowns; adminowns = ntfs_same_sid(usid,adminsid) || ntfs_same_sid(gsid,adminsid); groupowns = !adminowns && ntfs_same_sid(gsid,usid); if (adminowns) perm = build_ownadmin_permissions(securattr, usid, gsid, isdir); else if (groupowns) perm = build_owngrp_permissions(securattr, usid, isdir); else perm = build_std_permissions(securattr, usid, gsid, isdir); return (perm); } /* * The following must be in some library... */ static unsigned long atoul(const char *p) { /* must be somewhere ! */ unsigned long v; v = 0; while ((*p >= '0') && (*p <= '9')) v = v * 10 + (*p++) - '0'; return (v); } /* * Build an internal representation of a SID * Returns a copy in allocated memory if it succeeds * The SID is checked to be a valid user one. */ static SID *encodesid(const char *sidstr) { SID *sid; int cnt; BIGSID bigsid; SID *bsid; u32 auth; const char *p; sid = (SID*) NULL; if (!strncmp(sidstr, "S-1-", 4)) { bsid = (SID*)&bigsid; bsid->revision = SID_REVISION; p = &sidstr[4]; auth = atoul(p); bsid->identifier_authority.high_part = const_cpu_to_be16(0); bsid->identifier_authority.low_part = cpu_to_be32(auth); cnt = 0; p = strchr(p, '-'); while (p && (cnt < 8)) { p++; auth = atoul(p); bsid->sub_authority[cnt] = cpu_to_le32(auth); p = strchr(p, '-'); cnt++; } bsid->sub_authority_count = cnt; if ((cnt > 0) && ntfs_valid_sid(bsid) && (ntfs_is_user_sid(bsid) || ntfs_known_group_sid(bsid))) { sid = (SID*) ntfs_malloc(4 * cnt + 8); if (sid) memcpy(sid, bsid, 4 * cnt + 8); } } return (sid); } /* * Get a single mapping item from buffer * * Always reads a full line, truncating long lines * Refills buffer when exhausted * Returns pointer to item, or NULL when there is no more */ static struct MAPLIST *getmappingitem(FILEREADER reader, void *fileid, off_t *poffs, char *buf, int *psrc, s64 *psize) { int src; int dst; char *q; char *pu; char *pg; int gotend; struct MAPLIST *item; src = *psrc; dst = 0; /* allocate and get a full line */ item = (struct MAPLIST*)ntfs_malloc(sizeof(struct MAPLIST)); if (item) { do { gotend = 0; while ((src < *psize) && (buf[src] != '\n')) { if (dst < LINESZ) item->maptext[dst++] = buf[src]; src++; } if (src >= *psize) { *poffs += *psize; *psize = reader(fileid, buf, (size_t)BUFSZ, *poffs); src = 0; } else { gotend = 1; src++; item->maptext[dst] = '\0'; dst = 0; } } while (*psize && ((item->maptext[0] == '#') || !gotend)); if (gotend) { pu = pg = (char*)NULL; /* decompose into uid, gid and sid */ item->uidstr = item->maptext; item->gidstr = strchr(item->uidstr, ':'); if (item->gidstr) { pu = item->gidstr++; item->sidstr = strchr(item->gidstr, ':'); if (item->sidstr) { pg = item->sidstr++; q = strchr(item->sidstr, ':'); if (q) *q = 0; } } if (pu && pg) *pu = *pg = '\0'; else { ntfs_log_early_error("Bad mapping item \"%s\"\n", item->maptext); free(item); item = (struct MAPLIST*)NULL; } } else { free(item); /* free unused item */ item = (struct MAPLIST*)NULL; } } *psrc = src; return (item); } /* * Read user mapping file and split into their attribute. * Parameters are kept as text in a chained list until logins * are converted to uid. * Returns the head of list, if any * * If an absolute path is provided, the mapping file is assumed * to be located in another mounted file system, and plain read() * are used to get its contents. * If a relative path is provided, the mapping file is assumed * to be located on the current file system, and internal IO * have to be used since we are still mounting and we have not * entered the fuse loop yet. */ struct MAPLIST *ntfs_read_mapping(FILEREADER reader, void *fileid) { char buf[BUFSZ]; struct MAPLIST *item; struct MAPLIST *firstitem; struct MAPLIST *lastitem; int src; off_t offs; s64 size; firstitem = (struct MAPLIST*)NULL; lastitem = (struct MAPLIST*)NULL; offs = 0; size = reader(fileid, buf, (size_t)BUFSZ, (off_t)0); if (size > 0) { src = 0; do { item = getmappingitem(reader, fileid, &offs, buf, &src, &size); if (item) { item->next = (struct MAPLIST*)NULL; if (lastitem) lastitem->next = item; else firstitem = item; lastitem = item; } } while (item); } return (firstitem); } /* * Free memory used to store the user mapping * The only purpose is to facilitate the detection of memory leaks */ void ntfs_free_mapping(struct MAPPING *mapping[]) { struct MAPPING *user; struct MAPPING *group; /* free user mappings */ while (mapping[MAPUSERS]) { user = mapping[MAPUSERS]; /* do not free SIDs used for group mappings */ group = mapping[MAPGROUPS]; while (group && (group->sid != user->sid)) group = group->next; if (!group) free(user->sid); /* free group list if any */ if (user->grcnt) free(user->groups); /* unchain item and free */ mapping[MAPUSERS] = user->next; free(user); } /* free group mappings */ while (mapping[MAPGROUPS]) { group = mapping[MAPGROUPS]; free(group->sid); /* unchain item and free */ mapping[MAPGROUPS] = group->next; free(group); } } /* * Build the user mapping list * user identification may be given in symbolic or numeric format * * ! Note ! : does getpwnam() read /etc/passwd or some other file ? * if so there is a possible recursion into fuse if this * file is on NTFS, and fuse is not recursion safe. */ struct MAPPING *ntfs_do_user_mapping(struct MAPLIST *firstitem) { struct MAPLIST *item; struct MAPPING *firstmapping; struct MAPPING *lastmapping; struct MAPPING *mapping; struct passwd *pwd; SID *sid; int uid; firstmapping = (struct MAPPING*)NULL; lastmapping = (struct MAPPING*)NULL; for (item = firstitem; item; item = item->next) { if ((item->uidstr[0] >= '0') && (item->uidstr[0] <= '9')) uid = atoi(item->uidstr); else { uid = 0; if (item->uidstr[0]) { pwd = getpwnam(item->uidstr); if (pwd) uid = pwd->pw_uid; else ntfs_log_early_error("Invalid user \"%s\"\n", item->uidstr); } } /* * Records with no uid and no gid are inserted * to define the implicit mapping pattern */ if (uid || (!item->uidstr[0] && !item->gidstr[0])) { sid = encodesid(item->sidstr); if (sid && ntfs_known_group_sid(sid)) { ntfs_log_error("Bad user SID %s\n", item->sidstr); free(sid); sid = (SID*)NULL; } if (sid && !item->uidstr[0] && !item->gidstr[0] && !ntfs_valid_pattern(sid)) { ntfs_log_error("Bad implicit SID pattern %s\n", item->sidstr); free(sid); sid = (SID*)NULL; } if (sid) { mapping = (struct MAPPING*) ntfs_malloc(sizeof(struct MAPPING)); if (mapping) { mapping->sid = sid; mapping->xid = uid; mapping->grcnt = 0; mapping->next = (struct MAPPING*)NULL; if (lastmapping) lastmapping->next = mapping; else firstmapping = mapping; lastmapping = mapping; } free(sid); sid = (SID*)NULL; } } } return (firstmapping); } /* * Build the group mapping list * group identification may be given in symbolic or numeric format * * gid not associated to a uid are processed first in order * to favour real groups * * ! Note ! : does getgrnam() read /etc/group or some other file ? * if so there is a possible recursion into fuse if this * file is on NTFS, and fuse is not recursion safe. */ struct MAPPING *ntfs_do_group_mapping(struct MAPLIST *firstitem) { struct MAPLIST *item; struct MAPPING *firstmapping; struct MAPPING *lastmapping; struct MAPPING *mapping; struct group *grp; BOOL secondstep; BOOL ok; int step; SID *sid = NULL; int gid; firstmapping = (struct MAPPING*)NULL; lastmapping = (struct MAPPING*)NULL; for (step=1; step<=2; step++) { for (item = firstitem; item; item = item->next) { secondstep = (item->uidstr[0] != '\0') || !item->gidstr[0]; ok = (step == 1 ? !secondstep : secondstep); if ((item->gidstr[0] >= '0') && (item->gidstr[0] <= '9')) gid = atoi(item->gidstr); else { gid = 0; if (item->gidstr[0]) { grp = getgrnam(item->gidstr); if (grp) gid = grp->gr_gid; else ntfs_log_early_error("Invalid group \"%s\"\n", item->gidstr); } } /* * Records with no uid and no gid are inserted in the * second step to define the implicit mapping pattern */ if (ok && (gid || (!item->uidstr[0] && !item->gidstr[0]))) { if (sid) free(sid); sid = encodesid(item->sidstr); if (sid && !item->uidstr[0] && !item->gidstr[0] && !ntfs_valid_pattern(sid)) { /* error already logged */ sid = (SID*)NULL; } if (sid) { mapping = (struct MAPPING*) ntfs_malloc(sizeof(struct MAPPING)); if (mapping) { mapping->sid = sid; mapping->xid = gid; /* special groups point to themselves */ if (ntfs_known_group_sid(sid)) { mapping->groups = (gid_t*)&mapping->xid; mapping->grcnt = 1; } else mapping->grcnt = 0; mapping->next = (struct MAPPING*)NULL; if (lastmapping) lastmapping->next = mapping; else firstmapping = mapping; lastmapping = mapping; } else { free(sid); sid = NULL; } } } } } return (firstmapping); } ntfsprogs-plus-1.0.0/libntfs/attrib.c000066400000000000000000006603711507404161300176260ustar00rootroot00000000000000/** * attrib.c - Attribute handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2010 Anton Altaparmakov * Copyright (c) 2002-2005 Richard Russon * Copyright (c) 2002-2008 Szabolcs Szakacsits * Copyright (c) 2004-2007 Yura Pakhuchiy * Copyright (c) 2007-2021 Jean-Pierre Andre * Copyright (c) 2010 Erik Larsson * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #include "param.h" #include "compat.h" #include "attrib.h" #include "attrlist.h" #include "device.h" #include "mft.h" #include "debug.h" #include "mst.h" #include "volume.h" #include "types.h" #include "layout.h" #include "inode.h" #include "runlist.h" #include "lcnalloc.h" #include "dir.h" #include "compress.h" #include "bitmap.h" #include "logging.h" #include "misc.h" #include "efs.h" #include "problem.h" ntfschar AT_UNNAMED[] = { const_cpu_to_le16('\0') }; ntfschar STREAM_SDS[] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('D'), const_cpu_to_le16('S'), const_cpu_to_le16('\0') }; ntfschar TXF_DATA[] = { const_cpu_to_le16('$'), const_cpu_to_le16('T'), const_cpu_to_le16('X'), const_cpu_to_le16('F'), const_cpu_to_le16('_'), const_cpu_to_le16('D'), const_cpu_to_le16('A'), const_cpu_to_le16('T'), const_cpu_to_le16('A'), const_cpu_to_le16('\0') }; static int NAttrFlag(ntfs_attr *na, FILE_ATTR_FLAGS flag) { if (na->type == AT_DATA && na->name == AT_UNNAMED) return (na->ni->flags & flag); return 0; } static void NAttrSetFlag(ntfs_attr *na, FILE_ATTR_FLAGS flag) { if (na->type == AT_DATA && na->name == AT_UNNAMED) na->ni->flags |= flag; else ntfs_log_trace("Denied setting flag %d for not unnamed data " "attribute\n", le32_to_cpu(flag)); } static void NAttrClearFlag(ntfs_attr *na, FILE_ATTR_FLAGS flag) { if (na->type == AT_DATA && na->name == AT_UNNAMED) na->ni->flags &= ~flag; } #define GenNAttrIno(func_name, flag) \ int NAttr##func_name(ntfs_attr *na) { return NAttrFlag (na, flag); } \ void NAttrSet##func_name(ntfs_attr *na) { NAttrSetFlag (na, flag); } \ void NAttrClear##func_name(ntfs_attr *na){ NAttrClearFlag(na, flag); } GenNAttrIno(Compressed, FILE_ATTR_COMPRESSED) GenNAttrIno(Encrypted, FILE_ATTR_ENCRYPTED) GenNAttrIno(Sparse, FILE_ATTR_SPARSE_FILE) /** * ntfs_get_attribute_value_length - Find the length of an attribute * @a: * * Description... * * Returns: */ s64 ntfs_get_attribute_value_length(const ATTR_RECORD *a) { if (!a) { errno = EINVAL; return 0; } errno = 0; if (a->non_resident) return sle64_to_cpu(a->data_size); return (s64)le32_to_cpu(a->value_length); } void ntfs_set_attribute_value_length(ATTR_RECORD *a, s64 length) { if (!a) { errno = EINVAL; return; } errno = 0; if (a->non_resident) { a->data_size = cpu_to_sle64(length); a->allocated_size = cpu_to_sle64((length + 7) & ~7); a->initialized_size = cpu_to_sle64(length); return; } a->value_length = cpu_to_le32(length); } BOOL ntfs_is_valid_attr_type(const ATTR_RECORD *a) { switch (a->type) { case AT_UNUSED: case AT_STANDARD_INFORMATION: case AT_ATTRIBUTE_LIST: case AT_FILE_NAME: case AT_OBJECT_ID: case AT_SECURITY_DESCRIPTOR: case AT_VOLUME_NAME: case AT_VOLUME_INFORMATION: case AT_DATA: case AT_INDEX_ROOT: case AT_INDEX_ALLOCATION: case AT_BITMAP: case AT_REPARSE_POINT: case AT_EA_INFORMATION: case AT_EA: case AT_PROPERTY_SET: case AT_LOGGED_UTILITY_STREAM: case AT_FIRST_USER_DEFINED_ATTRIBUTE: case AT_END: if (a->length != 0) return TRUE; } return FALSE; } /** * ntfs_get_attribute_value - Get a copy of an attribute * @vol: * @a: * @b: * * Description... * * Returns: */ s64 ntfs_get_attribute_value(const ntfs_volume *vol, const ATTR_RECORD *a, u8 *b) { runlist *rl; s64 total, r; int i; /* Sanity checks. */ if (!vol || !a || !b) { errno = EINVAL; return 0; } /* Complex attribute? */ /* * Ignore the flags in case they are not zero for an attribute list * attribute. Windows does not complain about invalid flags and chkdsk * does not detect or fix them so we need to cope with it, too. */ if (a->type != AT_ATTRIBUTE_LIST && a->flags) { ntfs_log_error("Non-zero (%04x) attribute flags. Cannot handle " "this yet.\n", le16_to_cpu(a->flags)); errno = EOPNOTSUPP; return 0; } if (!a->non_resident) { /* Attribute is resident. */ /* Sanity check. */ if (le32_to_cpu(a->value_length) + le16_to_cpu(a->value_offset) > le32_to_cpu(a->length)) { return 0; } memcpy(b, (const char*)a + le16_to_cpu(a->value_offset), le32_to_cpu(a->value_length)); errno = 0; return (s64)le32_to_cpu(a->value_length); } /* Attribute is not resident. */ /* If no data, return 0. */ if (!(a->data_size)) { errno = 0; return 0; } /* * FIXME: What about attribute lists?!? (AIA) */ /* Decompress the mapping pairs array into a runlist. */ rl = ntfs_mapping_pairs_decompress(vol, a, NULL); if (!rl) { errno = EINVAL; return 0; } /* * FIXED: We were overflowing here in a nasty fashion when we * reach the last cluster in the runlist as the buffer will * only be big enough to hold data_size bytes while we are * reading in allocated_size bytes which is usually larger * than data_size, since the actual data is unlikely to have a * size equal to a multiple of the cluster size! * FIXED2: We were also overflowing here in the same fashion * when the data_size was more than one run smaller than the * allocated size which happens with Windows XP sometimes. */ /* Now load all clusters in the runlist into b. */ for (i = 0, total = 0; rl[i].length; i++) { if (total + (rl[i].length << vol->cluster_size_bits) >= sle64_to_cpu(a->data_size)) { unsigned char *intbuf = NULL; s64 intlth; /* * We have reached the last run so we were going to * overflow when executing the ntfs_pread() which is * BAAAAAAAD! * Temporary fix: * Allocate a new buffer with size: * rl[i].length << vol->cluster_size_bits, do the * read into our buffer, then memcpy the correct * amount of data into the caller supplied buffer, * free our buffer, and continue. * We have reached the end of data size so we were * going to overflow in the same fashion. * Temporary fix: same as above. * * For safety, limit the amount to read to the * needed size, knowing that the whole attribute * size has been checked to be <= 0x40000. */ intlth = (sle64_to_cpu(a->data_size) - total + vol->cluster_size - 1) >> vol->cluster_size_bits; if (rl[i].length < intlth) intlth = rl[i].length; intbuf = (u8*)ntfs_malloc(intlth << vol->cluster_size_bits); if (!intbuf) { free(rl); return 0; } /* * FIXME: If compressed file: Only read if lcn != -1. * Otherwise, we are dealing with a sparse run and we * just memset the user buffer to 0 for the length of * the run, which should be 16 (= compression unit * size). * FIXME: Really only when file is compressed, or can * we have sparse runs in uncompressed files as well? * - Yes we can, in sparse files! But not necessarily * size of 16, just run length. */ r = ntfs_pread(vol->dev, rl[i].lcn << vol->cluster_size_bits, intlth << vol->cluster_size_bits, intbuf); if (r != intlth << vol->cluster_size_bits) { #define ESTR "Error reading attribute value" if (r == -1) ntfs_log_perror(ESTR); else if (r < intlth << vol->cluster_size_bits) { ntfs_log_debug(ESTR ": Ran out of input data.\n"); errno = EIO; } else { ntfs_log_debug(ESTR ": unknown error\n"); errno = EIO; } #undef ESTR free(rl); free(intbuf); return 0; } memcpy(b + total, intbuf, sle64_to_cpu(a->data_size) - total); free(intbuf); total = sle64_to_cpu(a->data_size); break; } /* * FIXME: If compressed file: Only read if lcn != -1. * Otherwise, we are dealing with a sparse run and we just * memset the user buffer to 0 for the length of the run, which * should be 16 (= compression unit size). * FIXME: Really only when file is compressed, or can * we have sparse runs in uncompressed files as well? * - Yes we can, in sparse files! But not necessarily size of * 16, just run length. */ r = ntfs_pread(vol->dev, rl[i].lcn << vol->cluster_size_bits, rl[i].length << vol->cluster_size_bits, b + total); if (r != rl[i].length << vol->cluster_size_bits) { #define ESTR "Error reading attribute value" if (r == -1) ntfs_log_perror(ESTR); else if (r < rl[i].length << vol->cluster_size_bits) { ntfs_log_debug(ESTR ": Ran out of input data.\n"); errno = EIO; } else { ntfs_log_debug(ESTR ": unknown error\n"); errno = EIO; } #undef ESTR free(rl); return 0; } total += r; } free(rl); return total; } /* Already cleaned up code below, but still look for FIXME:... */ /** * __ntfs_attr_init - primary initialization of an ntfs attribute structure * @na: ntfs attribute to initialize * @ni: ntfs inode with which to initialize the ntfs attribute * @type: attribute type * @name: attribute name in little endian Unicode or NULL * @name_len: length of attribute @name in Unicode characters (if @name given) * * Initialize the ntfs attribute @na with @ni, @type, @name, and @name_len. */ static void __ntfs_attr_init(ntfs_attr *na, ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, const u32 name_len) { na->rl = NULL; na->ni = ni; na->type = type; na->name = name; if (name) na->name_len = name_len; else na->name_len = 0; } /** * ntfs_attr_init - initialize an ntfs_attr with data sizes and status * @na: * @non_resident: * @compressed: * @encrypted: * @sparse: * @allocated_size: * @data_size: * @initialized_size: * @compressed_size: * @compression_unit: * * Final initialization for an ntfs attribute. */ void ntfs_attr_init(ntfs_attr *na, const BOOL non_resident, const ATTR_FLAGS data_flags, const BOOL encrypted, const BOOL sparse, const s64 allocated_size, const s64 data_size, const s64 initialized_size, const s64 compressed_size, const u8 compression_unit) { if (!NAttrInitialized(na)) { na->data_flags = data_flags; if (non_resident) NAttrSetNonResident(na); if (data_flags & ATTR_COMPRESSION_MASK) NAttrSetCompressed(na); if (encrypted) NAttrSetEncrypted(na); if (sparse) NAttrSetSparse(na); na->allocated_size = allocated_size; na->data_size = data_size; na->initialized_size = initialized_size; if ((data_flags & ATTR_COMPRESSION_MASK) || sparse) { ntfs_volume *vol = na->ni->vol; na->compressed_size = compressed_size; na->compression_block_clusters = 1 << compression_unit; na->compression_block_size = 1 << (compression_unit + vol->cluster_size_bits); na->compression_block_size_bits = ffs( na->compression_block_size) - 1; } NAttrSetInitialized(na); } } /** * ntfs_attr_open - open an ntfs attribute for access * @ni: open ntfs inode in which the ntfs attribute resides * @type: attribute type * @name: attribute name in little endian Unicode or AT_UNNAMED or NULL * @name_len: length of attribute @name in Unicode characters (if @name given) * * Allocate a new ntfs attribute structure, initialize it with @ni, @type, * @name, and @name_len, then return it. Return NULL on error with * errno set to the error code. * * If @name is AT_UNNAMED look specifically for an unnamed attribute. If you * do not care whether the attribute is named or not set @name to NULL. In * both those cases @name_len is not used at all. */ ntfs_attr *ntfs_attr_open(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len) { ntfs_attr_search_ctx *ctx; ntfs_attr *na = NULL; ntfschar *newname = NULL; ATTR_RECORD *a; le16 cs; ntfs_log_enter("Entering for inode %lld, attr 0x%x.\n", (unsigned long long)ni->mft_no, le32_to_cpu(type)); if (!ni || !ni->vol || !ni->mrec) { errno = EINVAL; goto out; } na = ntfs_calloc(sizeof(ntfs_attr)); if (!na) goto out; if (!name_len) name = (ntfschar*)NULL; if (name && name != AT_UNNAMED && name != NTFS_INDEX_I30) { /* A null char leads to a short name and unallocated bytes */ if (ntfs_ucsnlen(name, name_len) != name_len) { ntfs_log_error("Null character in attribute name" " of inode %lld\n",(long long)ni->mft_no); goto err_out; } name = ntfs_ucsndup(name, name_len); if (!name) goto err_out; newname = name; } ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) goto err_out; if (ntfs_attr_lookup(type, name, name_len, 0, 0, NULL, 0, ctx)) goto put_err_out; a = ctx->attr; if (!name) { if (a->name_length) { ntfschar *attr_name; attr_name = (ntfschar*)((u8*)a + le16_to_cpu(a->name_offset)); /* A null character leads to illegal memory access */ if (ntfs_ucsnlen(attr_name, a->name_length) != a->name_length) { ntfs_log_error("Null character in attribute" " name in inode %lld\n", (long long)ni->mft_no); goto put_err_out; } name = ntfs_ucsndup(attr_name, a->name_length); if (!name) goto put_err_out; newname = name; name_len = a->name_length; } else { name = AT_UNNAMED; name_len = 0; } } __ntfs_attr_init(na, ni, type, name, name_len); /* * Wipe the flags in case they are not zero for an attribute list * attribute. Windows does not complain about invalid flags and chkdsk * does not detect or fix them so we need to cope with it, too. */ if (type == AT_ATTRIBUTE_LIST) a->flags = const_cpu_to_le16(0); if ((type == AT_DATA) && (a->non_resident ? !a->initialized_size : !a->value_length)) { /* * Define/redefine the compression state if stream is * empty, based on the compression mark on parent * directory (for unnamed data streams) or on current * inode (for named data streams). The compression mark * may change any time, the compression state can only * change when stream is wiped out. * * Also prevent compression on NTFS version < 3.0 * or cluster size > 4K or compression is disabled */ a->flags &= ~ATTR_COMPRESSION_MASK; if ((ni->flags & FILE_ATTR_COMPRESSED) && (ni->vol->major_ver >= 3) && NVolCompression(ni->vol) && (ni->vol->cluster_size <= MAX_COMPRESSION_CLUSTER_SIZE)) a->flags |= ATTR_IS_COMPRESSED; } cs = a->flags & (ATTR_IS_COMPRESSED | ATTR_IS_SPARSE); /* a file may be sparse though its unnamed data is not (cf $UsnJrnl) */ if (na->type == AT_DATA && na->name == AT_UNNAMED && (((a->flags & ATTR_IS_SPARSE) && !NAttrSparse(na)) || (!(a->flags & ATTR_IS_ENCRYPTED) != !NAttrEncrypted(na)))) { errno = EIO; ntfs_log_perror("Inode %lld has corrupt attribute flags " "(0x%x <> 0x%x)",(unsigned long long)ni->mft_no, le16_to_cpu(a->flags), le32_to_cpu(na->ni->flags)); goto put_err_out; } if (a->non_resident) { if (((a->flags & ATTR_COMPRESSION_MASK) || a->compression_unit) && (ni->vol->major_ver < 3)) { errno = EIO; ntfs_log_perror("Compressed inode %lld not allowed" " on NTFS %d.%d", (unsigned long long)ni->mft_no, ni->vol->major_ver, ni->vol->major_ver); goto put_err_out; } if ((a->flags & ATTR_COMPRESSION_MASK) && !a->compression_unit) { errno = EIO; ntfs_log_perror("Compressed inode %lld attr 0x%x has " "no compression unit", (unsigned long long)ni->mft_no, le32_to_cpu(type)); goto put_err_out; } if ((a->flags & ATTR_COMPRESSION_MASK) && (a->compression_unit != STANDARD_COMPRESSION_UNIT)) { errno = EIO; ntfs_log_perror("Compressed inode %lld attr 0x%lx has " "an unsupported compression unit %d", (unsigned long long)ni->mft_no, (long)le32_to_cpu(type), (int)a->compression_unit); goto put_err_out; } ntfs_attr_init(na, TRUE, a->flags, a->flags & ATTR_IS_ENCRYPTED, a->flags & ATTR_IS_SPARSE, sle64_to_cpu(a->allocated_size), sle64_to_cpu(a->data_size), sle64_to_cpu(a->initialized_size), cs ? sle64_to_cpu(a->compressed_size) : 0, cs ? a->compression_unit : 0); } else { s64 l = le32_to_cpu(a->value_length); ntfs_attr_init(na, FALSE, a->flags, a->flags & ATTR_IS_ENCRYPTED, a->flags & ATTR_IS_SPARSE, (l + 7) & ~7, l, l, cs ? (l + 7) & ~7 : 0, 0); } ntfs_attr_put_search_ctx(ctx); out: ntfs_log_leave("\n"); return na; put_err_out: ntfs_attr_put_search_ctx(ctx); err_out: free(newname); free(na); na = NULL; goto out; } /** * ntfs_attr_close - free an ntfs attribute structure * @na: ntfs attribute structure to free * * Release all memory associated with the ntfs attribute @na and then release * @na itself. */ void ntfs_attr_close(ntfs_attr *na) { if (!na) return; if (NAttrNonResident(na) && na->rl) free(na->rl); /* Don't release if using an internal constant. */ if (na->name != AT_UNNAMED && na->name != NTFS_INDEX_I30 && na->name != STREAM_SDS) free(na->name); free(na); } /** * ntfs_attr_map_runlist - map (a part of) a runlist of an ntfs attribute * @na: ntfs attribute for which to map (part of) a runlist * @vcn: map runlist part containing this vcn * * Map the part of a runlist containing the @vcn of the ntfs attribute @na. * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_attr_map_runlist(ntfs_attr *na, VCN vcn) { LCN lcn; ntfs_attr_search_ctx *ctx; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, vcn 0x%llx.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)vcn); lcn = ntfs_rl_vcn_to_lcn(na->rl, vcn); if (lcn >= 0 || lcn == LCN_HOLE || lcn == LCN_ENOENT) return 0; ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; /* Find the attribute in the mft record. */ if (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, vcn, NULL, 0, ctx)) { runlist_element *rl; /* Decode the runlist. */ rl = ntfs_mapping_pairs_decompress(na->ni->vol, ctx->attr, na->rl); if (rl) { na->rl = rl; ntfs_attr_put_search_ctx(ctx); return 0; } } ntfs_attr_put_search_ctx(ctx); return -1; } #if PARTIAL_RUNLIST_UPDATING /* * Map the runlist of an attribute from some point to the end * * Returns 0 if success, * -1 if it failed (errno telling why) */ static int ntfs_attr_map_partial_runlist(ntfs_attr *na, VCN vcn) { VCN last_vcn; VCN highest_vcn; VCN needed; runlist_element *rl; ATTR_RECORD *a; BOOL startseen; ntfs_attr_search_ctx *ctx; BOOL done; BOOL newrunlist; if (NAttrFullyMapped(na)) return 0; ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; /* Get the last vcn in the attribute. */ last_vcn = na->allocated_size >> na->ni->vol->cluster_size_bits; needed = vcn; highest_vcn = 0; startseen = FALSE; done = FALSE; rl = (runlist_element*)NULL; do { newrunlist = FALSE; /* Find the attribute in the mft record. */ if (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, needed, NULL, 0, ctx)) { a = ctx->attr; /* Decode and merge the runlist. */ if (ntfs_rl_vcn_to_lcn(na->rl, needed) == LCN_RL_NOT_MAPPED) { rl = ntfs_mapping_pairs_decompress(na->ni->vol, a, na->rl); newrunlist = TRUE; } else rl = na->rl; if (rl) { na->rl = rl; highest_vcn = sle64_to_cpu(a->highest_vcn); if (highest_vcn < needed) { /* corruption detection on unchanged runlists */ if (newrunlist && ((highest_vcn + 1) < last_vcn)) { ntfs_log_error("Corrupt attribute list\n"); rl = (runlist_element*)NULL; errno = EIO; } done = TRUE; } needed = highest_vcn + 1; if (!a->lowest_vcn) startseen = TRUE; } } else { done = TRUE; } } while (rl && !done && (needed < last_vcn)); ntfs_attr_put_search_ctx(ctx); /* * Make sure we reached the end, unless the last * runlist was modified earlier (using HOLES_DELAY * leads to have a visibility over attributes which * have not yet been fully updated) */ if (done && newrunlist && (needed < last_vcn)) { ntfs_log_error("End of runlist not reached\n"); rl = (runlist_element*)NULL; errno = EIO; } /* mark fully mapped if we did so */ if (rl && startseen) NAttrSetFullyMapped(na); return (rl ? 0 : -1); } #endif /** * ntfs_attr_map_whole_runlist - map the whole runlist of an ntfs attribute * @na: ntfs attribute for which to map the runlist * * Map the whole runlist of the ntfs attribute @na. For an attribute made up * of only one attribute extent this is the same as calling * ntfs_attr_map_runlist(na, 0) but for an attribute with multiple extents this * will map the runlist fragments from each of the extents thus giving access * to the entirety of the disk allocation of an attribute. * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_attr_map_whole_runlist(ntfs_attr *na) { VCN next_vcn, last_vcn, highest_vcn; ntfs_attr_search_ctx *ctx; ntfs_volume *vol = na->ni->vol; ATTR_RECORD *a; int ret = -1; int not_mapped; ntfs_log_enter("Entering for inode %llu, attr 0x%x.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); /* avoid multiple full runlist mappings */ if (NAttrFullyMapped(na)) { ret = 0; goto out; } ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) goto out; /* Map all attribute extents one by one. */ next_vcn = last_vcn = highest_vcn = 0; a = NULL; while (1) { runlist_element *rl; not_mapped = 0; if (ntfs_rl_vcn_to_lcn(na->rl, next_vcn) == LCN_RL_NOT_MAPPED) not_mapped = 1; if (ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, next_vcn, NULL, 0, ctx)) break; a = ctx->attr; if (not_mapped) { /* Decode the runlist. */ rl = ntfs_mapping_pairs_decompress(na->ni->vol, a, na->rl); if (!rl) goto err_out; na->rl = rl; } /* Are we in the first extent? */ if (!next_vcn) { if (a->lowest_vcn) { errno = EIO; ntfs_log_perror("First extent of inode %llu " "attribute has non-zero lowest_vcn", (unsigned long long)na->ni->mft_no); goto err_out; } /* Get the last vcn in the attribute. */ last_vcn = sle64_to_cpu(a->allocated_size) >> vol->cluster_size_bits; } /* Get the lowest vcn for the next extent. */ highest_vcn = sle64_to_cpu(a->highest_vcn); next_vcn = highest_vcn + 1; /* Only one extent or error, which we catch below. */ if (next_vcn <= 0) { errno = ENOENT; break; } /* Avoid endless loops due to corruption. */ if (next_vcn < sle64_to_cpu(a->lowest_vcn)) { errno = EIO; ntfs_log_perror("Inode %llu has corrupt attribute list", (unsigned long long)na->ni->mft_no); goto err_out; } } if (!a) { ntfs_log_perror("Couldn't find attribute for runlist mapping"); goto err_out; } /* * Cannot check highest_vcn when the last runlist has * been modified earlier, as runlists and sizes may be * updated without highest_vcn being in sync, when * HOLES_DELAY is used */ if (not_mapped && highest_vcn && highest_vcn != last_vcn - 1) { errno = EIO; ntfs_log_perror("Failed to load full runlist: inode: %llu " "highest_vcn: 0x%llx last_vcn: 0x%llx", (unsigned long long)na->ni->mft_no, (long long)highest_vcn, (long long)last_vcn); goto err_out; } if (errno == ENOENT) { NAttrSetFullyMapped(na); ret = 0; } err_out: ntfs_attr_put_search_ctx(ctx); out: ntfs_log_leave("\n"); return ret; } /** * ntfs_attr_vcn_to_lcn - convert a vcn into a lcn given an ntfs attribute * @na: ntfs attribute whose runlist to use for conversion * @vcn: vcn to convert * * Convert the virtual cluster number @vcn of an attribute into a logical * cluster number (lcn) of a device using the runlist @na->rl to map vcns to * their corresponding lcns. * * If the @vcn is not mapped yet, attempt to map the attribute extent * containing the @vcn and retry the vcn to lcn conversion. * * Since lcns must be >= 0, we use negative return values with special meaning: * * Return value Meaning / Description * ========================================== * -1 = LCN_HOLE Hole / not allocated on disk. * -3 = LCN_ENOENT There is no such vcn in the attribute. * -4 = LCN_EINVAL Input parameter error. * -5 = LCN_EIO Corrupt fs, disk i/o error, or not enough memory. */ LCN ntfs_attr_vcn_to_lcn(ntfs_attr *na, const VCN vcn) { LCN lcn; BOOL is_retry = FALSE; if (!na || !NAttrNonResident(na) || vcn < 0) return (LCN)LCN_EINVAL; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); retry: /* Convert vcn to lcn. If that fails map the runlist and retry once. */ lcn = ntfs_rl_vcn_to_lcn(na->rl, vcn); if (lcn >= 0) return lcn; if (!is_retry && !ntfs_attr_map_runlist(na, vcn)) { is_retry = TRUE; goto retry; } /* * If the attempt to map the runlist failed, or we are getting * LCN_RL_NOT_MAPPED despite having mapped the attribute extent * successfully, something is really badly wrong... */ if (!is_retry || lcn == (LCN)LCN_RL_NOT_MAPPED) return (LCN)LCN_EIO; /* lcn contains the appropriate error code. */ return lcn; } /** * ntfs_attr_find_vcn - find a vcn in the runlist of an ntfs attribute * @na: ntfs attribute whose runlist to search * @vcn: vcn to find * * Find the virtual cluster number @vcn in the runlist of the ntfs attribute * @na and return the the address of the runlist element containing the @vcn. * * Note you need to distinguish between the lcn of the returned runlist * element being >= 0 and LCN_HOLE. In the later case you have to return zeroes * on read and allocate clusters on write. You need to update the runlist, the * attribute itself as well as write the modified mft record to disk. * * If there is an error return NULL with errno set to the error code. The * following error codes are defined: * EINVAL Input parameter error. * ENOENT There is no such vcn in the runlist. * ENOMEM Not enough memory. * EIO I/O error or corrupt metadata. */ runlist_element *ntfs_attr_find_vcn(ntfs_attr *na, const VCN vcn) { runlist_element *rl; BOOL is_retry = FALSE; if (!na || !NAttrNonResident(na) || vcn < 0) { errno = EINVAL; return NULL; } ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, vcn %llx\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)vcn); retry: rl = na->rl; if (!rl) goto map_rl; if (vcn < rl[0].vcn) goto map_rl; while (rl->length) { if (vcn < rl[1].vcn) { if (rl->lcn >= (LCN)LCN_HOLE) return rl; break; } rl++; } switch (rl->lcn) { case (LCN)LCN_RL_NOT_MAPPED: goto map_rl; case (LCN)LCN_ENOENT: errno = ENOENT; break; case (LCN)LCN_EINVAL: errno = EINVAL; break; default: errno = EIO; break; } return NULL; map_rl: /* The @vcn is in an unmapped region, map the runlist and retry. */ if (!is_retry && !ntfs_attr_map_runlist(na, vcn)) { is_retry = TRUE; goto retry; } /* * If we already retried or the mapping attempt failed something has * gone badly wrong. EINVAL and ENOENT coming from a failed mapping * attempt are equivalent to errors for us as they should not happen * in our code paths. */ if (is_retry || errno == EINVAL || errno == ENOENT) errno = EIO; return NULL; } /** * ntfs_attr_pread_i - see description at ntfs_attr_pread() */ static s64 ntfs_attr_pread_i(ntfs_attr *na, const s64 pos, s64 count, void *b) { s64 br, to_read, ofs, total, total2, max_read, max_init; ntfs_volume *vol; runlist_element *rl; u16 efs_padding_length; /* Sanity checking arguments is done in ntfs_attr_pread(). */ if ((na->data_flags & ATTR_COMPRESSION_MASK) && NAttrNonResident(na)) { if ((na->data_flags & ATTR_COMPRESSION_MASK) == ATTR_IS_COMPRESSED) return ntfs_compressed_attr_pread(na, pos, count, b); else { /* compression mode not supported */ errno = EOPNOTSUPP; return -1; } } /* * Encrypted non-resident attributes are not supported. We return * access denied, which is what Windows NT4 does, too. * However, allow if mounted with efs_raw option */ vol = na->ni->vol; if (!vol->efs_raw && NAttrEncrypted(na) && NAttrNonResident(na)) { errno = EACCES; return -1; } if (!count) return 0; /* * Truncate reads beyond end of attribute, * but round to next 512 byte boundary for encrypted * attributes with efs_raw mount option */ max_read = na->data_size; max_init = na->initialized_size; if (na->ni->vol->efs_raw && (na->data_flags & ATTR_IS_ENCRYPTED) && NAttrNonResident(na)) { if (na->data_size != na->initialized_size) { ntfs_log_error("uninitialized encrypted file not supported\n"); errno = EINVAL; return -1; } max_init = max_read = ((na->data_size + 511) & ~511) + 2; } if (pos + count > max_read) { if (pos >= max_read) return 0; count = max_read - pos; } /* If it is a resident attribute, get the value from the mft record. */ if (!NAttrNonResident(na)) { ntfs_attr_search_ctx *ctx; char *val; ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; if (ntfs_attr_lookup(na->type, na->name, na->name_len, 0, 0, NULL, 0, ctx)) { res_err_out: ntfs_attr_put_search_ctx(ctx); return -1; } val = (char*)ctx->attr + le16_to_cpu(ctx->attr->value_offset); if (val < (char*)ctx->attr || val + le32_to_cpu(ctx->attr->value_length) > (char*)ctx->mrec + vol->mft_record_size) { errno = EIO; ntfs_log_perror("%s: Sanity check failed", __FUNCTION__); goto res_err_out; } memcpy(b, val + pos, count); ntfs_attr_put_search_ctx(ctx); return count; } total = total2 = 0; /* Zero out reads beyond initialized size. */ if (pos + count > max_init) { if (pos >= max_init) { memset(b, 0, count); return count; } total2 = pos + count - max_init; count -= total2; memset((u8*)b + count, 0, total2); } /* * for encrypted non-resident attributes with efs_raw set * the last two bytes aren't read from disk but contain * the number of padding bytes so original size can be * restored */ if (na->ni->vol->efs_raw && (na->data_flags & ATTR_IS_ENCRYPTED) && ((pos + count) > max_init-2)) { efs_padding_length = 511 - ((na->data_size - 1) & 511); if (pos+count == max_init) { if (count == 1) { *((u8*)b+count-1) = (u8)(efs_padding_length >> 8); count--; total2++; } else { *(le16*)((u8*)b+count-2) = cpu_to_le16(efs_padding_length); count -= 2; total2 +=2; } } else { *((u8*)b+count-1) = (u8)(efs_padding_length & 0xff); count--; total2++; } } /* Find the runlist element containing the vcn. */ rl = ntfs_attr_find_vcn(na, pos >> vol->cluster_size_bits); if (!rl) { /* * If the vcn is not present it is an out of bounds read. * However, we already truncated the read to the data_size, * so getting this here is an error. */ if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN #1", __FUNCTION__); } return -1; } /* * Gather the requested data into the linear destination buffer. Note, * a partial final vcn is taken care of by the @count capping of read * length. */ ofs = pos - (rl->vcn << vol->cluster_size_bits); for (; count; rl++, ofs = 0) { if (rl->lcn == LCN_RL_NOT_MAPPED) { rl = ntfs_attr_find_vcn(na, rl->vcn); if (!rl) { if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN #2", __FUNCTION__); } goto rl_err_out; } /* Needed for case when runs merged. */ ofs = pos + total - (rl->vcn << vol->cluster_size_bits); } if (!rl->length) { errno = EIO; ntfs_log_perror("%s: Zero run length", __FUNCTION__); goto rl_err_out; } if (rl->lcn < (LCN)0) { if (rl->lcn != (LCN)LCN_HOLE) { ntfs_log_perror("%s: Bad run (%lld)", __FUNCTION__, (long long)rl->lcn); goto rl_err_out; } /* It is a hole, just zero the matching @b range. */ to_read = min(count, (rl->length << vol->cluster_size_bits) - ofs); memset(b, 0, to_read); /* Update progress counters. */ total += to_read; count -= to_read; b = (u8*)b + to_read; continue; } /* It is a real lcn, read it into @dst. */ to_read = min(count, (rl->length << vol->cluster_size_bits) - ofs); retry: ntfs_log_trace("Reading %lld bytes from vcn %lld, lcn %lld, ofs" " %lld.\n", (long long)to_read, (long long)rl->vcn, (long long )rl->lcn, (long long)ofs); br = ntfs_pread(vol->dev, (rl->lcn << vol->cluster_size_bits) + ofs, to_read, b); /* If everything ok, update progress counters and continue. */ if (br > 0) { total += br; count -= br; b = (u8*)b + br; } if (br == to_read) continue; /* If the syscall was interrupted, try again. */ if (br == (s64)-1 && errno == EINTR) goto retry; if (total) return total; if (!br) errno = EIO; ntfs_log_perror("%s: ntfs_pread failed", __FUNCTION__); return -1; } /* Finally, return the number of bytes read. */ return total + total2; rl_err_out: if (total) return total; errno = EIO; return -1; } /** * ntfs_attr_pread - read from an attribute specified by an ntfs_attr structure * @na: ntfs attribute to read from * @pos: byte position in the attribute to begin reading from * @count: number of bytes to read * @b: output data buffer * * This function will read @count bytes starting at offset @pos from the ntfs * attribute @na into the data buffer @b. * * On success, return the number of successfully read bytes. If this number is * lower than @count this means that the read reached end of file or that an * error was encountered during the read so that the read is partial. 0 means * end of file or nothing was read (also return 0 when @count is 0). * * On error and nothing has been read, return -1 with errno set appropriately * to the return code of ntfs_pread(), or to EINVAL in case of invalid * arguments. */ s64 ntfs_attr_pread(ntfs_attr *na, const s64 pos, s64 count, void *b) { s64 ret; if (!na || !na->ni || !na->ni->vol || !b || pos < 0 || count < 0) { errno = EINVAL; ntfs_log_perror("%s: na=%p b=%p pos=%lld count=%lld", __FUNCTION__, na, b, (long long)pos, (long long)count); return -1; } ntfs_log_enter("Entering for inode %lld attr 0x%x pos %lld count " "%lld\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)pos, (long long)count); ret = ntfs_attr_pread_i(na, pos, count, b); ntfs_log_leave("\n"); return ret; } static int ntfs_attr_fill_zero(ntfs_attr *na, s64 pos, s64 count) { char *buf; s64 written, size, end = pos + count; s64 ofsi; const runlist_element *rli; ntfs_volume *vol; int ret = -1; ntfs_log_trace("pos %lld, count %lld\n", (long long)pos, (long long)count); if (!na || pos < 0 || count < 0) { errno = EINVAL; goto err_out; } buf = ntfs_calloc(NTFS_BUF_SIZE); if (!buf) goto err_out; rli = na->rl; ofsi = 0; vol = na->ni->vol; while (pos < end) { while (rli->length && (ofsi + (rli->length << vol->cluster_size_bits) <= pos)) { ofsi += (rli->length << vol->cluster_size_bits); rli++; } size = min(end - pos, NTFS_BUF_SIZE); /* * If the zeroed block is fully within a hole, * we need not write anything, so advance as far * as possible within the hole. */ if ((rli->lcn == (LCN)LCN_HOLE) && (ofsi <= pos) && (ofsi + (rli->length << vol->cluster_size_bits) >= (pos + size))) { size = min(end - pos, ofsi - pos + (rli->length << vol->cluster_size_bits)); pos += size; } else { written = ntfs_rl_pwrite(vol, rli, ofsi, pos, size, buf); if (written <= 0) { ntfs_log_perror("Failed to zero space"); goto err_free; } pos += written; } } ret = 0; err_free: free(buf); err_out: return ret; } static int ntfs_attr_fill_hole(ntfs_attr *na, s64 count, s64 *ofs, runlist_element **rl, VCN *update_from) { s64 to_write; s64 need; ntfs_volume *vol = na->ni->vol; int eo, ret = -1; runlist *rlc; LCN lcn_seek_from = -1; VCN cur_vcn, from_vcn; if (na->ni->mft_no == FILE_Bitmap) { /* * Filling a hole in the main bitmap implies allocating * clusters, which is likely to imply updating the * bitmap in a cluster being allocated. * Not supported now, could lead to endless recursions. */ ntfs_log_error("Corrupt $BitMap not fully allocated\n"); errno = EIO; goto err_out; } to_write = min(count, ((*rl)->length << vol->cluster_size_bits) - *ofs); cur_vcn = (*rl)->vcn; from_vcn = (*rl)->vcn + (*ofs >> vol->cluster_size_bits); ntfs_log_trace("count: %lld, cur_vcn: %lld, from: %lld, to: %lld, ofs: " "%lld\n", (long long)count, (long long)cur_vcn, (long long)from_vcn, (long long)to_write, (long long)*ofs); /* Map the runlist to be able to update mapping pairs later. */ #if PARTIAL_RUNLIST_UPDATING if (!na->rl) { if (ntfs_attr_map_whole_runlist(na)) goto err_out; } else { /* make sure the run ahead of hole is mapped */ if ((*rl)->lcn == LCN_HOLE) { if (ntfs_attr_map_partial_runlist(na, (cur_vcn ? cur_vcn - 1 : cur_vcn))) goto err_out; } } #else if (ntfs_attr_map_whole_runlist(na)) goto err_out; #endif /* Restore @*rl, it probably get lost during runlist mapping. */ *rl = ntfs_attr_find_vcn(na, cur_vcn); if (!*rl) { ntfs_log_error("Failed to find run after mapping runlist. " "Please report to %s.\n", NTFS_DEV_LIST); errno = EIO; goto err_out; } /* Search backwards to find the best lcn to start seek from. */ rlc = *rl; while (rlc->vcn) { rlc--; if (rlc->lcn >= 0) { /* * avoid fragmenting a compressed file * Windows does not do that, and that may * not be desirable for files which can * be updated */ if (na->data_flags & ATTR_COMPRESSION_MASK) lcn_seek_from = rlc->lcn + rlc->length; else lcn_seek_from = rlc->lcn + (from_vcn - rlc->vcn); break; } } if (lcn_seek_from == -1) { /* Backwards search failed, search forwards. */ rlc = *rl; while (rlc->length) { rlc++; if (rlc->lcn >= 0) { lcn_seek_from = rlc->lcn - (rlc->vcn - from_vcn); if (lcn_seek_from < -1) lcn_seek_from = -1; break; } } } need = ((*ofs + to_write - 1) >> vol->cluster_size_bits) + 1 + (*rl)->vcn - from_vcn; if ((na->data_flags & ATTR_COMPRESSION_MASK) && (need < na->compression_block_clusters)) { /* * for a compressed file, be sure to allocate the full * compression block, as we may need space to decompress * existing compressed data. * So allocate the space common to compression block * and existing hole. */ VCN alloc_vcn; if ((from_vcn & -na->compression_block_clusters) <= (*rl)->vcn) alloc_vcn = (*rl)->vcn; else alloc_vcn = from_vcn & -na->compression_block_clusters; need = (alloc_vcn | (na->compression_block_clusters - 1)) + 1 - alloc_vcn; if (need > (*rl)->length) { ntfs_log_error("Cannot allocate %lld clusters" " within a hole of %lld\n", (long long)need, (long long)(*rl)->length); errno = EIO; goto err_out; } rlc = ntfs_cluster_alloc(vol, alloc_vcn, need, lcn_seek_from, DATA_ZONE); } else rlc = ntfs_cluster_alloc(vol, from_vcn, need, lcn_seek_from, DATA_ZONE); if (!rlc) goto err_out; if (na->data_flags & (ATTR_COMPRESSION_MASK | ATTR_IS_SPARSE)) na->compressed_size += need << vol->cluster_size_bits; *rl = ntfs_runlists_merge(na->rl, rlc); NAttrSetRunlistDirty(na); /* * For a compressed attribute, we must be sure there are two * available entries, so reserve them before it gets too late. */ if (*rl && (na->data_flags & ATTR_COMPRESSION_MASK)) { runlist_element *oldrl = na->rl; na->rl = *rl; *rl = ntfs_rl_extend(na,*rl,2); if (!*rl) na->rl = oldrl; /* restore to original if failed */ } if (!*rl) { eo = errno; ntfs_log_perror("Failed to merge runlists"); if (ntfs_cluster_free_from_rl(vol, rlc)) { ntfs_log_perror("Failed to free hot clusters. " "Please run chkdsk /f"); } errno = eo; goto err_out; } na->unused_runs = 2; na->rl = *rl; if ((*update_from == -1) || (from_vcn < *update_from)) *update_from = from_vcn; *rl = ntfs_attr_find_vcn(na, cur_vcn); if (!*rl) { /* * It's definitely a BUG, if we failed to find @cur_vcn, because * we missed it during instantiating of the hole. */ ntfs_log_error("Failed to find run after hole instantiation. " "Please report to %s.\n", NTFS_DEV_LIST); errno = EIO; goto err_out; } /* If leaved part of the hole go to the next run. */ if ((*rl)->lcn < 0) (*rl)++; /* Now LCN shoudn't be less than 0. */ if ((*rl)->lcn < 0) { ntfs_log_error("BUG! LCN is lesser than 0. " "Please report to the %s.\n", NTFS_DEV_LIST); errno = EIO; goto err_out; } if (*ofs) { /* Clear non-sparse region from @cur_vcn to @*ofs. */ if (ntfs_attr_fill_zero(na, cur_vcn << vol->cluster_size_bits, *ofs)) goto err_out; } if ((*rl)->vcn < cur_vcn) { /* * Clusters that replaced hole are merged with * previous run, so we need to update offset. */ *ofs += (cur_vcn - (*rl)->vcn) << vol->cluster_size_bits; } if ((*rl)->vcn > cur_vcn) { /* * We left part of the hole, so we need to update offset */ *ofs -= ((*rl)->vcn - cur_vcn) << vol->cluster_size_bits; } ret = 0; err_out: return ret; } static int stuff_hole(ntfs_attr *na, const s64 pos); /* * Split an existing hole for overwriting with data * The hole may have to be split into two or three parts, so * that the overwritten part fits within a single compression block * * No cluster allocation is needed, this will be done later in * standard hole filling, hence no need to reserve runs for * future needs. * * Returns the number of clusters with existing compressed data * in the compression block to be written to * (or the full block, if it was a full hole) * -1 if there were an error */ static int split_compressed_hole(ntfs_attr *na, runlist_element **prl, s64 pos, s64 count, VCN *update_from) { int compressed_part; int cluster_size_bits = na->ni->vol->cluster_size_bits; runlist_element *rl = *prl; compressed_part = na->compression_block_clusters; /* reserve entries in runlist if we have to split */ if (rl->length > na->compression_block_clusters) { *prl = ntfs_rl_extend(na,*prl,2); if (!*prl) { compressed_part = -1; } else { rl = *prl; na->unused_runs = 2; } } if (*prl && (rl->length > na->compression_block_clusters)) { /* * Locate the update part relative to beginning of * current run */ int beginwrite = (pos >> cluster_size_bits) - rl->vcn; s32 endblock = (((pos + count - 1) >> cluster_size_bits) | (na->compression_block_clusters - 1)) + 1 - rl->vcn; compressed_part = na->compression_block_clusters - (rl->length & (na->compression_block_clusters - 1)); if ((beginwrite + compressed_part) >= na->compression_block_clusters) compressed_part = na->compression_block_clusters; /* * if the run ends beyond end of needed block * we have to split the run */ if (endblock < rl[0].length) { runlist_element *xrl; int n; /* * we have to split into three parts if the run * does not end within the first compression block. * This means the hole begins before the * compression block. */ if (endblock > na->compression_block_clusters) { if (na->unused_runs < 2) { ntfs_log_error("No free run, case 1\n"); } na->unused_runs -= 2; xrl = rl; n = 0; while (xrl->length) { xrl++; n++; } do { xrl[2] = *xrl; xrl--; } while (xrl != rl); rl[1].length = na->compression_block_clusters; rl[2].length = rl[0].length - endblock; rl[0].length = endblock - na->compression_block_clusters; rl[1].lcn = LCN_HOLE; rl[2].lcn = LCN_HOLE; rl[1].vcn = rl[0].vcn + rl[0].length; rl[2].vcn = rl[1].vcn + na->compression_block_clusters; rl = ++(*prl); } else { /* * split into two parts and use the * first one */ if (!na->unused_runs) { ntfs_log_error("No free run, case 2\n"); } na->unused_runs--; xrl = rl; n = 0; while (xrl->length) { xrl++; n++; } do { xrl[1] = *xrl; xrl--; } while (xrl != rl); if (beginwrite < endblock) { /* we will write into the first part of hole */ rl[1].length = rl[0].length - endblock; rl[0].length = endblock; rl[1].vcn = rl[0].vcn + rl[0].length; rl[1].lcn = LCN_HOLE; } else { /* we will write into the second part of hole */ // impossible ? rl[1].length = rl[0].length - endblock; rl[0].length = endblock; rl[1].vcn = rl[0].vcn + rl[0].length; rl[1].lcn = LCN_HOLE; rl = ++(*prl); } } } else { if (rl[1].length) { runlist_element *xrl; int n; /* * split into two parts and use the * last one */ if (!na->unused_runs) { ntfs_log_error("No free run, case 4\n"); } na->unused_runs--; xrl = rl; n = 0; while (xrl->length) { xrl++; n++; } do { xrl[1] = *xrl; xrl--; } while (xrl != rl); } else { rl[2].lcn = rl[1].lcn; rl[2].vcn = rl[1].vcn; rl[2].length = rl[1].length; } rl[1].vcn -= na->compression_block_clusters; rl[1].lcn = LCN_HOLE; rl[1].length = na->compression_block_clusters; rl[0].length -= na->compression_block_clusters; if (pos >= (rl[1].vcn << cluster_size_bits)) { rl = ++(*prl); } } NAttrSetRunlistDirty(na); if ((*update_from == -1) || ((*prl)->vcn < *update_from)) *update_from = (*prl)->vcn; } return (compressed_part); } /* * Borrow space from adjacent hole for appending data * The hole may have to be split so that the end of hole is not * affected by cluster allocation and overwriting * Cluster allocation is needed for the overwritten compression block * * Must always leave two unused entries in the runlist * * Returns the number of clusters with existing compressed data * in the compression block to be written to * -1 if there were an error */ static int borrow_from_hole(ntfs_attr *na, runlist_element **prl, s64 pos, s64 count, VCN *update_from, BOOL wasnonresident) { int compressed_part = 0; int cluster_size_bits = na->ni->vol->cluster_size_bits; runlist_element *rl = *prl; s32 endblock; long long allocated; runlist_element *zrl; int irl; BOOL undecided; BOOL nothole; /* check whether the compression block is fully allocated */ endblock = (((pos + count - 1) >> cluster_size_bits) | (na->compression_block_clusters - 1)) + 1 - rl->vcn; allocated = 0; zrl = rl; irl = 0; while (zrl->length && (zrl->lcn >= 0) && (allocated < endblock)) { allocated += zrl->length; zrl++; irl++; } undecided = (allocated < endblock) && (zrl->lcn == LCN_RL_NOT_MAPPED); nothole = (allocated >= endblock) || (zrl->lcn != LCN_HOLE); if (undecided || nothole) { runlist_element *orl = na->rl; s64 olcn = (*prl)->lcn; #if PARTIAL_RUNLIST_UPDATING VCN prevblock; #endif /* * Map the runlist, unless it has not been created. * If appending data, a partial mapping from the * end of previous block will do. */ irl = *prl - na->rl; #if PARTIAL_RUNLIST_UPDATING prevblock = pos >> cluster_size_bits; if (prevblock) prevblock--; if (!NAttrBeingNonResident(na) && (NAttrDataAppending(na) ? ntfs_attr_map_partial_runlist(na,prevblock) : ntfs_attr_map_whole_runlist(na))) { #else if (!NAttrBeingNonResident(na) && ntfs_attr_map_whole_runlist(na)) { #endif rl = (runlist_element*)NULL; } else { /* * Mapping the runlist may cause its relocation, * and relocation may be at the same place with * relocated contents. * Have to find the current run again when this * happens. */ if ((na->rl != orl) || ((*prl)->lcn != olcn)) { zrl = &na->rl[irl]; while (zrl->length && (zrl->lcn != olcn)) zrl++; *prl = zrl; } if (!(*prl)->length) { ntfs_log_error("Mapped run not found," " inode %lld lcn 0x%llx\n", (long long)na->ni->mft_no, (long long)olcn); rl = (runlist_element*)NULL; } else { rl = ntfs_rl_extend(na,*prl,2); na->unused_runs = 2; } } *prl = rl; if (rl && undecided) { allocated = 0; zrl = rl; irl = 0; while (zrl->length && (zrl->lcn >= 0) && (allocated < endblock)) { allocated += zrl->length; zrl++; irl++; } } } /* * compression block not fully allocated and followed * by a hole : we must allocate in the hole. */ if (rl && (allocated < endblock) && (zrl->lcn == LCN_HOLE)) { s64 xofs; /* * split the hole if not fully needed */ if ((allocated + zrl->length) > endblock) { runlist_element *xrl; *prl = ntfs_rl_extend(na,*prl,1); if (*prl) { /* beware : rl was reallocated */ rl = *prl; zrl = &rl[irl]; na->unused_runs = 0; xrl = zrl; while (xrl->length) xrl++; do { xrl[1] = *xrl; } while (xrl-- != zrl); zrl->length = endblock - allocated; zrl[1].length -= zrl->length; zrl[1].vcn = zrl->vcn + zrl->length; NAttrSetRunlistDirty(na); } } if (*prl) { if (wasnonresident) compressed_part = na->compression_block_clusters - zrl->length; xofs = 0; if (ntfs_attr_fill_hole(na, zrl->length << cluster_size_bits, &xofs, &zrl, update_from)) compressed_part = -1; else { /* go back to initial cluster, now reallocated */ while (zrl->vcn > (pos >> cluster_size_bits)) zrl--; *prl = zrl; } } } if (!*prl) { ntfs_log_error("No elements to borrow from a hole\n"); compressed_part = -1; } else if ((*update_from == -1) || ((*prl)->vcn < *update_from)) *update_from = (*prl)->vcn; return (compressed_part); } static int ntfs_attr_truncate_i(ntfs_attr *na, const s64 newsize, hole_type holes); /** * ntfs_attr_pwrite - positioned write to an ntfs attribute * @na: ntfs attribute to write to * @pos: position in the attribute to write to * @count: number of bytes to write * @b: data buffer to write to disk * * This function will write @count bytes from data buffer @b to ntfs attribute * @na at position @pos. * * On success, return the number of successfully written bytes. If this number * is lower than @count this means that an error was encountered during the * write so that the write is partial. 0 means nothing was written (also return * 0 when @count is 0). * * On error and nothing has been written, return -1 with errno set * appropriately to the return code of ntfs_pwrite(), or to EINVAL in case of * invalid arguments. */ static s64 ntfs_attr_pwrite_i(ntfs_attr *na, const s64 pos, s64 count, const void *b) { s64 written, to_write, ofs, old_initialized_size, old_data_size; s64 total = 0; VCN update_from = -1; ntfs_volume *vol; s64 fullcount; ntfs_attr_search_ctx *ctx = NULL; runlist_element *rl; s64 hole_end; int eo; int compressed_part; struct { unsigned int undo_initialized_size : 1; unsigned int undo_data_size : 1; } need_to = { 0, 0 }; BOOL wasnonresident = FALSE; BOOL compressed; vol = na->ni->vol; compressed = (na->data_flags & ATTR_COMPRESSION_MASK) != const_cpu_to_le16(0); na->unused_runs = 0; /* prepare overflow checks */ /* * Encrypted attributes are only supported in raw mode. We return * access denied, which is what Windows NT4 does, too. * Moreover a file cannot be both encrypted and compressed. */ if ((na->data_flags & ATTR_IS_ENCRYPTED) && (compressed || !vol->efs_raw)) { errno = EACCES; goto errno_set; } /* * Fill the gap, when writing beyond the end of a compressed * file. This will make recursive calls */ if (compressed && (na->type == AT_DATA) && (pos > na->initialized_size) && stuff_hole(na,pos)) goto errno_set; /* If this is a compressed attribute it needs special treatment. */ wasnonresident = NAttrNonResident(na) != 0; /* * Compression is restricted to data streams and * only ATTR_IS_COMPRESSED compression mode is supported. */ if (compressed && ((na->type != AT_DATA) || ((na->data_flags & ATTR_COMPRESSION_MASK) != ATTR_IS_COMPRESSED))) { errno = EOPNOTSUPP; goto errno_set; } if (!count) goto out; /* for a compressed file, get prepared to reserve a full block */ fullcount = count; /* If the write reaches beyond the end, extend the attribute. */ old_data_size = na->data_size; /* identify whether this is appending to a non resident data attribute */ if ((na->type == AT_DATA) && (pos >= old_data_size) && NAttrNonResident(na)) NAttrSetDataAppending(na); if (pos + count > na->data_size) { #if PARTIAL_RUNLIST_UPDATING /* * When appending data, the attribute is first extended * before being filled with data. This may cause the * attribute to be made temporarily sparse, which * implies reformating the inode and reorganizing the * full runlist. To avoid unnecessary reorganization, * we avoid sparse testing until the data is filled in. */ if (ntfs_attr_truncate_i(na, pos + count, (NAttrDataAppending(na) ? HOLES_DELAY : HOLES_OK))) { ntfs_log_perror("Failed to enlarge attribute"); goto errno_set; } /* * If we avoided updating the runlist, we must be sure * to cancel the enlargement and put back the runlist to * a clean state if we get into some error. */ if (NAttrDataAppending(na)) need_to.undo_data_size = 1; #else if (ntfs_attr_truncate_i(na, pos + count, HOLES_OK)) { ntfs_log_perror("Failed to enlarge attribute"); goto errno_set; } #endif /* resizing may change the compression mode */ compressed = (na->data_flags & ATTR_COMPRESSION_MASK) != const_cpu_to_le16(0); need_to.undo_data_size = 1; } /* * For compressed data, a single full block was allocated * to deal with compression, possibly in a previous call. * We are not able to process several blocks because * some clusters are freed after compression and * new allocations have to be done before proceeding, * so truncate the requested count if needed (big buffers). */ if (compressed) { fullcount = (pos | (na->compression_block_size - 1)) + 1 - pos; if (count > fullcount) count = fullcount; } old_initialized_size = na->initialized_size; /* If it is a resident attribute, write the data to the mft record. */ if (!NAttrNonResident(na)) { char *val; ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) goto err_out; if (ntfs_attr_lookup(na->type, na->name, na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_perror("%s: lookup failed", __FUNCTION__); goto err_out; } val = (char*)ctx->attr + le16_to_cpu(ctx->attr->value_offset); if (val < (char*)ctx->attr || val + le32_to_cpu(ctx->attr->value_length) > (char*)ctx->mrec + vol->mft_record_size) { errno = EIO; ntfs_log_perror("%s: Sanity check failed", __FUNCTION__); goto err_out; } memcpy(val + pos, b, count); if (ntfs_mft_record_write(vol, ctx->ntfs_ino->mft_no, ctx->mrec)) { /* * NOTE: We are in a bad state at this moment. We have * dirtied the mft record but we failed to commit it to * disk. Since we have read the mft record ok before, * it is unlikely to fail writing it, so is ok to just * return error here... (AIA) */ ntfs_log_perror("%s: failed to write mft record", __FUNCTION__); goto err_out; } ntfs_attr_put_search_ctx(ctx); total = count; goto out; } /* Handle writes beyond initialized_size. */ if (pos + count > na->initialized_size) { #if PARTIAL_RUNLIST_UPDATING /* * When appending, we only need to map the end of the runlist, * starting at the last previously allocated run, so that * we are able a new one to it. * However, for compressed file, we need the full compression * block, which may be split in several extents. */ if (compressed && !NAttrDataAppending(na)) { if (ntfs_attr_map_whole_runlist(na)) goto err_out; } else { VCN block_begin; if (NAttrDataAppending(na) || (pos < na->initialized_size)) block_begin = pos >> vol->cluster_size_bits; else block_begin = na->initialized_size >> vol->cluster_size_bits; if (compressed) block_begin &= -na->compression_block_clusters; if (block_begin) block_begin--; if (ntfs_attr_map_partial_runlist(na, block_begin)) goto err_out; if ((update_from == -1) || (block_begin < update_from)) update_from = block_begin; } #else if (ntfs_attr_map_whole_runlist(na)) goto err_out; #endif /* * For a compressed attribute, we must be sure there is an * available entry, and, when reopening a compressed file, * we may need to split a hole. So reserve the entries * before it gets too late. */ if (compressed) { na->rl = ntfs_rl_extend(na,na->rl,2); if (!na->rl) goto err_out; na->unused_runs = 2; } /* Set initialized_size to @pos + @count. */ ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) goto err_out; if (ntfs_attr_lookup(na->type, na->name, na->name_len, 0, 0, NULL, 0, ctx)) goto err_out; /* If write starts beyond initialized_size, zero the gap. */ if (pos > na->initialized_size) if (ntfs_attr_fill_zero(na, na->initialized_size, pos - na->initialized_size)) goto err_out; ctx->attr->initialized_size = cpu_to_sle64(pos + count); /* fix data_size for compressed files */ if (compressed) { na->data_size = pos + count; ctx->attr->data_size = ctx->attr->initialized_size; } if (ntfs_mft_record_write(vol, ctx->ntfs_ino->mft_no, ctx->mrec)) { /* * Undo the change in the in-memory copy and send it * back for writing. */ ctx->attr->initialized_size = cpu_to_sle64(old_initialized_size); ntfs_mft_record_write(vol, ctx->ntfs_ino->mft_no, ctx->mrec); goto err_out; } na->initialized_size = pos + count; #if CACHE_NIDATA_SIZE if (na->ni->mrec->flags & MFT_RECORD_IS_DIRECTORY ? na->type == AT_INDEX_ROOT && na->name == NTFS_INDEX_I30 : na->type == AT_DATA && na->name == AT_UNNAMED) { na->ni->data_size = na->data_size; if ((compressed || NAttrSparse(na)) && NAttrNonResident(na)) na->ni->allocated_size = na->compressed_size; else na->ni->allocated_size = na->allocated_size; set_nino_flag(na->ni,KnownSize); } #endif ntfs_attr_put_search_ctx(ctx); ctx = NULL; /* * NOTE: At this point the initialized_size in the mft record * has been updated BUT there is random data on disk thus if * we decide to abort, we MUST change the initialized_size * again. */ need_to.undo_initialized_size = 1; } /* Find the runlist element containing the vcn. */ rl = ntfs_attr_find_vcn(na, pos >> vol->cluster_size_bits); if (!rl) { /* * If the vcn is not present it is an out of bounds write. * However, we already extended the size of the attribute, * so getting this here must be an error of some kind. */ if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN #3", __FUNCTION__); } goto err_out; } /* * Determine if there is compressed data in the current * compression block (when appending to an existing file). * If so, decompression will be needed, and the full block * must be allocated to be identified as uncompressed. * This comes in two variants, depending on whether * compression has saved at least one cluster. * The compressed size can never be over full size by * more than 485 (maximum for 15 compression blocks * compressed to 4098 and the last 3640 bytes compressed * to 3640 + 3640/8 = 4095, with 15*2 + 4095 - 3640 = 485) * This is less than the smallest cluster, so the hole is * is never beyond the cluster next to the position of * the first uncompressed byte to write. */ compressed_part = 0; if (compressed) { if ((rl->lcn == (LCN)LCN_HOLE) && wasnonresident) { if (rl->length < na->compression_block_clusters) /* * the needed block is in a hole smaller * than the compression block : we can use * it fully */ compressed_part = na->compression_block_clusters - rl->length; else { /* * the needed block is in a hole bigger * than the compression block : we must * split the hole and use it partially */ compressed_part = split_compressed_hole(na, &rl, pos, count, &update_from); } } else { if (rl->lcn >= 0) { /* * the needed block contains data, make * sure the full compression block is * allocated. Borrow from hole if needed */ compressed_part = borrow_from_hole(na, &rl, pos, count, &update_from, wasnonresident); } } if (compressed_part < 0) goto err_out; /* just making non-resident, so not yet compressed */ if (NAttrBeingNonResident(na) && (compressed_part < na->compression_block_clusters)) compressed_part = 0; } ofs = pos - (rl->vcn << vol->cluster_size_bits); /* * Scatter the data from the linear data buffer to the volume. Note, a * partial final vcn is taken care of by the @count capping of write * length. */ for (hole_end = 0; count; rl++, ofs = 0) { if (rl->lcn == LCN_RL_NOT_MAPPED) { rl = ntfs_attr_find_vcn(na, rl->vcn); if (!rl) { if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN" " #4", __FUNCTION__); } goto rl_err_out; } /* Needed for case when runs merged. */ ofs = pos + total - (rl->vcn << vol->cluster_size_bits); } if (!rl->length) { errno = EIO; ntfs_log_perror("%s: Zero run length", __FUNCTION__); goto rl_err_out; } if (rl->lcn < (LCN)0) { hole_end = rl->vcn + rl->length; if (rl->lcn != (LCN)LCN_HOLE) { errno = EIO; ntfs_log_perror("%s: Unexpected LCN (%lld)", __FUNCTION__, (long long)rl->lcn); goto rl_err_out; } if (ntfs_attr_fill_hole(na, fullcount, &ofs, &rl, &update_from)) goto err_out; } if (compressed) { while (rl->length && (ofs >= (rl->length << vol->cluster_size_bits))) { ofs -= rl->length << vol->cluster_size_bits; rl++; } } /* It is a real lcn, write it to the volume. */ to_write = min(count, (rl->length << vol->cluster_size_bits) - ofs); retry: ntfs_log_trace("Writing %lld bytes to vcn %lld, lcn %lld, ofs " "%lld.\n", (long long)to_write, (long long)rl->vcn, (long long)rl->lcn, (long long)ofs); if (!NVolReadOnly(vol)) { s64 wpos = (rl->lcn << vol->cluster_size_bits) + ofs; s64 wend = (rl->vcn << vol->cluster_size_bits) + ofs + to_write; u32 bsize = vol->cluster_size; /* Byte size needed to zero fill a cluster */ s64 rounding = ((wend + bsize - 1) & ~(s64)(bsize - 1)) - wend; /** * Zero fill to cluster boundary if we're writing at the * end of the attribute or into an ex-sparse cluster. * This will cause the kernel not to seek and read disk * blocks during write(2) to fill the end of the buffer * which increases write speed by 2-10 fold typically. * * This is done even for compressed files, because * data is generally first written uncompressed. */ if (rounding && ((wend == na->initialized_size) || (wend < (hole_end << vol->cluster_size_bits)))){ char *cb; rounding += to_write; cb = ntfs_malloc(rounding); if (!cb) goto err_out; memcpy(cb, b, to_write); memset(cb + to_write, 0, rounding - to_write); if (compressed) { written = ntfs_compressed_pwrite(na, rl, wpos, ofs, to_write, rounding, cb, compressed_part, &update_from); } else { written = ntfs_pwrite(vol->dev, wpos, rounding, cb); if (written == rounding) written = to_write; } free(cb); } else { if (compressed) { written = ntfs_compressed_pwrite(na, rl, wpos, ofs, to_write, to_write, b, compressed_part, &update_from); } else written = ntfs_pwrite(vol->dev, wpos, to_write, b); } } else written = to_write; /* If everything ok, update progress counters and continue. */ if (written > 0) { total += written; count -= written; fullcount -= written; b = (const u8*)b + written; } if (written != to_write) { /* Partial write cannot be dealt with, stop there */ /* If the syscall was interrupted, try again. */ if (written == (s64)-1 && errno == EINTR) goto retry; if (!written) errno = EIO; goto rl_err_out; } compressed_part = 0; } done: if (ctx) ntfs_attr_put_search_ctx(ctx); /* * Update mapping pairs if needed. * For a compressed file, we try to make a partial update * of the mapping list. This makes a difference only if * inode extents were needed. */ if (NAttrRunlistDirty(na)) { if (ntfs_attr_update_mapping_pairs(na, (update_from < 0 ? 0 : update_from))) { /* * FIXME: trying to recover by goto rl_err_out; * could cause driver hang by infinite looping. */ total = -1; goto out; } if (!wasnonresident) NAttrClearBeingNonResident(na); NAttrClearDataAppending(na); } out: return total; rl_err_out: eo = errno; if (total) { if (need_to.undo_initialized_size) { if (pos + total > na->initialized_size) goto done; /* * TODO: Need to try to change initialized_size. If it * succeeds goto done, otherwise goto err_out. (AIA) */ goto err_out; } goto done; } errno = eo; err_out: eo = errno; if (need_to.undo_initialized_size) { int err; err = 0; if (!ctx) { ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) err = 1; } else ntfs_attr_reinit_search_ctx(ctx); if (!err) { err = ntfs_attr_lookup(na->type, na->name, na->name_len, 0, 0, NULL, 0, ctx); if (!err) { na->initialized_size = old_initialized_size; ctx->attr->initialized_size = cpu_to_sle64( old_initialized_size); err = ntfs_mft_record_write(vol, ctx->ntfs_ino->mft_no, ctx->mrec); } } if (err) { /* * FIXME: At this stage could try to recover by filling * old_initialized_size -> new_initialized_size with * data or at least zeroes. (AIA) */ ntfs_log_error("Eeek! Failed to recover from error. " "Leaving metadata in inconsistent " "state! Run chkdsk!\n"); } } if (ctx) ntfs_attr_put_search_ctx(ctx); /* Update mapping pairs if needed. */ if (NAttrRunlistDirty(na)) ntfs_attr_update_mapping_pairs(na, 0); /* Restore original data_size if needed. */ if (need_to.undo_data_size && ntfs_attr_truncate_i(na, old_data_size, HOLES_OK)) ntfs_log_perror("Failed to restore data_size"); errno = eo; errno_set: total = -1; goto out; } s64 ntfs_attr_pwrite(ntfs_attr *na, const s64 pos, s64 count, const void *b) { s64 total; s64 written; ntfs_log_enter("Entering for inode %lld, attr 0x%x, pos 0x%llx, count " "0x%llx.\n", (long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)pos, (long long)count); total = 0; if (!na || !na->ni || !na->ni->vol || !b || pos < 0 || count < 0) { errno = EINVAL; written = -1; ntfs_log_perror("%s", __FUNCTION__); goto out; } /* * Compressed attributes may be written partially, so * we may have to iterate. */ do { written = ntfs_attr_pwrite_i(na, pos + total, count - total, (const u8*)b + total); if (written > 0) total += written; } while ((written > 0) && (total < count)); out : ntfs_log_leave("\n"); return (total > 0 ? total : written); } int ntfs_attr_pclose(ntfs_attr *na) { s64 ofs; int failed; BOOL ok = TRUE; VCN update_from = -1; ntfs_volume *vol; ntfs_attr_search_ctx *ctx = NULL; runlist_element *rl; int eo; int compressed_part; BOOL compressed; ntfs_log_enter("Entering for inode 0x%llx, attr 0x%x.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); if (!na || !na->ni || !na->ni->vol) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); goto errno_set; } vol = na->ni->vol; na->unused_runs = 0; compressed = (na->data_flags & ATTR_COMPRESSION_MASK) != const_cpu_to_le16(0); /* * Encrypted non-resident attributes are not supported. We return * access denied, which is what Windows NT4 does, too. */ if (NAttrEncrypted(na) && NAttrNonResident(na)) { errno = EACCES; goto errno_set; } /* If this is not a compressed attribute get out */ /* same if it is resident */ if (!compressed || !NAttrNonResident(na)) goto out; /* safety check : no recursion on close */ if (NAttrComprClosing(na)) { errno = EIO; ntfs_log_error("Bad ntfs_attr_pclose" " recursion on inode %lld\n", (long long)na->ni->mft_no); goto out; } NAttrSetComprClosing(na); /* * For a compressed attribute, we must be sure there are two * available entries, so reserve them before it gets too late. */ if (ntfs_attr_map_whole_runlist(na)) goto err_out; na->rl = ntfs_rl_extend(na,na->rl,2); if (!na->rl) goto err_out; na->unused_runs = 2; /* Find the runlist element containing the terminal vcn. */ rl = ntfs_attr_find_vcn(na, (na->initialized_size - 1) >> vol->cluster_size_bits); if (!rl) { /* * If the vcn is not present it is an out of bounds write. * However, we have already written the last byte uncompressed, * so getting this here must be an error of some kind. */ if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN #5", __FUNCTION__); } goto err_out; } /* * Scatter the data from the linear data buffer to the volume. Note, a * partial final vcn is taken care of by the @count capping of write * length. */ compressed_part = 0; if (rl->lcn >= 0) { runlist_element *xrl; xrl = rl; do { xrl++; } while (xrl->lcn >= 0); compressed_part = (-xrl->length) & (na->compression_block_clusters - 1); } else if (rl->lcn == (LCN)LCN_HOLE) { if (rl->length < na->compression_block_clusters) compressed_part = na->compression_block_clusters - rl->length; else compressed_part = na->compression_block_clusters; } /* done, if the last block set was compressed */ if (compressed_part) goto out; ofs = na->initialized_size - (rl->vcn << vol->cluster_size_bits); if (rl->lcn == LCN_RL_NOT_MAPPED) { rl = ntfs_attr_find_vcn(na, rl->vcn); if (!rl) { if (errno == ENOENT) { errno = EIO; ntfs_log_perror("%s: Failed to find VCN" " #6", __FUNCTION__); } goto rl_err_out; } /* Needed for case when runs merged. */ ofs = na->initialized_size - (rl->vcn << vol->cluster_size_bits); } if (!rl->length) { errno = EIO; ntfs_log_perror("%s: Zero run length", __FUNCTION__); goto rl_err_out; } if (rl->lcn < (LCN)0) { if (rl->lcn != (LCN)LCN_HOLE) { errno = EIO; ntfs_log_perror("%s: Unexpected LCN (%lld)", __FUNCTION__, (long long)rl->lcn); goto rl_err_out; } if (ntfs_attr_fill_hole(na, (s64)0, &ofs, &rl, &update_from)) goto err_out; } while (rl->length && (ofs >= (rl->length << vol->cluster_size_bits))) { ofs -= rl->length << vol->cluster_size_bits; rl++; } retry: failed = 0; if (update_from < 0) update_from = 0; if (!NVolReadOnly(vol)) { failed = ntfs_compressed_close(na, rl, ofs, &update_from); #if CACHE_NIDATA_SIZE if (na->ni->mrec->flags & MFT_RECORD_IS_DIRECTORY ? na->type == AT_INDEX_ROOT && na->name == NTFS_INDEX_I30 : na->type == AT_DATA && na->name == AT_UNNAMED) { na->ni->data_size = na->data_size; na->ni->allocated_size = na->compressed_size; set_nino_flag(na->ni,KnownSize); } #endif } if (failed) { /* If the syscall was interrupted, try again. */ if (errno == EINTR) goto retry; else goto rl_err_out; } if (ctx) ntfs_attr_put_search_ctx(ctx); /* Update mapping pairs if needed. */ if (NAttrFullyMapped(na)) if (ntfs_attr_update_mapping_pairs(na, update_from)) { /* * FIXME: trying to recover by goto rl_err_out; * could cause driver hang by infinite looping. */ ok = FALSE; goto out; } out: NAttrClearComprClosing(na); ntfs_log_leave("\n"); return (!ok); rl_err_out: /* * need not restore old sizes, only compressed_size * can have changed. It has been set according to * the current runlist while updating the mapping pairs, * and must be kept consistent with the runlists. */ err_out: eo = errno; if (ctx) ntfs_attr_put_search_ctx(ctx); /* Update mapping pairs if needed. */ if (NAttrFullyMapped(na)) ntfs_attr_update_mapping_pairs(na, 0); errno = eo; errno_set: ok = FALSE; goto out; } /** * ntfs_attr_mst_pread - multi sector transfer protected ntfs attribute read * @na: multi sector transfer protected ntfs attribute to read from * @pos: byte position in the attribute to begin reading from * @bk_cnt: number of mst protected blocks to read * @bk_size: size of each mst protected block in bytes * @dst: output data buffer * * This function will read @bk_cnt blocks of size @bk_size bytes each starting * at offset @pos from the ntfs attribute @na into the data buffer @b. * * On success, the multi sector transfer fixups are applied and the number of * read blocks is returned. If this number is lower than @bk_cnt this means * that the read has either reached end of attribute or that an error was * encountered during the read so that the read is partial. 0 means end of * attribute or nothing to read (also return 0 when @bk_cnt or @bk_size are 0). * * On error and nothing has been read, return -1 with errno set appropriately * to the return code of ntfs_attr_pread() or to EINVAL in case of invalid * arguments. * * NOTE: If an incomplete multi sector transfer is detected the magic is * changed to BAAD but no error is returned, i.e. it is possible that any of * the returned blocks have multi sector transfer errors. This should be * detected by the caller by checking each block with is_baad_recordp(&block). * The reasoning is that we want to fixup as many blocks as possible and we * want to return even bad ones to the caller so, e.g. in case of ntfsck, the * errors can be repaired. */ s64 ntfs_attr_mst_pread(ntfs_attr *na, const s64 pos, const s64 bk_cnt, const u32 bk_size, void *dst) { s64 br; u8 *end; BOOL warn; ntfs_log_trace("Entering for inode 0x%llx, attr type 0x%x, pos 0x%llx.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)pos); if (bk_cnt < 0 || bk_size % NTFS_BLOCK_SIZE) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return -1; } br = ntfs_attr_pread(na, pos, bk_cnt * bk_size, dst); if (br <= 0) return br; br /= bk_size; /* log errors unless silenced */ warn = !na->ni || !na->ni->vol || !NVolNoFixupWarn(na->ni->vol); for (end = (u8*)dst + br * bk_size; (u8*)dst < end; dst = (u8*)dst + bk_size) ntfs_mst_post_read_fixup_warn((NTFS_RECORD*)dst, bk_size, warn); /* Finally, return the number of blocks read. */ return br; } /** * ntfs_attr_mst_pwrite - multi sector transfer protected ntfs attribute write * @na: multi sector transfer protected ntfs attribute to write to * @pos: position in the attribute to write to * @bk_cnt: number of mst protected blocks to write * @bk_size: size of each mst protected block in bytes * @src: data buffer to write to disk * * This function will write @bk_cnt blocks of size @bk_size bytes each from * data buffer @b to multi sector transfer (mst) protected ntfs attribute @na * at position @pos. * * On success, return the number of successfully written blocks. If this number * is lower than @bk_cnt this means that an error was encountered during the * write so that the write is partial. 0 means nothing was written (also * return 0 when @bk_cnt or @bk_size are 0). * * On error and nothing has been written, return -1 with errno set * appropriately to the return code of ntfs_attr_pwrite(), or to EINVAL in case * of invalid arguments. * * NOTE: We mst protect the data, write it, then mst deprotect it using a quick * deprotect algorithm (no checking). This saves us from making a copy before * the write and at the same time causes the usn to be incremented in the * buffer. This conceptually fits in better with the idea that cached data is * always deprotected and protection is performed when the data is actually * going to hit the disk and the cache is immediately deprotected again * simulating an mst read on the written data. This way cache coherency is * achieved. */ s64 ntfs_attr_mst_pwrite(ntfs_attr *na, const s64 pos, s64 bk_cnt, const u32 bk_size, void *src) { s64 written, i; ntfs_log_trace("Entering for inode 0x%llx, attr type 0x%x, pos 0x%llx.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)pos); if (bk_cnt < 0 || bk_size % NTFS_BLOCK_SIZE) { errno = EINVAL; return -1; } if (!bk_cnt) return 0; /* Prepare data for writing. */ for (i = 0; i < bk_cnt; ++i) { int err; err = ntfs_mst_pre_write_fixup((NTFS_RECORD*) ((u8*)src + i * bk_size), bk_size); if (err < 0) { /* Abort write at this position. */ ntfs_log_perror("%s #1", __FUNCTION__); if (!i) return err; bk_cnt = i; break; } } /* Write the prepared data. */ written = ntfs_attr_pwrite(na, pos, bk_cnt * bk_size, src); if (written <= 0) { ntfs_log_perror("%s: written=%lld", __FUNCTION__, (long long)written); } /* Quickly deprotect the data again. */ for (i = 0; i < bk_cnt; ++i) ntfs_mst_post_write_fixup((NTFS_RECORD*)((u8*)src + i * bk_size)); if (written <= 0) return written; /* Finally, return the number of complete blocks written. */ return written / bk_size; } /** * ntfs_attr_find - find (next) attribute in mft record * @type: attribute type to find * @name: attribute name to find (optional, i.e. NULL means don't care) * @name_len: attribute name length (only needed if @name present) * @ic: IGNORE_CASE or CASE_SENSITIVE (ignored if @name not present) * @val: attribute value to find (optional, resident attributes only) * @val_len: attribute value length * @ctx: search context with mft record and attribute to search from * * You shouldn't need to call this function directly. Use lookup_attr() instead. * * ntfs_attr_find() takes a search context @ctx as parameter and searches the * mft record specified by @ctx->mrec, beginning at @ctx->attr, for an * attribute of @type, optionally @name and @val. If found, ntfs_attr_find() * returns 0 and @ctx->attr will point to the found attribute. * * If not found, ntfs_attr_find() returns -1, with errno set to ENOENT and * @ctx->attr will point to the attribute before which the attribute being * searched for would need to be inserted if such an action were to be desired. * * On actual error, ntfs_attr_find() returns -1 with errno set to the error * code but not to ENOENT. In this case @ctx->attr is undefined and in * particular do not rely on it not changing. * * If @ctx->is_first is TRUE, the search begins with @ctx->attr itself. If it * is FALSE, the search begins after @ctx->attr. * * If @type is AT_UNUSED, return the first found attribute, i.e. one can * enumerate all attributes by setting @type to AT_UNUSED and then calling * ntfs_attr_find() repeatedly until it returns -1 with errno set to ENOENT to * indicate that there are no more entries. During the enumeration, each * successful call of ntfs_attr_find() will return the next attribute in the * mft record @ctx->mrec. * * If @type is AT_END, seek to the end and return -1 with errno set to ENOENT. * AT_END is not a valid attribute, its length is zero for example, thus it is * safer to return error instead of success in this case. This also allows us * to interoperate cleanly with ntfs_external_attr_find(). * * If @name is AT_UNNAMED search for an unnamed attribute. If @name is present * but not AT_UNNAMED search for a named attribute matching @name. Otherwise, * match both named and unnamed attributes. * * If @ic is IGNORE_CASE, the @name comparison is not case sensitive and * @ctx->ntfs_ino must be set to the ntfs inode to which the mft record * @ctx->mrec belongs. This is so we can get at the ntfs volume and hence at * the upcase table. If @ic is CASE_SENSITIVE, the comparison is case * sensitive. When @name is present, @name_len is the @name length in Unicode * characters. * * If @name is not present (NULL), we assume that the unnamed attribute is * being searched for. * * Finally, the resident attribute value @val is looked for, if present. * If @val is not present (NULL), @val_len is ignored. * * ntfs_attr_find() only searches the specified mft record and it ignores the * presence of an attribute list attribute (unless it is the one being searched * for, obviously). If you need to take attribute lists into consideration, use * ntfs_attr_lookup() instead (see below). This also means that you cannot use * ntfs_attr_find() to search for extent records of non-resident attributes, as * extents with lowest_vcn != 0 are usually described by the attribute list * attribute only. - Note that it is possible that the first extent is only in * the attribute list while the last extent is in the base mft record, so don't * rely on being able to find the first extent in the base mft record. * * Warning: Never use @val when looking for attribute types which can be * non-resident as this most likely will result in a crash! */ static int ntfs_attr_find(const ATTR_TYPES type, const ntfschar *name, const u32 name_len, const IGNORE_CASE_BOOL ic, const u8 *val, const u32 val_len, ntfs_attr_search_ctx *ctx) { ATTR_RECORD *a; ntfs_volume *vol; ntfschar *upcase; ptrdiff_t offs; ptrdiff_t space; u32 upcase_len; ntfs_log_trace("attribute type 0x%x.\n", le32_to_cpu(type)); if (ctx->ntfs_ino) { vol = ctx->ntfs_ino->vol; upcase = vol->upcase; upcase_len = vol->upcase_len; } else { if (name && name != AT_UNNAMED) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return -1; } vol = NULL; upcase = NULL; upcase_len = 0; } /* * Iterate over attributes in mft record starting at @ctx->attr, or the * attribute following that, if @ctx->is_first is TRUE. */ if (ctx->is_first) { a = ctx->attr; ctx->is_first = FALSE; } else a = (ATTR_RECORD*)((char*)ctx->attr + le32_to_cpu(ctx->attr->length)); for (;; a = (ATTR_RECORD*)((char*)a + le32_to_cpu(a->length))) { /* * Make sure the attribute fully lies within the MFT record * and we can safely access its minimal fields. */ offs = p2n(a) - p2n(ctx->mrec); space = le32_to_cpu(ctx->mrec->bytes_in_use) - offs; if ((offs < 0) || (((space < (ptrdiff_t)offsetof(ATTR_RECORD, resident_end)) || (space < (ptrdiff_t)le32_to_cpu(a->length))) && ((space < 4) || (a->type != AT_END)))) break; ctx->attr = a; if (((type != AT_UNUSED) && (le32_to_cpu(a->type) > le32_to_cpu(type))) || (a->type == AT_END)) { errno = ENOENT; return -1; } if (!a->length) break; /* If this is an enumeration return this attribute. */ if (type == AT_UNUSED) return 0; if (a->type != type) continue; /* * If @name is AT_UNNAMED we want an unnamed attribute. * If @name is present, compare the two names. * Otherwise, match any attribute. */ if (name == AT_UNNAMED) { /* The search failed if the found attribute is named. */ if (a->name_length) { errno = ENOENT; return -1; } } else { register int rc; if (a->name_length && ((le16_to_cpu(a->name_offset) + a->name_length * sizeof(ntfschar)) > le32_to_cpu(a->length))) { ntfs_log_error("Corrupt attribute name" " in MFT record %lld\n", (long long)ctx->ntfs_ino->mft_no); break; } if (name && ((rc = ntfs_names_full_collate(name, name_len, (ntfschar*)((char*)a + le16_to_cpu(a->name_offset)), a->name_length, ic, upcase, upcase_len)))) { /* * If @name collates before a->name, * there is no matching attribute. */ if (rc < 0) { errno = ENOENT; return -1; } /* If the strings are not equal, continue search. */ continue; } } /* * The names match or @name not present and attribute is * unnamed. If no @val specified, we have found the attribute * and are done. */ if (!val) return 0; /* @val is present; compare values. */ else { register int rc; rc = memcmp(val, (char*)a +le16_to_cpu(a->value_offset), min(val_len, le32_to_cpu(a->value_length))); /* * If @val collates before the current attribute's * value, there is no matching attribute. */ if (!rc) { register u32 avl; avl = le32_to_cpu(a->value_length); if (val_len == avl) return 0; if (val_len < avl) { errno = ENOENT; return -1; } } else if (rc < 0) { errno = ENOENT; return -1; } } } errno = EIO; ntfs_log_perror("%s: Corrupt inode (%lld:%d)", __FUNCTION__, ctx->ntfs_ino ? (long long)ctx->ntfs_ino->mft_no : -1, type); return -1; } void ntfs_attr_name_free(char **name) { if (*name) { free(*name); *name = NULL; } } char *ntfs_attr_name_get(const ntfschar *uname, const int uname_len) { char *name = NULL; int name_len; name_len = ntfs_ucstombs(uname, uname_len, &name, 0); if (name_len < 0) { ntfs_log_perror("ntfs_ucstombs"); return NULL; } else if (name_len > 0) return name; ntfs_attr_name_free(&name); return NULL; } /** * ntfs_external_attr_find - find an attribute in the attribute list of an inode * @type: attribute type to find * @name: attribute name to find (optional, i.e. NULL means don't care) * @name_len: attribute name length (only needed if @name present) * @ic: IGNORE_CASE or CASE_SENSITIVE (ignored if @name not present) * @lowest_vcn: lowest vcn to find (optional, non-resident attributes only) * @val: attribute value to find (optional, resident attributes only) * @val_len: attribute value length * @ctx: search context with mft record and attribute to search from * * You shouldn't need to call this function directly. Use ntfs_attr_lookup() * instead. * * Find an attribute by searching the attribute list for the corresponding * attribute list entry. Having found the entry, map the mft record for read * if the attribute is in a different mft record/inode, find the attribute in * there and return it. * * If @type is AT_UNUSED, return the first found attribute, i.e. one can * enumerate all attributes by setting @type to AT_UNUSED and then calling * ntfs_external_attr_find() repeatedly until it returns -1 with errno set to * ENOENT to indicate that there are no more entries. During the enumeration, * each successful call of ntfs_external_attr_find() will return the next * attribute described by the attribute list of the base mft record described * by the search context @ctx. * * If @type is AT_END, seek to the end of the base mft record ignoring the * attribute list completely and return -1 with errno set to ENOENT. AT_END is * not a valid attribute, its length is zero for example, thus it is safer to * return error instead of success in this case. * * If @name is AT_UNNAMED search for an unnamed attribute. If @name is present * but not AT_UNNAMED search for a named attribute matching @name. Otherwise, * match both named and unnamed attributes. * * On first search @ctx->ntfs_ino must be the inode of the base mft record and * @ctx must have been obtained from a call to ntfs_attr_get_search_ctx(). * On subsequent calls, @ctx->ntfs_ino can be any extent inode, too * (@ctx->base_ntfs_ino is then the base inode). * * After finishing with the attribute/mft record you need to call * ntfs_attr_put_search_ctx() to cleanup the search context (unmapping any * mapped extent inodes, etc). * * Return 0 if the search was successful and -1 if not, with errno set to the * error code. * * On success, @ctx->attr is the found attribute, it is in mft record * @ctx->mrec, and @ctx->al_entry is the attribute list entry for this * attribute with @ctx->base_* being the base mft record to which @ctx->attr * belongs. * * On error ENOENT, i.e. attribute not found, @ctx->attr is set to the * attribute which collates just after the attribute being searched for in the * base ntfs inode, i.e. if one wants to add the attribute to the mft record * this is the correct place to insert it into, and if there is not enough * space, the attribute should be placed in an extent mft record. * @ctx->al_entry points to the position within @ctx->base_ntfs_ino->attr_list * at which the new attribute's attribute list entry should be inserted. The * other @ctx fields, base_ntfs_ino, base_mrec, and base_attr are set to NULL. * The only exception to this is when @type is AT_END, in which case * @ctx->al_entry is set to NULL also (see above). * * The following error codes are defined: * ENOENT Attribute not found, not an error as such. * EINVAL Invalid arguments. * EIO I/O error or corrupt data structures found. * ENOMEM Not enough memory to allocate necessary buffers. */ static int ntfs_external_attr_find(ATTR_TYPES type, const ntfschar *name, const u32 name_len, const IGNORE_CASE_BOOL ic, const VCN lowest_vcn, const u8 *val, const u32 val_len, ntfs_attr_search_ctx *ctx) { ntfs_inode *base_ni, *ni; ntfs_volume *vol; ATTR_LIST_ENTRY *al_entry, *next_al_entry; u8 *al_start, *al_end; ATTR_RECORD *a; ntfschar *al_name; ptrdiff_t offs; ptrdiff_t space; u32 al_name_len; BOOL is_first_search = FALSE; ni = ctx->ntfs_ino; base_ni = ctx->base_ntfs_ino; ntfs_log_trace("Entering for inode %lld, attribute type 0x%x.\n", (unsigned long long)ni->mft_no, le32_to_cpu(type)); if (!base_ni) { /* First call happens with the base mft record. */ base_ni = ctx->base_ntfs_ino = ctx->ntfs_ino; ctx->base_mrec = ctx->mrec; } if (ni == base_ni) ctx->base_attr = ctx->attr; if (type == AT_END) goto not_found; vol = base_ni->vol; al_start = base_ni->attr_list; al_end = al_start + base_ni->attr_list_size; if (!ctx->al_entry) { ctx->al_entry = (ATTR_LIST_ENTRY*)al_start; is_first_search = TRUE; } /* * Iterate over entries in attribute list starting at @ctx->al_entry, * or the entry following that, if @ctx->is_first is TRUE. */ if (ctx->is_first) { al_entry = ctx->al_entry; ctx->is_first = FALSE; /* * If an enumeration and the first attribute is higher than * the attribute list itself, need to return the attribute list * attribute. */ if ((type == AT_UNUSED) && is_first_search && le32_to_cpu(al_entry->type) > le32_to_cpu(AT_ATTRIBUTE_LIST)) goto find_attr_list_attr; } else { /* Check for small entry */ if (((p2n(al_end) - p2n(ctx->al_entry)) < (long)offsetof(ATTR_LIST_ENTRY, name)) || (le16_to_cpu(ctx->al_entry->length) & 7) || (le16_to_cpu(ctx->al_entry->length) < offsetof(ATTR_LIST_ENTRY, name))) goto corrupt; al_entry = (ATTR_LIST_ENTRY*)((char*)ctx->al_entry + le16_to_cpu(ctx->al_entry->length)); if ((u8*)al_entry == al_end) goto not_found; /* Preliminary check for small entry */ if ((p2n(al_end) - p2n(al_entry)) < (long)offsetof(ATTR_LIST_ENTRY, name)) goto corrupt; /* * If this is an enumeration and the attribute list attribute * is the next one in the enumeration sequence, just return the * attribute list attribute from the base mft record as it is * not listed in the attribute list itself. */ if ((type == AT_UNUSED) && le32_to_cpu(ctx->al_entry->type) < le32_to_cpu(AT_ATTRIBUTE_LIST) && le32_to_cpu(al_entry->type) > le32_to_cpu(AT_ATTRIBUTE_LIST)) { int rc; find_attr_list_attr: /* Check for bogus calls. */ if (name || name_len || val || val_len || lowest_vcn) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return -1; } /* We want the base record. */ ctx->ntfs_ino = base_ni; ctx->mrec = ctx->base_mrec; ctx->is_first = TRUE; /* Sanity checks are performed elsewhere. */ ctx->attr = (ATTR_RECORD*)((u8*)ctx->mrec + le16_to_cpu(ctx->mrec->attrs_offset)); /* Find the attribute list attribute. */ rc = ntfs_attr_find(AT_ATTRIBUTE_LIST, NULL, 0, IGNORE_CASE, NULL, 0, ctx); /* * Setup the search context so the correct * attribute is returned next time round. */ ctx->al_entry = al_entry; ctx->is_first = TRUE; /* Got it. Done. */ if (!rc) return 0; /* Error! If other than not found return it. */ if (errno != ENOENT) return rc; /* Not found?!? Absurd! */ errno = EIO; ntfs_log_error("Attribute list wasn't found"); return -1; } } for (;; al_entry = next_al_entry) { /* Out of bounds check. */ if ((u8*)al_entry < base_ni->attr_list || (u8*)al_entry > al_end) break; /* Inode is corrupt. */ ctx->al_entry = al_entry; /* Catch the end of the attribute list. */ if ((u8*)al_entry == al_end) goto not_found; if ((((u8*)al_entry + offsetof(ATTR_LIST_ENTRY, name)) > al_end) || ((u8*)al_entry + le16_to_cpu(al_entry->length) > al_end) || (le16_to_cpu(al_entry->length) & 7) || (le16_to_cpu(al_entry->length) < offsetof(ATTR_LIST_ENTRY, name_length)) || (al_entry->name_length && ((u8*)al_entry + al_entry->name_offset + al_entry->name_length * sizeof(ntfschar)) > al_end)) break; /* corrupt */ next_al_entry = (ATTR_LIST_ENTRY*)((u8*)al_entry + le16_to_cpu(al_entry->length)); if (type != AT_UNUSED) { if (le32_to_cpu(al_entry->type) > le32_to_cpu(type)) goto not_found; if (type != al_entry->type) continue; } al_name_len = al_entry->name_length; al_name = (ntfschar*)((u8*)al_entry + al_entry->name_offset); /* * If !@type we want the attribute represented by this * attribute list entry. */ if (type == AT_UNUSED) goto is_enumeration; /* * If @name is AT_UNNAMED we want an unnamed attribute. * If @name is present, compare the two names. * Otherwise, match any attribute. */ if (name == AT_UNNAMED) { if (al_name_len) goto not_found; } else { int rc; if (name && ((rc = ntfs_names_full_collate(name, name_len, al_name, al_name_len, ic, vol->upcase, vol->upcase_len)))) { /* * If @name collates before al_name, * there is no matching attribute. */ if (rc < 0) goto not_found; /* If the strings are not equal, continue search. */ continue; } } /* * The names match or @name not present and attribute is * unnamed. Now check @lowest_vcn. Continue search if the * next attribute list entry still fits @lowest_vcn. Otherwise * we have reached the right one or the search has failed. */ if (lowest_vcn && (u8*)next_al_entry >= al_start && (u8*)next_al_entry + 6 < al_end && (u8*)next_al_entry + le16_to_cpu( next_al_entry->length) <= al_end && sle64_to_cpu(next_al_entry->lowest_vcn) <= lowest_vcn && next_al_entry->type == al_entry->type && next_al_entry->name_length == al_name_len && ntfs_names_are_equal((ntfschar*)((char*) next_al_entry + next_al_entry->name_offset), next_al_entry->name_length, al_name, al_name_len, CASE_SENSITIVE, vol->upcase, vol->upcase_len)) continue; is_enumeration: if (MREF_LE(al_entry->mft_reference) == ni->mft_no) { if (MSEQNO_LE(al_entry->mft_reference) != le16_to_cpu( ni->mrec->sequence_number)) { ntfs_log_error("Found stale mft reference in " "attribute list!\n"); break; } } else { /* Mft references do not match. */ /* Do we want the base record back? */ if (MREF_LE(al_entry->mft_reference) == base_ni->mft_no) { ni = ctx->ntfs_ino = base_ni; ctx->mrec = ctx->base_mrec; } else { /* We want an extent record. */ if (!vol->mft_na) { ntfs_log_perror("$MFT not ready for " "opening an extent to inode %lld\n", (long long)base_ni->mft_no); break; } ni = ntfs_extent_inode_open(base_ni, al_entry->mft_reference); if (!ni) break; ctx->ntfs_ino = ni; ctx->mrec = ni->mrec; } } a = ctx->attr = (ATTR_RECORD*)((char*)ctx->mrec + le16_to_cpu(ctx->mrec->attrs_offset)); /* * ctx->ntfs_ino, ctx->mrec, and ctx->attr now point to the * mft record containing the attribute represented by the * current al_entry. * * We could call into ntfs_attr_find() to find the right * attribute in this mft record but this would be less * efficient and not quite accurate as ntfs_attr_find() ignores * the attribute instance numbers for example which become * important when one plays with attribute lists. Also, because * a proper match has been found in the attribute list entry * above, the comparison can now be optimized. So it is worth * re-implementing a simplified ntfs_attr_find() here. * * Use a manual loop so we can still use break and continue * with the same meanings as above. */ do_next_attr_loop: /* * Make sure the attribute fully lies within the MFT record * and we can safely access its minimal fields. */ offs = p2n(a) - p2n(ctx->mrec); space = le32_to_cpu(ctx->mrec->bytes_in_use) - offs; if (offs < 0) break; if ((space >= 4) && (a->type == AT_END)) continue; if (!a->length) break; if ((space < (ptrdiff_t)offsetof(ATTR_RECORD, resident_end)) || (space < (ptrdiff_t)le32_to_cpu(a->length))) break; if (al_entry->instance != a->instance) goto do_next_attr; /* * If the type and/or the name are/is mismatched between the * attribute list entry and the attribute record, there is * corruption so we break and return error EIO. */ if (al_entry->type != a->type) break; if (!ntfs_names_are_equal((ntfschar*)((char*)a + le16_to_cpu(a->name_offset)), a->name_length, al_name, al_name_len, CASE_SENSITIVE, vol->upcase, vol->upcase_len)) break; ctx->attr = a; /* * If no @val specified or @val specified and it matches, we * have found it! Also, if !@type, it is an enumeration, so we * want the current attribute. */ if ((type == AT_UNUSED) || !val || (!a->non_resident && le32_to_cpu(a->value_length) == val_len && !memcmp((char*)a + le16_to_cpu(a->value_offset), val, val_len))) { return 0; } do_next_attr: /* Proceed to the next attribute in the current mft record. */ a = (ATTR_RECORD*)((char*)a + le32_to_cpu(a->length)); goto do_next_attr_loop; } corrupt : if (ni != base_ni) { ctx->ntfs_ino = base_ni; ctx->mrec = ctx->base_mrec; ctx->attr = ctx->base_attr; } errno = EIO; ntfs_log_error("Corrupt attribute list entry in MFT record %lld\n", (long long)base_ni->mft_no); return -1; not_found: /* * If we were looking for AT_END or we were enumerating and reached the * end, we reset the search context @ctx and use ntfs_attr_find() to * seek to the end of the base mft record. */ if (type == AT_UNUSED || type == AT_END) { ntfs_attr_reinit_search_ctx(ctx); return ntfs_attr_find(AT_END, name, name_len, ic, val, val_len, ctx); } /* * The attribute wasn't found. Before we return, we want to ensure * @ctx->mrec and @ctx->attr indicate the position at which the * attribute should be inserted in the base mft record. Since we also * want to preserve @ctx->al_entry we cannot reinitialize the search * context using ntfs_attr_reinit_search_ctx() as this would set * @ctx->al_entry to NULL. Thus we do the necessary bits manually (see * ntfs_attr_init_search_ctx() below). Note, we _only_ preserve * @ctx->al_entry as the remaining fields (base_*) are identical to * their non base_ counterparts and we cannot set @ctx->base_attr * correctly yet as we do not know what @ctx->attr will be set to by * the call to ntfs_attr_find() below. */ ctx->mrec = ctx->base_mrec; ctx->attr = (ATTR_RECORD*)((u8*)ctx->mrec + le16_to_cpu(ctx->mrec->attrs_offset)); ctx->is_first = TRUE; ctx->ntfs_ino = ctx->base_ntfs_ino; ctx->base_ntfs_ino = NULL; ctx->base_mrec = NULL; ctx->base_attr = NULL; /* * In case there are multiple matches in the base mft record, need to * keep enumerating until we get an attribute not found response (or * another error), otherwise we would keep returning the same attribute * over and over again and all programs using us for enumeration would * lock up in a tight loop. */ { int ret; do { ret = ntfs_attr_find(type, name, name_len, ic, val, val_len, ctx); } while (!ret); return ret; } } /* * Check the consistency of an attribute * * Do the general consistency checks of the selected attribute : * - the required fields can be accessed * - the variable fields do not overflow * - the attribute is [non-]resident if it must be * - miscelleaneous checks * * Returns 0 if the checks pass * -1 with errno = EIO otherwise * Returns 0 and dirty flag set 1, if the repairing is OK */ int ntfs_attr_inconsistent(ntfs_volume *vol, ATTR_RECORD *a, const MFT_REF mref, BOOL *fixed) { FILE_NAME_ATTR *fn; INDEX_ROOT *ir; ATTR_RECORD *mod_a = (ATTR_RECORD *)a; u64 inum; int ret; BOOL is_fsck = NVolFsck(vol); problem_context_t pctx = {0, }; if (is_fsck && mref <= FILE_MFTMirr) NVolClearFsck(vol); /* * The attribute was found to fully lie within the MFT * record, now make sure its relevant parts (name, runlist, * value) also lie within. The first step is to make sure * the attribute has the minimum length so that accesses to * the lengths and offsets of these parts are safe. */ ret = 0; inum = MREF(mref); pctx.inum = inum; pctx.a = a; if (a->non_resident) { if ((a->non_resident != 1) || (le32_to_cpu(a->length) < offsetof(ATTR_RECORD, non_resident_end)) || (le16_to_cpu(a->mapping_pairs_offset) & 7) || (le16_to_cpu(a->mapping_pairs_offset) >= le32_to_cpu(a->length)) || (a->name_length && (((u32)le16_to_cpu(a->name_offset) + a->name_length * sizeof(ntfschar)) > le32_to_cpu(a->length))) || (le64_to_cpu(a->highest_vcn) < le64_to_cpu(a->lowest_vcn))) { ntfs_log_error("Corrupt non resident attribute" " 0x%x in MFT record %lld\n", (int)le32_to_cpu(a->type), (long long)inum); errno = EIO; ret = -1; goto out; } } else { u32 attr_len = le32_to_cpu(a->length); u32 value_len = le32_to_cpu(a->value_length); u16 value_off = le16_to_cpu(a->value_offset); u32 name_end = ((u32)le16_to_cpu(a->name_offset) + a->name_length * sizeof(ntfschar) + 7) & ~7; if ((value_len & 0xff000000)) { ntfs_log_error("Corrupt resident attribute" " 0x%x in MFT record %lld\n", (int)le32_to_cpu(a->type), (long long)inum); errno = EIO; ret = -1; goto out; } if (value_off & 7) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_VALUE_OFFSET_BADLY_ALIGNED, &pctx)) { value_off += 7 & ~7; a->value_offset = cpu_to_le16(value_off); *fixed = TRUE; fsck_err_fixed(); } else { errno = EIO; ret = -1; goto out; } } else { ntfs_log_error("Value offset badly aligned in attribute(type : 0x%x)", a->type); errno = EIO; ret = -1; goto out; } } if (a->name_offset && (u32)le16_to_cpu(a->name_offset) < offsetof(ATTR_RECORD, resident_end)) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_NAME_OFFSET_CORRUPTED, &pctx)) { a->name_offset = cpu_to_le16(offsetof(ATTR_RECORD, resident_end)); *fixed = TRUE; fsck_err_fixed(); } else { ntfs_log_error("Name offset is corrupted in attribute(type : 0x%x)", a->type); errno = EIO; ret = -1; goto out; } } else { errno = EIO; ret = -1; goto out; } } if (name_end > value_off) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_VALUE_OFFSET_CORRUPTED, &pctx)) { value_off = name_end; a->value_offset = cpu_to_le16(value_off); *fixed = TRUE; fsck_err_fixed(); } else { errno = EIO; ret = -1; goto out; } } else { ntfs_log_error("Value offset is corrupted in attribute(type : 0x%x)\n", a->type); errno = EIO; ret = -1; goto out; } } if (value_len > vol->mft_record_size || value_len > attr_len || value_off == 0 || value_off > attr_len) { errno = EIO; ret = -1; goto out; } if (((value_off + value_len + 7) & ~7) > attr_len || attr_len < offsetof(ATTR_RECORD, resident_end)) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_LENGTH_CORRUPTED, &pctx)) { attr_len = (value_off + value_len + 7) & ~7; a->length = cpu_to_le32(attr_len); *fixed = TRUE; fsck_err_fixed(); } else { errno = EIO; ret = -1; goto out; } } else { ntfs_log_error("Attribute length is corrupted in attribute(type : 0x%x)\n", a->type); errno = EIO; ret = -1; goto out; } } } if (!ret) { /* * Checking whether an attribute must be [non-]resident * is hard-coded for well-known ones. This should be * done through ntfs_attr_can_be_non_resident(), based on * $AttrDef, but this would give an easy way to bypass * the checks. * Attributes which are not well-known are not checked. * * Note : at this stage we know that a->length and * a->value_length cannot look like being negative. */ switch(a->type) { case AT_FILE_NAME : /* Check file names are resident and do not overflow */ fn = (FILE_NAME_ATTR *)((const u8 *)a + le16_to_cpu(a->value_offset)); if (a->non_resident || (le32_to_cpu(a->value_length) < offsetof(FILE_NAME_ATTR, file_name)) || !fn->file_name_length || ((fn->file_name_length * sizeof(ntfschar) + offsetof(FILE_NAME_ATTR, file_name)) > le32_to_cpu(a->value_length))) { ntfs_log_error("Corrupt file name" " attribute in MFT record %lld.\n", (long long)inum); errno = EIO; ret = -1; } if (!ret && a->resident_flags != RESIDENT_ATTR_IS_INDEXED && !(fn->file_attributes & FILE_ATTR_NOT_CONTENT_INDEXED)) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_FN_FLAG_MISMATCH, &pctx)) { mod_a->resident_flags = RESIDENT_ATTR_IS_INDEXED; *fixed = TRUE; fsck_err_fixed(); } } else { ntfs_log_error("$FILE_NAME attribute's flag " "is not set to be indexed\n"); errno = EIO; ret = -1; } } break; case AT_INDEX_ROOT : /* Check root index is resident and does not overflow */ ir = (INDEX_ROOT *)((const u8 *)a + le16_to_cpu(a->value_offset)); /* index.allocated_size may overflow while resizing */ if (a->non_resident || (le32_to_cpu(a->value_length) < offsetof(INDEX_ROOT, index.reserved)) || (le32_to_cpu(ir->index.entries_offset) < sizeof(INDEX_HEADER)) || (le32_to_cpu(ir->index.index_length) & 7) || (le32_to_cpu(ir->index.allocated_size) & 7) || (le32_to_cpu(ir->index.index_length) < le32_to_cpu(ir->index.entries_offset)) || (le32_to_cpu(ir->index.entries_offset) & 7) || (le32_to_cpu(ir->index.entries_offset) != sizeof(INDEX_HEADER)) || (le32_to_cpu(ir->index.allocated_size) < le32_to_cpu(ir->index.index_length)) || (le32_to_cpu(a->value_length) < (le32_to_cpu(ir->index.allocated_size) + offsetof(INDEX_ROOT, reserved)))) { ntfs_log_error("Corrupt index root" " in MFT record %lld.\n", (long long)inum); errno = EIO; ret = -1; } /* Is it needed? */ if (!ret && le32_to_cpu(ir->index_block_size) != vol->indx_record_size) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_ATTR_IR_SIZE_MISMATCH, &pctx)) { ir->index_block_size = le32_to_cpu(vol->indx_record_size); *fixed = TRUE; fsck_err_fixed(); } } else { ntfs_log_error("Corrupt index block size(%u %u) " "in MFT record %llu.\n", le32_to_cpu(ir->index_block_size), vol->indx_record_size, (unsigned long long)inum); errno = EIO; ret = -1; } } break; case AT_STANDARD_INFORMATION : if (a->non_resident || (le32_to_cpu(a->value_length) < offsetof(STANDARD_INFORMATION, v1_end))) { ntfs_log_error("Corrupt standard information" " in MFT record %lld\n", (long long)inum); errno = EIO; ret = -1; } break; case AT_OBJECT_ID : if (a->non_resident || (le32_to_cpu(a->value_length) < sizeof(GUID))) { ntfs_log_error("Corrupt object id" " in MFT record %lld\n", (long long)inum); errno = EIO; ret = -1; } break; case AT_VOLUME_NAME : case AT_EA_INFORMATION : if (a->non_resident) { ntfs_log_error("Attribute 0x%x in MFT record" " %lld should be resident.\n", (int)le32_to_cpu(a->type), (long long)inum); errno = EIO; ret = -1; } break; case AT_VOLUME_INFORMATION : if (a->non_resident || (le32_to_cpu(a->value_length) < sizeof(VOLUME_INFORMATION))) { ntfs_log_error("Corrupt volume information" " in MFT record %lld\n", (long long)inum); errno = EIO; ret = -1; } break; case AT_INDEX_ALLOCATION : if (!a->non_resident) { ntfs_log_error("Corrupt index allocation" " in MFT record %lld", (long long)inum); errno = EIO; ret = -1; } break; default : break; } } out: if (is_fsck && mref <= FILE_MFTMirr) NVolSetFsck(vol); return (ret); } /** * ntfs_attr_lookup - find an attribute in an ntfs inode * @type: attribute type to find * @name: attribute name to find (optional, i.e. NULL means don't care) * @name_len: attribute name length (only needed if @name present) * @ic: IGNORE_CASE or CASE_SENSITIVE (ignored if @name not present) * @lowest_vcn: lowest vcn to find (optional, non-resident attributes only) * @val: attribute value to find (optional, resident attributes only) * @val_len: attribute value length * @ctx: search context with mft record and attribute to search from * * Find an attribute in an ntfs inode. On first search @ctx->ntfs_ino must * be the base mft record and @ctx must have been obtained from a call to * ntfs_attr_get_search_ctx(). * * This function transparently handles attribute lists and @ctx is used to * continue searches where they were left off at. * * If @type is AT_UNUSED, return the first found attribute, i.e. one can * enumerate all attributes by setting @type to AT_UNUSED and then calling * ntfs_attr_lookup() repeatedly until it returns -1 with errno set to ENOENT * to indicate that there are no more entries. During the enumeration, each * successful call of ntfs_attr_lookup() will return the next attribute, with * the current attribute being described by the search context @ctx. * * If @type is AT_END, seek to the end of the base mft record ignoring the * attribute list completely and return -1 with errno set to ENOENT. AT_END is * not a valid attribute, its length is zero for example, thus it is safer to * return error instead of success in this case. It should never be needed to * do this, but we implement the functionality because it allows for simpler * code inside ntfs_external_attr_find(). * * If @name is AT_UNNAMED search for an unnamed attribute. If @name is present * but not AT_UNNAMED search for a named attribute matching @name. Otherwise, * match both named and unnamed attributes. * * After finishing with the attribute/mft record you need to call * ntfs_attr_put_search_ctx() to cleanup the search context (unmapping any * mapped extent inodes, etc). * * Return 0 if the search was successful and -1 if not, with errno set to the * error code. * * On success, @ctx->attr is the found attribute, it is in mft record * @ctx->mrec, and @ctx->al_entry is the attribute list entry for this * attribute with @ctx->base_* being the base mft record to which @ctx->attr * belongs. If no attribute list attribute is present @ctx->al_entry and * @ctx->base_* are NULL. * * On error ENOENT, i.e. attribute not found, @ctx->attr is set to the * attribute which collates just after the attribute being searched for in the * base ntfs inode, i.e. if one wants to add the attribute to the mft record * this is the correct place to insert it into, and if there is not enough * space, the attribute should be placed in an extent mft record. * @ctx->al_entry points to the position within @ctx->base_ntfs_ino->attr_list * at which the new attribute's attribute list entry should be inserted. The * other @ctx fields, base_ntfs_ino, base_mrec, and base_attr are set to NULL. * The only exception to this is when @type is AT_END, in which case * @ctx->al_entry is set to NULL also (see above). * * * The following error codes are defined: * ENOENT Attribute not found, not an error as such. * EINVAL Invalid arguments. * EIO I/O error or corrupt data structures found. * ENOMEM Not enough memory to allocate necessary buffers. */ int ntfs_attr_lookup(const ATTR_TYPES type, const ntfschar *name, const u32 name_len, const IGNORE_CASE_BOOL ic, const VCN lowest_vcn, const u8 *val, const u32 val_len, ntfs_attr_search_ctx *ctx) { ntfs_volume *vol; ntfs_inode *base_ni; int ret = -1; ntfs_log_enter("Entering for attribute type 0x%x\n", le32_to_cpu(type)); if (!ctx || !ctx->mrec || !ctx->attr || (name && name != AT_UNNAMED && (!ctx->ntfs_ino || !(vol = ctx->ntfs_ino->vol) || !vol->upcase || !vol->upcase_len))) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); goto out; } if (ctx->base_ntfs_ino) base_ni = ctx->base_ntfs_ino; else base_ni = ctx->ntfs_ino; if (!base_ni || !NInoAttrList(base_ni) || type == AT_ATTRIBUTE_LIST) ret = ntfs_attr_find(type, name, name_len, ic, val, val_len, ctx); else ret = ntfs_external_attr_find(type, name, name_len, ic, lowest_vcn, val, val_len, ctx); out: ntfs_log_leave("\n"); return ret; } /** * ntfs_attr_position - find given or next attribute type in an ntfs inode * @type: attribute type to start lookup * @ctx: search context with mft record and attribute to search from * * Find an attribute type in an ntfs inode or the next attribute which is not * the AT_END attribute. Please see more details at ntfs_attr_lookup. * * Return 0 if the search was successful and -1 if not, with errno set to the * error code. * * The following error codes are defined: * EINVAL Invalid arguments. * EIO I/O error or corrupt data structures found. * ENOMEM Not enough memory to allocate necessary buffers. * ENOSPC No attribute was found after 'type', only AT_END. */ int ntfs_attr_position(const ATTR_TYPES type, ntfs_attr_search_ctx *ctx) { if (ntfs_attr_lookup(type, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (errno != ENOENT) return -1; if (ctx->attr->type == AT_END) { errno = ENOSPC; return -1; } } return 0; } /** * ntfs_attr_init_search_ctx - initialize an attribute search context * @ctx: attribute search context to initialize * @ni: ntfs inode with which to initialize the search context * @mrec: mft record with which to initialize the search context * * Initialize the attribute search context @ctx with @ni and @mrec. */ static void ntfs_attr_init_search_ctx(ntfs_attr_search_ctx *ctx, ntfs_inode *ni, MFT_RECORD *mrec) { if (!ni && !mrec) return; if (!mrec) mrec = ni->mrec; ctx->mrec = mrec; /* Sanity checks are performed elsewhere. */ ctx->attr = (ATTR_RECORD*)((u8*)mrec + le16_to_cpu(mrec->attrs_offset)); ctx->is_first = TRUE; ctx->ntfs_ino = ni; ctx->al_entry = NULL; ctx->base_ntfs_ino = NULL; ctx->base_mrec = NULL; ctx->base_attr = NULL; } /** * ntfs_attr_reinit_search_ctx - reinitialize an attribute search context * @ctx: attribute search context to reinitialize * * Reinitialize the attribute search context @ctx. * * This is used when a search for a new attribute is being started to reset * the search context to the beginning. */ void ntfs_attr_reinit_search_ctx(ntfs_attr_search_ctx *ctx) { if (!ctx->base_ntfs_ino) { /* No attribute list. */ ctx->is_first = TRUE; /* Sanity checks are performed elsewhere. */ ctx->attr = (ATTR_RECORD*)((u8*)ctx->mrec + le16_to_cpu(ctx->mrec->attrs_offset)); /* * This needs resetting due to ntfs_external_attr_find() which * can leave it set despite having zeroed ctx->base_ntfs_ino. */ ctx->al_entry = NULL; return; } /* Attribute list. */ ntfs_attr_init_search_ctx(ctx, ctx->base_ntfs_ino, ctx->base_mrec); return; } /** * ntfs_attr_get_search_ctx - allocate/initialize a new attribute search context * @ni: ntfs inode with which to initialize the search context * @mrec: mft record with which to initialize the search context * * Allocate a new attribute search context, initialize it with @ni and @mrec, * and return it. Return NULL on error with errno set. * * @mrec can be NULL, in which case the mft record is taken from @ni. * * Note: For low level utilities which know what they are doing we allow @ni to * be NULL and @mrec to be set. Do NOT do this unless you understand the * implications!!! For example it is no longer safe to call ntfs_attr_lookup(). */ ntfs_attr_search_ctx *ntfs_attr_get_search_ctx(ntfs_inode *ni, MFT_RECORD *mrec) { ntfs_attr_search_ctx *ctx; if (!ni && !mrec) { errno = EINVAL; ntfs_log_perror("NULL arguments"); return NULL; } ctx = ntfs_malloc(sizeof(ntfs_attr_search_ctx)); if (ctx) ntfs_attr_init_search_ctx(ctx, ni, mrec); return ctx; } /** * ntfs_attr_put_search_ctx - release an attribute search context * @ctx: attribute search context to free * * Release the attribute search context @ctx. */ void ntfs_attr_put_search_ctx(ntfs_attr_search_ctx *ctx) { // NOTE: save errno if it could change and function stays void! free(ctx); } /** * ntfs_attr_find_in_attrdef - find an attribute in the $AttrDef system file * @vol: ntfs volume to which the attribute belongs * @type: attribute type which to find * * Search for the attribute definition record corresponding to the attribute * @type in the $AttrDef system file. * * Return the attribute type definition record if found and NULL if not found * or an error occurred. On error the error code is stored in errno. The * following error codes are defined: * ENOENT - The attribute @type is not specified in $AttrDef. * EINVAL - Invalid parameters (e.g. @vol is not valid). */ ATTR_DEF *ntfs_attr_find_in_attrdef(const ntfs_volume *vol, const ATTR_TYPES type) { ATTR_DEF *ad; if (!vol || !vol->attrdef || !type) { errno = EINVAL; ntfs_log_perror("%s: type=%d", __FUNCTION__, le32_to_cpu(type)); return NULL; } for (ad = vol->attrdef; ((ptrdiff_t)((u8*)ad - (u8*)vol->attrdef + sizeof(ATTR_DEF)) <= vol->attrdef_len) && ad->type; ++ad) { /* We haven't found it yet, carry on searching. */ if (le32_to_cpu(ad->type) < le32_to_cpu(type)) continue; /* We found the attribute; return it. */ if (ad->type == type) return ad; /* We have gone too far already. No point in continuing. */ break; } errno = ENOENT; ntfs_log_perror("%s: type=%d", __FUNCTION__, le32_to_cpu(type)); return NULL; } /** * ntfs_attr_size_bounds_check - check a size of an attribute type for validity * @vol: ntfs volume to which the attribute belongs * @type: attribute type which to check * @size: size which to check * * Check whether the @size in bytes is valid for an attribute of @type on the * ntfs volume @vol. This information is obtained from $AttrDef system file. * * Return 0 if valid and -1 if not valid or an error occurred. On error the * error code is stored in errno. The following error codes are defined: * ERANGE - @size is not valid for the attribute @type. * ENOENT - The attribute @type is not specified in $AttrDef. * EINVAL - Invalid parameters (e.g. @size is < 0 or @vol is not valid). */ int ntfs_attr_size_bounds_check(const ntfs_volume *vol, const ATTR_TYPES type, const s64 size) { ATTR_DEF *ad; s64 min_size, max_size; if (size < 0) { errno = EINVAL; ntfs_log_perror("%s: size=%lld", __FUNCTION__, (long long)size); return -1; } /* * $ATTRIBUTE_LIST shouldn't be greater than 0x40000, otherwise * Windows would crash. This is not listed in the AttrDef. */ if (type == AT_ATTRIBUTE_LIST && size > 0x40000) { errno = ERANGE; ntfs_log_perror("Too large attrlist (%lld)", (long long)size); return -1; } ad = ntfs_attr_find_in_attrdef(vol, type); if (!ad) return -1; min_size = sle64_to_cpu(ad->min_size); max_size = sle64_to_cpu(ad->max_size); /* The $AttrDef generated by Windows specifies 2 as min_size for the * volume name attribute, but in reality Windows sets it to 0 when * clearing the volume name. If we want to be able to clear the volume * name we must also accept 0 as min_size, despite the $AttrDef * definition. */ if(type == AT_VOLUME_NAME) min_size = 0; if ((min_size && (size < min_size)) || ((max_size > 0) && (size > max_size))) { errno = ERANGE; ntfs_log_perror("Attr type %d size check failed (min,size,max=" "%lld,%lld,%lld)", le32_to_cpu(type), (long long)min_size, (long long)size, (long long)max_size); return -1; } return 0; } /** * ntfs_attr_can_be_non_resident - check if an attribute can be non-resident * @vol: ntfs volume to which the attribute belongs * @type: attribute type to check * @name: attribute name to check * @name_len: attribute name length * * Check whether the attribute of @type and @name with name length @name_len on * the ntfs volume @vol is allowed to be non-resident. This information is * obtained from $AttrDef system file and is augmented by rules imposed by * Microsoft (e.g. see http://support.microsoft.com/kb/974729/). * * Return 0 if the attribute is allowed to be non-resident and -1 if not or an * error occurred. On error the error code is stored in errno. The following * error codes are defined: * EPERM - The attribute is not allowed to be non-resident. * ENOENT - The attribute @type is not specified in $AttrDef. * EINVAL - Invalid parameters (e.g. @vol is not valid). */ static int ntfs_attr_can_be_non_resident(const ntfs_volume *vol, const ATTR_TYPES type, const ntfschar *name, int name_len) { ATTR_DEF *ad; BOOL allowed; /* * Microsoft has decreed that $LOGGED_UTILITY_STREAM attributes with a * name of $TXF_DATA must be resident despite the entry for * $LOGGED_UTILITY_STREAM in $AttrDef allowing them to be non-resident. * Failure to obey this on the root directory mft record of a volume * causes Windows Vista and later to see the volume as a RAW volume and * thus cannot mount it at all. */ if ((type == AT_LOGGED_UTILITY_STREAM) && name && ntfs_names_are_equal(TXF_DATA, 9, name, name_len, CASE_SENSITIVE, vol->upcase, vol->upcase_len)) allowed = FALSE; else { /* Find the attribute definition record in $AttrDef. */ ad = ntfs_attr_find_in_attrdef(vol, type); if (!ad) return -1; /* Check the flags and return the result. */ allowed = !(ad->flags & ATTR_DEF_RESIDENT); } if (!allowed) { errno = EPERM; ntfs_log_trace("Attribute can't be non-resident\n"); return -1; } return 0; } /** * ntfs_attr_can_be_resident - check if an attribute can be resident * @vol: ntfs volume to which the attribute belongs * @type: attribute type which to check * * Check whether the attribute of @type on the ntfs volume @vol is allowed to * be resident. This information is derived from our ntfs knowledge and may * not be completely accurate, especially when user defined attributes are * present. Basically we allow everything to be resident except for index * allocation and extended attribute attributes. * * Return 0 if the attribute is allowed to be resident and -1 if not or an * error occurred. On error the error code is stored in errno. The following * error codes are defined: * EPERM - The attribute is not allowed to be resident. * EINVAL - Invalid parameters (e.g. @vol is not valid). * * Warning: In the system file $MFT the attribute $Bitmap must be non-resident * otherwise windows will not boot (blue screen of death)! We cannot * check for this here as we don't know which inode's $Bitmap is being * asked about so the caller needs to special case this. */ int ntfs_attr_can_be_resident(const ntfs_volume *vol, const ATTR_TYPES type) { if (!vol || !vol->attrdef || !type) { errno = EINVAL; return -1; } if (type != AT_INDEX_ALLOCATION) return 0; ntfs_log_trace("Attribute can't be resident\n"); errno = EPERM; return -1; } /** * ntfs_make_room_for_attr - make room for an attribute inside an mft record * @m: mft record * @pos: position at which to make space * @size: byte size to make available at this position * * @pos points to the attribute in front of which we want to make space. * * Return 0 on success or -1 on error. On error the error code is stored in * errno. Possible error codes are: * ENOSPC - There is not enough space available to complete operation. The * caller has to make space before calling this. * EINVAL - Input parameters were faulty. */ int ntfs_make_room_for_attr(MFT_RECORD *m, u8 *pos, u32 size) { u32 biu; ntfs_log_trace("Entering for pos 0x%d, size %u.\n", (int)(pos - (u8*)m), (unsigned) size); /* Make size 8-byte alignment. */ size = (size + 7) & ~7; /* Rigorous consistency checks. */ if (!m || !pos || pos < (u8*)m) { errno = EINVAL; ntfs_log_perror("%s: pos=%p m=%p", __FUNCTION__, pos, m); return -1; } /* The -8 is for the attribute terminator. */ if (pos - (u8*)m > (int)le32_to_cpu(m->bytes_in_use) - 8) { errno = EINVAL; return -1; } /* Nothing to do. */ if (!size) return 0; biu = le32_to_cpu(m->bytes_in_use); /* Do we have enough space? */ if (biu + size > le32_to_cpu(m->bytes_allocated) || pos + size > (u8*)m + le32_to_cpu(m->bytes_allocated)) { errno = ENOSPC; ntfs_log_trace("No enough space in the MFT record\n"); return -1; } /* Move everything after pos to pos + size. */ memmove(pos + size, pos, biu - (pos - (u8*)m)); /* Update mft record. */ m->bytes_in_use = cpu_to_le32(biu + size); return 0; } /** * ntfs_resident_attr_record_add - add resident attribute to inode * @ni: opened ntfs inode to which MFT record add attribute * @type: type of the new attribute * @name: name of the new attribute * @name_len: name length of the new attribute * @val: value of the new attribute * @size: size of new attribute (length of @val, if @val != NULL) * @flags: flags of the new attribute * * Return offset to attribute from the beginning of the mft record on success * and -1 on error. On error the error code is stored in errno. * Possible error codes are: * EINVAL - Invalid arguments passed to function. * EEXIST - Attribute of such type and with same name already exists. * EIO - I/O error occurred or damaged filesystem. */ int ntfs_resident_attr_record_add(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, const u8 *val, u32 size, ATTR_FLAGS data_flags) { ntfs_attr_search_ctx *ctx; u32 length; ATTR_RECORD *a; MFT_RECORD *m; int err, offset; ntfs_inode *base_ni; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, flags 0x%x.\n", (long long) ni->mft_no, (unsigned) le32_to_cpu(type), (unsigned) le16_to_cpu(data_flags)); if (!ni || (!name && name_len)) { errno = EINVAL; return -1; } if (ntfs_attr_can_be_resident(ni->vol, type)) { if (errno == EPERM) ntfs_log_trace("Attribute can't be resident.\n"); else ntfs_log_trace("ntfs_attr_can_be_resident failed.\n"); return -1; } /* Locate place where record should be. */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; /* * Use ntfs_attr_find instead of ntfs_attr_lookup to find place for * attribute in @ni->mrec, not any extent inode in case if @ni is base * file record. */ if (!ntfs_attr_find(type, name, name_len, CASE_SENSITIVE, val, size, ctx)) { err = EEXIST; ntfs_log_trace("Attribute already present.\n"); goto put_err_out; } if (errno != ENOENT) { err = EIO; goto put_err_out; } a = ctx->attr; m = ctx->mrec; /* Make room for attribute. */ length = offsetof(ATTR_RECORD, resident_end) + ((name_len * sizeof(ntfschar) + 7) & ~7) + ((size + 7) & ~7); if (ntfs_make_room_for_attr(ctx->mrec, (u8*) ctx->attr, length)) { err = errno; ntfs_log_trace("Failed to make room for attribute.\n"); goto put_err_out; } /* Setup record fields. */ offset = ((u8*)a - (u8*)m); a->type = type; a->length = cpu_to_le32(length); a->non_resident = 0; a->name_length = name_len; a->name_offset = (name_len ? const_cpu_to_le16(offsetof(ATTR_RECORD, resident_end)) : const_cpu_to_le16(0)); a->flags = data_flags; a->instance = m->next_attr_instance; a->value_length = cpu_to_le32(size); a->value_offset = cpu_to_le16(length - ((size + 7) & ~7)); if (val) memcpy((u8*)a + le16_to_cpu(a->value_offset), val, size); else memset((u8*)a + le16_to_cpu(a->value_offset), 0, size); if (type == AT_FILE_NAME) a->resident_flags = RESIDENT_ATTR_IS_INDEXED; else a->resident_flags = 0; if (name_len) memcpy((u8*)a + le16_to_cpu(a->name_offset), name, sizeof(ntfschar) * name_len); m->next_attr_instance = cpu_to_le16((le16_to_cpu(m->next_attr_instance) + 1) & 0xffff); if (ni->nr_extents == -1) base_ni = ni->base_ni; else base_ni = ni; if (type != AT_ATTRIBUTE_LIST && NInoAttrList(base_ni)) { if (ntfs_attrlist_entry_add(ni, a)) { err = errno; ntfs_attr_record_resize(m, a, 0); ntfs_log_trace("Failed add attribute entry to " "ATTRIBUTE_LIST.\n"); goto put_err_out; } } if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY ? type == AT_INDEX_ROOT && name == NTFS_INDEX_I30 : type == AT_DATA && name == AT_UNNAMED) { ni->data_size = size; ni->allocated_size = (size + 7) & ~7; set_nino_flag(ni,KnownSize); } ntfs_inode_mark_dirty(ni); ntfs_attr_put_search_ctx(ctx); return offset; put_err_out: ntfs_attr_put_search_ctx(ctx); errno = err; return -1; } /** * ntfs_non_resident_attr_record_add - add extent of non-resident attribute * @ni: opened ntfs inode to which MFT record add attribute * @type: type of the new attribute extent * @name: name of the new attribute extent * @name_len: name length of the new attribute extent * @lowest_vcn: lowest vcn of the new attribute extent * @dataruns_size: dataruns size of the new attribute extent * @flags: flags of the new attribute extent * * Return offset to attribute from the beginning of the mft record on success * and -1 on error. On error the error code is stored in errno. * Possible error codes are: * EINVAL - Invalid arguments passed to function. * EEXIST - Attribute of such type, with same lowest vcn and with same * name already exists. * EIO - I/O error occurred or damaged filesystem. */ int ntfs_non_resident_attr_record_add(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, VCN lowest_vcn, int dataruns_size, ATTR_FLAGS flags) { ntfs_attr_search_ctx *ctx; u32 length; ATTR_RECORD *a; MFT_RECORD *m; ntfs_inode *base_ni; int err, offset; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, lowest_vcn %lld, " "dataruns_size %d, flags 0x%x.\n", (long long) ni->mft_no, (unsigned) le32_to_cpu(type), (long long) lowest_vcn, dataruns_size, (unsigned) le16_to_cpu(flags)); if (!ni || dataruns_size <= 0 || (!name && name_len)) { errno = EINVAL; return -1; } if (ntfs_attr_can_be_non_resident(ni->vol, type, name, name_len)) { if (errno == EPERM) ntfs_log_perror("Attribute can't be non resident"); else ntfs_log_perror("ntfs_attr_can_be_non_resident failed"); return -1; } /* Locate place where record should be. */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; /* * Use ntfs_attr_find instead of ntfs_attr_lookup to find place for * attribute in @ni->mrec, not any extent inode in case if @ni is base * file record. */ if (!ntfs_attr_find(type, name, name_len, CASE_SENSITIVE, NULL, 0, ctx)) { err = EEXIST; ntfs_log_perror("Attribute 0x%x already present", le32_to_cpu(type)); goto put_err_out; } if (errno != ENOENT) { ntfs_log_perror("ntfs_attr_find failed"); err = EIO; goto put_err_out; } a = ctx->attr; m = ctx->mrec; /* Make room for attribute. */ dataruns_size = (dataruns_size + 7) & ~7; length = offsetof(ATTR_RECORD, compressed_size) + ((sizeof(ntfschar) * name_len + 7) & ~7) + dataruns_size + ((flags & (ATTR_IS_COMPRESSED | ATTR_IS_SPARSE)) ? sizeof(a->compressed_size) : 0); if (ntfs_make_room_for_attr(ctx->mrec, (u8*) ctx->attr, length)) { err = errno; ntfs_log_perror("Failed to make room for attribute"); goto put_err_out; } /* Setup record fields. */ a->type = type; a->length = cpu_to_le32(length); a->non_resident = 1; a->name_length = name_len; a->name_offset = cpu_to_le16(offsetof(ATTR_RECORD, compressed_size) + ((flags & (ATTR_IS_COMPRESSED | ATTR_IS_SPARSE)) ? sizeof(a->compressed_size) : 0)); a->flags = flags; a->instance = m->next_attr_instance; a->lowest_vcn = cpu_to_sle64(lowest_vcn); a->mapping_pairs_offset = cpu_to_le16(length - dataruns_size); a->compression_unit = (flags & ATTR_IS_COMPRESSED) ? STANDARD_COMPRESSION_UNIT : 0; /* If @lowest_vcn == 0, than setup empty attribute. */ if (!lowest_vcn) { a->highest_vcn = const_cpu_to_sle64(-1); a->allocated_size = const_cpu_to_sle64(0); a->data_size = const_cpu_to_sle64(0); a->initialized_size = const_cpu_to_sle64(0); /* Set empty mapping pairs. */ *((u8*)a + le16_to_cpu(a->mapping_pairs_offset)) = 0; } if (name_len) memcpy((u8*)a + le16_to_cpu(a->name_offset), name, sizeof(ntfschar) * name_len); m->next_attr_instance = cpu_to_le16((le16_to_cpu(m->next_attr_instance) + 1) & 0xffff); if (ni->nr_extents == -1) base_ni = ni->base_ni; else base_ni = ni; if (type != AT_ATTRIBUTE_LIST && NInoAttrList(base_ni)) { if (ntfs_attrlist_entry_add(ni, a)) { err = errno; ntfs_log_perror("Failed add attr entry to attrlist"); ntfs_attr_record_resize(m, a, 0); goto put_err_out; } } ntfs_inode_mark_dirty(ni); /* * Locate offset from start of the MFT record where new attribute is * placed. We need relookup it, because record maybe moved during * update of attribute list. */ ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(type, name, name_len, CASE_SENSITIVE, lowest_vcn, NULL, 0, ctx)) { ntfs_log_perror("%s: attribute lookup failed", __FUNCTION__); ntfs_attr_put_search_ctx(ctx); return -1; } offset = (u8*)ctx->attr - (u8*)ctx->mrec; ntfs_attr_put_search_ctx(ctx); return offset; put_err_out: ntfs_attr_put_search_ctx(ctx); errno = err; return -1; } /** * ntfs_attr_record_rm - remove attribute extent * @ctx: search context describing the attribute which should be removed * * If this function succeed, user should reinit search context if he/she wants * use it anymore. * * Return 0 on success and -1 on error. On error the error code is stored in * errno. Possible error codes are: * EINVAL - Invalid arguments passed to function. * EIO - I/O error occurred or damaged filesystem. */ int ntfs_attr_record_rm(ntfs_attr_search_ctx *ctx) { ntfs_inode *base_ni, *ni; ATTR_TYPES type; if (!ctx || !ctx->ntfs_ino || !ctx->mrec || !ctx->attr) { errno = EINVAL; return -1; } ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (long long) ctx->ntfs_ino->mft_no, (unsigned) le32_to_cpu(ctx->attr->type)); type = ctx->attr->type; ni = ctx->ntfs_ino; if (ctx->base_ntfs_ino) base_ni = ctx->base_ntfs_ino; else base_ni = ctx->ntfs_ino; /* Remove attribute itself. */ if (ntfs_attr_record_resize(ctx->mrec, ctx->attr, 0)) { ntfs_log_trace("Couldn't remove attribute record. Bug or damaged MFT " "record.\n"); if (NInoAttrList(base_ni) && type != AT_ATTRIBUTE_LIST) if (ntfs_attrlist_entry_add(ni, ctx->attr)) ntfs_log_trace("Rollback failed. Leaving inconstant " "metadata.\n"); errno = EIO; return -1; } ntfs_inode_mark_dirty(ni); /* * Remove record from $ATTRIBUTE_LIST if present and we don't want * delete $ATTRIBUTE_LIST itself. */ if (NInoAttrList(base_ni) && type != AT_ATTRIBUTE_LIST) { if (ntfs_attrlist_entry_rm(ctx)) { ntfs_log_trace("Couldn't delete record from " "$ATTRIBUTE_LIST.\n"); return -1; } } /* Post $ATTRIBUTE_LIST delete setup. */ if (type == AT_ATTRIBUTE_LIST) { if (NInoAttrList(base_ni) && base_ni->attr_list) free(base_ni->attr_list); base_ni->attr_list = NULL; NInoClearAttrList(base_ni); NInoAttrListClearDirty(base_ni); } /* Free MFT record, if it doesn't contain attributes. */ if (le32_to_cpu(ctx->mrec->bytes_in_use) - le16_to_cpu(ctx->mrec->attrs_offset) == 8) { if (ntfs_mft_record_free(ni->vol, ni)) { // FIXME: We need rollback here. ntfs_log_trace("Couldn't free MFT record.\n"); errno = EIO; return -1; } /* Remove done if we freed base inode. */ if (ni == base_ni) return 0; } if (type == AT_ATTRIBUTE_LIST || !NInoAttrList(base_ni)) return 0; /* Remove attribute list if we don't need it any more. */ if (!ntfs_attrlist_need(base_ni)) { ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* * FIXME: Should we succeed here? Definitely something * goes wrong because NInoAttrList(base_ni) returned * that we have got attribute list. */ ntfs_log_trace("Couldn't find attribute list. Succeed " "anyway.\n"); return 0; } /* Deallocate clusters. */ if (ctx->attr->non_resident) { runlist *al_rl; al_rl = ntfs_mapping_pairs_decompress(base_ni->vol, ctx->attr, NULL); if (!al_rl) { ntfs_log_trace("Couldn't decompress attribute list " "runlist. Succeed anyway.\n"); return 0; } if (ntfs_cluster_free_from_rl(base_ni->vol, al_rl)) { ntfs_log_trace("Leaking clusters! Run chkdsk. " "Couldn't free clusters from " "attribute list runlist.\n"); } free(al_rl); } /* Remove attribute record itself. */ if (ntfs_attr_record_rm(ctx)) { /* * FIXME: Should we succeed here? BTW, chkdsk doesn't * complain if it find MFT record with attribute list, * but without extents. */ ntfs_log_trace("Couldn't remove attribute list. Succeed " "anyway.\n"); return 0; } } return 0; } /** * ntfs_attr_add - add attribute to inode * @ni: opened ntfs inode to which add attribute * @type: type of the new attribute * @name: name in unicode of the new attribute * @name_len: name length in unicode characters of the new attribute * @val: value of new attribute * @size: size of the new attribute / length of @val (if specified) * * @val should always be specified for always resident attributes (eg. FILE_NAME * attribute), for attributes that can become non-resident @val can be NULL * (eg. DATA attribute). @size can be specified even if @val is NULL, in this * case data size will be equal to @size and initialized size will be equal * to 0. * * If inode haven't got enough space to add attribute, add attribute to one of * it extents, if no extents present or no one of them have enough space, than * allocate new extent and add attribute to it. * * If on one of this steps attribute list is needed but not present, than it is * added transparently to caller. So, this function should not be called with * @type == AT_ATTRIBUTE_LIST, if you really need to add attribute list call * ntfs_inode_add_attrlist instead. * * On success return 0. On error return -1 with errno set to the error code. */ int ntfs_attr_add(ntfs_inode *ni, ATTR_TYPES type, ntfschar *name, u8 name_len, const u8 *val, s64 size) { u32 attr_rec_size; int err, i, offset; BOOL is_resident; BOOL can_be_non_resident = FALSE; ntfs_inode *attr_ni; ntfs_attr *na; ATTR_FLAGS data_flags; if (!ni || size < 0 || type == AT_ATTRIBUTE_LIST) { errno = EINVAL; ntfs_log_perror("%s: ni=%p size=%lld", __FUNCTION__, ni, (long long)size); return -1; } ntfs_log_trace("Entering for inode %lld, attr %x, size %lld.\n", (long long)ni->mft_no, le32_to_cpu(type), (long long)size); if (ni->nr_extents == -1) ni = ni->base_ni; /* Check the attribute type and the size. */ if (ntfs_attr_size_bounds_check(ni->vol, type, size)) { if (errno == ENOENT) errno = EIO; return -1; } /* Sanity checks for always resident attributes. */ if (ntfs_attr_can_be_non_resident(ni->vol, type, name, name_len)) { if (errno != EPERM) { err = errno; ntfs_log_perror("ntfs_attr_can_be_non_resident failed"); goto err_out; } /* @val is mandatory. */ if (!val) { errno = EINVAL; ntfs_log_perror("val is mandatory for always resident " "attributes"); return -1; } if (size > ni->vol->mft_record_size) { errno = ERANGE; ntfs_log_perror("Attribute is too big"); return -1; } } else can_be_non_resident = TRUE; /* * Determine resident or not will be new attribute. We add 8 to size in * non resident case for mapping pairs. */ if (!ntfs_attr_can_be_resident(ni->vol, type)) { is_resident = TRUE; } else { if (errno != EPERM) { err = errno; ntfs_log_perror("ntfs_attr_can_be_resident failed"); goto err_out; } is_resident = FALSE; } /* Calculate attribute record size. */ if (is_resident) attr_rec_size = offsetof(ATTR_RECORD, resident_end) + ((name_len * sizeof(ntfschar) + 7) & ~7) + ((size + 7) & ~7); else attr_rec_size = offsetof(ATTR_RECORD, non_resident_end) + ((name_len * sizeof(ntfschar) + 7) & ~7) + 8; /* * If we have enough free space for the new attribute in the base MFT * record, then add attribute to it. */ if (le32_to_cpu(ni->mrec->bytes_allocated) - le32_to_cpu(ni->mrec->bytes_in_use) >= attr_rec_size) { attr_ni = ni; goto add_attr_record; } /* Try to add to extent inodes. */ if (ntfs_inode_attach_all_extents(ni)) { err = errno; ntfs_log_perror("Failed to attach all extents to inode"); goto err_out; } for (i = 0; i < ni->nr_extents; i++) { attr_ni = ni->extent_nis[i]; if (le32_to_cpu(attr_ni->mrec->bytes_allocated) - le32_to_cpu(attr_ni->mrec->bytes_in_use) >= attr_rec_size) goto add_attr_record; } /* There is no extent that contain enough space for new attribute. */ if (!NInoAttrList(ni)) { /* Add attribute list not present, add it and retry. */ if (ntfs_inode_add_attrlist(ni)) { err = errno; ntfs_log_perror("Failed to add attribute list"); goto err_out; } return ntfs_attr_add(ni, type, name, name_len, val, size); } /* Allocate new extent. */ attr_ni = ntfs_mft_record_alloc(ni->vol, ni); if (!attr_ni) { err = errno; ntfs_log_perror("Failed to allocate extent record"); goto err_out; } add_attr_record: if ((ni->flags & FILE_ATTR_COMPRESSED) && (ni->vol->major_ver >= 3) && NVolCompression(ni->vol) && (ni->vol->cluster_size <= MAX_COMPRESSION_CLUSTER_SIZE) && ((type == AT_DATA) || ((type == AT_INDEX_ROOT) && (name == NTFS_INDEX_I30)))) data_flags = ATTR_IS_COMPRESSED; else data_flags = const_cpu_to_le16(0); if (is_resident) { /* Add resident attribute. */ offset = ntfs_resident_attr_record_add(attr_ni, type, name, name_len, val, size, data_flags); if (offset < 0) { if (errno == ENOSPC && can_be_non_resident) goto add_non_resident; err = errno; ntfs_log_perror("Failed to add resident attribute"); goto free_err_out; } return 0; } add_non_resident: /* Add non resident attribute. */ offset = ntfs_non_resident_attr_record_add(attr_ni, type, name, name_len, 0, 8, data_flags); if (offset < 0) { err = errno; ntfs_log_perror("Failed to add non resident attribute"); goto free_err_out; } /* If @size == 0, we are done. */ if (!size) return 0; /* Open new attribute and resize it. */ na = ntfs_attr_open(ni, type, name, name_len); if (!na) { err = errno; ntfs_log_perror("Failed to open just added attribute"); goto rm_attr_err_out; } /* Resize and set attribute value. */ if (ntfs_attr_truncate_i(na, size, HOLES_OK) || (val && (ntfs_attr_pwrite(na, 0, size, val) != size))) { err = errno; ntfs_log_perror("Failed to initialize just added attribute"); if (ntfs_attr_rm(na)) ntfs_log_perror("Failed to remove just added attribute"); ntfs_attr_close(na); goto err_out; } ntfs_attr_close(na); return 0; rm_attr_err_out: /* Remove just added attribute. */ if (ntfs_attr_record_resize(attr_ni->mrec, (ATTR_RECORD*)((u8*)attr_ni->mrec + offset), 0)) ntfs_log_perror("Failed to remove just added attribute #2"); free_err_out: /* Free MFT record, if it doesn't contain attributes. */ if (le32_to_cpu(attr_ni->mrec->bytes_in_use) - le16_to_cpu(attr_ni->mrec->attrs_offset) == 8) if (ntfs_mft_record_free(attr_ni->vol, attr_ni)) ntfs_log_perror("Failed to free MFT record"); err_out: errno = err; return -1; } /* * Change an attribute flag */ int ntfs_attr_set_flags(ntfs_inode *ni, ATTR_TYPES type, const ntfschar *name, u8 name_len, ATTR_FLAGS flags, ATTR_FLAGS mask) { ntfs_attr_search_ctx *ctx; int res; res = -1; /* Search for designated attribute */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (ctx) { if (!ntfs_attr_lookup(type, name, name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* do the requested change (all small endian le16) */ ctx->attr->flags = (ctx->attr->flags & ~mask) | (flags & mask); NInoSetDirty(ni); res = 0; } ntfs_attr_put_search_ctx(ctx); } return (res); } /** * ntfs_attr_rm - remove attribute from ntfs inode * @na: opened ntfs attribute to delete * * Remove attribute and all it's extents from ntfs inode. If attribute was non * resident also free all clusters allocated by attribute. * * Return 0 on success or -1 on error with errno set to the error code. */ int ntfs_attr_rm(ntfs_attr *na) { ntfs_attr_search_ctx *ctx; int ret = 0; if (!na) { ntfs_log_trace("Invalid arguments passed.\n"); errno = EINVAL; return -1; } ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (long long) na->ni->mft_no, le32_to_cpu(na->type)); /* Free cluster allocation. */ if (NAttrNonResident(na)) { if (ntfs_attr_map_whole_runlist(na)) return -1; if (ntfs_cluster_free(na->ni->vol, na, 0, -1) < 0) { ntfs_log_trace("Failed to free cluster allocation. Leaving " "inconstant metadata.\n"); ret = -1; } } /* Search for attribute extents and remove them all. */ ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; while (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (ntfs_attr_record_rm(ctx)) { ntfs_log_trace("Failed to remove attribute extent. Leaving " "inconstant metadata.\n"); ret = -1; } ntfs_attr_reinit_search_ctx(ctx); } ntfs_attr_put_search_ctx(ctx); if (errno != ENOENT) { ntfs_log_trace("Attribute lookup failed. Probably leaving inconstant " "metadata.\n"); ret = -1; } return ret; } /** * ntfs_attr_record_resize - resize an attribute record * @m: mft record containing attribute record * @a: attribute record to resize * @new_size: new size in bytes to which to resize the attribute record @a * * Resize the attribute record @a, i.e. the resident part of the attribute, in * the mft record @m to @new_size bytes. * * Return 0 on success and -1 on error with errno set to the error code. * The following error codes are defined: * ENOSPC - Not enough space in the mft record @m to perform the resize. * Note that on error no modifications have been performed whatsoever. * * Warning: If you make a record smaller without having copied all the data you * are interested in the data may be overwritten! */ int ntfs_attr_record_resize(MFT_RECORD *m, ATTR_RECORD *a, u32 new_size) { u32 old_size, alloc_size, attr_size; old_size = le32_to_cpu(m->bytes_in_use); alloc_size = le32_to_cpu(m->bytes_allocated); attr_size = le32_to_cpu(a->length); ntfs_log_trace("Sizes: old=%u alloc=%u attr=%u new=%u\n", (unsigned)old_size, (unsigned)alloc_size, (unsigned)attr_size, (unsigned)new_size); /* Align to 8 bytes, just in case the caller hasn't. */ new_size = (new_size + 7) & ~7; /* If the actual attribute length has changed, move things around. */ if (new_size != attr_size) { u32 new_muse = old_size - attr_size + new_size; /* Not enough space in this mft record. */ if (new_muse > alloc_size) { errno = ENOSPC; ntfs_log_trace("Not enough space in the MFT record " "(%u > %u)\n", new_muse, alloc_size); return -1; } if (a->type == AT_INDEX_ROOT && new_size > attr_size && new_muse + 120 > alloc_size && old_size + 120 <= alloc_size) { errno = ENOSPC; ntfs_log_trace("Too big INDEX_ROOT (%u > %u)\n", new_muse, alloc_size); return STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT; } /* Move attributes following @a to their new location. */ if (((u8 *)m + old_size) < ((u8 *)a + attr_size)) { ntfs_log_error("Attribute 0x%x overflows" " from MFT record\n", (int)le32_to_cpu(a->type)); errno = EIO; return (-1); } memmove((u8 *)a + new_size, (u8 *)a + attr_size, old_size - ((u8 *)a - (u8 *)m) - attr_size); /* Adjust @m to reflect the change in used space. */ m->bytes_in_use = cpu_to_le32(new_muse); /* Adjust @a to reflect the new size. */ if (new_size >= offsetof(ATTR_REC, length) + sizeof(a->length)) a->length = cpu_to_le32(new_size); } return 0; } /** * ntfs_resident_attr_value_resize - resize the value of a resident attribute * @m: mft record containing attribute record * @a: attribute record whose value to resize * @new_size: new size in bytes to which to resize the attribute value of @a * * Resize the value of the attribute @a in the mft record @m to @new_size bytes. * If the value is made bigger, the newly "allocated" space is cleared. * * Return 0 on success and -1 on error with errno set to the error code. * The following error codes are defined: * ENOSPC - Not enough space in the mft record @m to perform the resize. * Note that on error no modifications have been performed whatsoever. */ int ntfs_resident_attr_value_resize(MFT_RECORD *m, ATTR_RECORD *a, const u32 new_size) { int ret; ntfs_log_trace("Entering for new size %u.\n", (unsigned)new_size); if (!a->value_length) { /* Offset is unsafe when no value */ int offset = ((offsetof(ATTR_RECORD, resident_end) + a->name_length*sizeof(ntfschar) - 1) | 7) + 1; a->value_offset = cpu_to_le16(offset); } /* Resize the resident part of the attribute record. */ if ((ret = ntfs_attr_record_resize(m, a, (le16_to_cpu(a->value_offset) + new_size + 7) & ~7)) < 0) return ret; /* * If we made the attribute value bigger, clear the area between the * old size and @new_size. */ if (new_size > le32_to_cpu(a->value_length)) memset((u8*)a + le16_to_cpu(a->value_offset) + le32_to_cpu(a->value_length), 0, new_size - le32_to_cpu(a->value_length)); /* Finally update the length of the attribute value. */ a->value_length = cpu_to_le32(new_size); return 0; } /** * ntfs_attr_record_move_to - move attribute record to target inode * @ctx: attribute search context describing the attribute record * @ni: opened ntfs inode to which move attribute record * * If this function succeed, user should reinit search context if he/she wants * use it anymore. * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_attr_record_move_to(ntfs_attr_search_ctx *ctx, ntfs_inode *ni) { ntfs_attr_search_ctx *nctx; ATTR_RECORD *a; int err; if (!ctx || !ctx->attr || !ctx->ntfs_ino || !ni) { ntfs_log_trace("Invalid arguments passed.\n"); errno = EINVAL; return -1; } ntfs_log_trace("Entering for ctx->attr->type 0x%x, ctx->ntfs_ino->mft_no " "0x%llx, ni->mft_no 0x%llx.\n", (unsigned) le32_to_cpu(ctx->attr->type), (long long) ctx->ntfs_ino->mft_no, (long long) ni->mft_no); if (ctx->ntfs_ino == ni) return 0; if (!ctx->al_entry) { ntfs_log_trace("Inode should contain attribute list to use this " "function.\n"); errno = EINVAL; return -1; } /* Find place in MFT record where attribute will be moved. */ a = ctx->attr; nctx = ntfs_attr_get_search_ctx(ni, NULL); if (!nctx) return -1; /* * Use ntfs_attr_find instead of ntfs_attr_lookup to find place for * attribute in @ni->mrec, not any extent inode in case if @ni is base * file record. */ if (!ntfs_attr_find(a->type, (ntfschar*)((u8*)a + le16_to_cpu( a->name_offset)), a->name_length, CASE_SENSITIVE, NULL, 0, nctx)) { ntfs_log_trace("Attribute of such type, with same name already " "present in this MFT record.\n"); err = EEXIST; goto put_err_out; } if (errno != ENOENT) { err = errno; ntfs_log_debug("Attribute lookup failed.\n"); goto put_err_out; } /* Make space and move attribute. */ if (ntfs_make_room_for_attr(ni->mrec, (u8*) nctx->attr, le32_to_cpu(a->length))) { err = errno; ntfs_log_trace("Couldn't make space for attribute.\n"); goto put_err_out; } memcpy(nctx->attr, a, le32_to_cpu(a->length)); nctx->attr->instance = nctx->mrec->next_attr_instance; nctx->mrec->next_attr_instance = cpu_to_le16( (le16_to_cpu(nctx->mrec->next_attr_instance) + 1) & 0xffff); ntfs_attr_record_resize(ctx->mrec, a, 0); ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_inode_mark_dirty(ni); /* Update attribute list. */ ctx->al_entry->mft_reference = MK_LE_MREF(ni->mft_no, le16_to_cpu(ni->mrec->sequence_number)); ctx->al_entry->instance = nctx->attr->instance; ntfs_attrlist_mark_dirty(ni); ntfs_attr_put_search_ctx(nctx); return 0; put_err_out: ntfs_attr_put_search_ctx(nctx); errno = err; return -1; } /** * ntfs_attr_record_move_away - move away attribute record from it's mft record * @ctx: attribute search context describing the attribute record * @extra: minimum amount of free space in the new holder of record * * New attribute record holder must have free @extra bytes after moving * attribute record to it. * * If this function succeed, user should reinit search context if he/she wants * use it anymore. * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_attr_record_move_away(ntfs_attr_search_ctx *ctx, int extra) { ntfs_inode *base_ni, *ni; MFT_RECORD *m; int i; if (!ctx || !ctx->attr || !ctx->ntfs_ino || extra < 0) { errno = EINVAL; ntfs_log_perror("%s: ctx=%p ctx->attr=%p extra=%d", __FUNCTION__, ctx, ctx ? ctx->attr : NULL, extra); return -1; } ntfs_log_trace("Entering for attr 0x%x, inode %llu\n", (unsigned) le32_to_cpu(ctx->attr->type), (unsigned long long)ctx->ntfs_ino->mft_no); if (ctx->ntfs_ino->nr_extents == -1) base_ni = ctx->base_ntfs_ino; else base_ni = ctx->ntfs_ino; if (!NInoAttrList(base_ni)) { errno = EINVAL; ntfs_log_perror("Inode %llu has no attrlist", (unsigned long long)base_ni->mft_no); return -1; } if (ntfs_inode_attach_all_extents(ctx->ntfs_ino)) { ntfs_log_perror("Couldn't attach extents, inode=%llu", (unsigned long long)base_ni->mft_no); return -1; } /* Walk through all extents and try to move attribute to them. */ for (i = 0; i < base_ni->nr_extents; i++) { ni = base_ni->extent_nis[i]; m = ni->mrec; if (ctx->ntfs_ino->mft_no == ni->mft_no) continue; if (le32_to_cpu(m->bytes_allocated) - le32_to_cpu(m->bytes_in_use) < le32_to_cpu(ctx->attr->length) + extra) continue; /* * ntfs_attr_record_move_to can fail if extent with other lowest * VCN already present in inode we trying move record to. So, * do not return error. */ if (!ntfs_attr_record_move_to(ctx, ni)) return 0; } /* * Failed to move attribute to one of the current extents, so allocate * new extent and move attribute to it. */ ni = ntfs_mft_record_alloc(base_ni->vol, base_ni); if (!ni) { ntfs_log_perror("Couldn't allocate MFT record"); return -1; } if (ntfs_attr_record_move_to(ctx, ni)) { ntfs_log_perror("Couldn't move attribute to MFT record"); return -1; } return 0; } /** * ntfs_attr_make_non_resident - convert a resident to a non-resident attribute * @na: open ntfs attribute to make non-resident * @ctx: ntfs search context describing the attribute * * Convert a resident ntfs attribute to a non-resident one. * * Return 0 on success and -1 on error with errno set to the error code. The * following error codes are defined: * EPERM - The attribute is not allowed to be non-resident. * TODO: others... * * NOTE to self: No changes in the attribute list are required to move from * a resident to a non-resident attribute. * * Warning: We do not set the inode dirty and we do not write out anything! * We expect the caller to do this as this is a fairly low level * function and it is likely there will be further changes made. */ int ntfs_attr_make_non_resident(ntfs_attr *na, ntfs_attr_search_ctx *ctx) { s64 new_allocated_size, bw; ntfs_volume *vol = na->ni->vol; ATTR_REC *a = ctx->attr; runlist *rl; int mp_size, mp_ofs, name_ofs, arec_size, err; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); /* Some preliminary sanity checking. */ if (NAttrNonResident(na)) { ntfs_log_trace("Eeek! Trying to make non-resident attribute " "non-resident. Aborting...\n"); errno = EINVAL; return -1; } /* Check that the attribute is allowed to be non-resident. */ if (ntfs_attr_can_be_non_resident(vol, na->type, na->name, na->name_len)) return -1; new_allocated_size = (le32_to_cpu(a->value_length) + vol->cluster_size - 1) & ~(vol->cluster_size - 1); if (new_allocated_size > 0) { if ((a->flags & ATTR_COMPRESSION_MASK) == ATTR_IS_COMPRESSED) { /* must allocate full compression blocks */ new_allocated_size = ((new_allocated_size - 1) | ((1L << (STANDARD_COMPRESSION_UNIT + vol->cluster_size_bits)) - 1)) + 1; } /* Start by allocating clusters to hold the attribute value. */ rl = ntfs_cluster_alloc(vol, 0, new_allocated_size >> vol->cluster_size_bits, -1, DATA_ZONE); if (!rl) return -1; } else rl = NULL; /* * Setup the in-memory attribute structure to be non-resident so that * we can use ntfs_attr_pwrite(). */ NAttrSetNonResident(na); NAttrSetBeingNonResident(na); na->rl = rl; na->allocated_size = new_allocated_size; na->data_size = na->initialized_size = le32_to_cpu(a->value_length); /* * FIXME: For now just clear all of these as we don't support them when * writing. */ NAttrClearSparse(na); NAttrClearEncrypted(na); if ((a->flags & ATTR_COMPRESSION_MASK) == ATTR_IS_COMPRESSED) { /* set compression writing parameters */ na->compression_block_size = 1 << (STANDARD_COMPRESSION_UNIT + vol->cluster_size_bits); na->compression_block_clusters = 1 << STANDARD_COMPRESSION_UNIT; } if (rl) { /* Now copy the attribute value to the allocated cluster(s). */ bw = ntfs_attr_pwrite(na, 0, le32_to_cpu(a->value_length), (u8*)a + le16_to_cpu(a->value_offset)); if (bw != le32_to_cpu(a->value_length)) { err = errno; ntfs_log_debug("Eeek! Failed to write out attribute value " "(bw = %lli, errno = %i). " "Aborting...\n", (long long)bw, err); if (bw >= 0) err = EIO; goto cluster_free_err_out; } } /* Determine the size of the mapping pairs array. */ mp_size = ntfs_get_size_for_mapping_pairs(vol, rl, 0, INT_MAX); if (mp_size < 0) { err = errno; ntfs_log_debug("Eeek! Failed to get size for mapping pairs array. " "Aborting...\n"); goto cluster_free_err_out; } /* Calculate new offsets for the name and the mapping pairs array. */ if (na->ni->flags & FILE_ATTR_COMPRESSED) name_ofs = (sizeof(ATTR_REC) + 7) & ~7; else name_ofs = (sizeof(ATTR_REC) - sizeof(a->compressed_size) + 7) & ~7; mp_ofs = (name_ofs + a->name_length * sizeof(ntfschar) + 7) & ~7; /* * Determine the size of the resident part of the non-resident * attribute record. (Not compressed thus no compressed_size element * present.) */ arec_size = (mp_ofs + mp_size + 7) & ~7; /* Resize the resident part of the attribute record. */ if (ntfs_attr_record_resize(ctx->mrec, a, arec_size) < 0) { err = errno; goto cluster_free_err_out; } /* * Convert the resident part of the attribute record to describe a * non-resident attribute. */ a->non_resident = 1; /* Move the attribute name if it exists and update the offset. */ if (a->name_length) memmove((u8*)a + name_ofs, (u8*)a + le16_to_cpu(a->name_offset), a->name_length * sizeof(ntfschar)); a->name_offset = cpu_to_le16(name_ofs); /* Setup the fields specific to non-resident attributes. */ a->lowest_vcn = const_cpu_to_sle64(0); a->highest_vcn = cpu_to_sle64((new_allocated_size - 1) >> vol->cluster_size_bits); a->mapping_pairs_offset = cpu_to_le16(mp_ofs); /* * Update the flags to match the in-memory ones. * However cannot change the compression state if we had * a fuse_file_info open with a mark for release. * The decisions about compression can only be made when * creating/recreating the stream, not when making non resident. */ a->flags &= ~(ATTR_IS_SPARSE | ATTR_IS_ENCRYPTED); if ((a->flags & ATTR_COMPRESSION_MASK) == ATTR_IS_COMPRESSED) { /* support only ATTR_IS_COMPRESSED compression mode */ a->compression_unit = STANDARD_COMPRESSION_UNIT; a->compressed_size = const_cpu_to_sle64(0); } else { a->compression_unit = 0; a->flags &= ~ATTR_COMPRESSION_MASK; na->data_flags = a->flags; } memset(&a->reserved1, 0, sizeof(a->reserved1)); a->allocated_size = cpu_to_sle64(new_allocated_size); a->data_size = a->initialized_size = cpu_to_sle64(na->data_size); /* Generate the mapping pairs array in the attribute record. */ if (ntfs_mapping_pairs_build(vol, (u8*)a + mp_ofs, arec_size - mp_ofs, rl, 0, NULL) < 0) { // FIXME: Eeek! We need rollback! (AIA) ntfs_log_trace("Eeek! Failed to build mapping pairs. Leaving " "corrupt attribute record on disk. In memory " "runlist is still intact! Error code is %i. " "FIXME: Need to rollback instead!\n", errno); return -1; } /* Done! */ return 0; cluster_free_err_out: if (rl && ntfs_cluster_free(vol, na, 0, -1) < 0) ntfs_log_trace("Eeek! Failed to release allocated clusters in error " "code path. Leaving inconsistent metadata...\n"); NAttrClearNonResident(na); NAttrClearFullyMapped(na); na->allocated_size = na->data_size; na->rl = NULL; free(rl); errno = err; return -1; } static int ntfs_resident_attr_resize(ntfs_attr *na, const s64 newsize); /** * ntfs_resident_attr_resize - resize a resident, open ntfs attribute * @na: resident ntfs attribute to resize * @newsize: new size (in bytes) to which to resize the attribute * * Change the size of a resident, open ntfs attribute @na to @newsize bytes. * Can also be used to force an attribute non-resident. In this case, the * size cannot be changed. * * On success return 0 * On error return values are: * STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT * STATUS_ERROR - otherwise * The following error codes are defined: * ENOMEM - Not enough memory to complete operation. * ERANGE - @newsize is not valid for the attribute type of @na. * ENOSPC - There is no enough space in base mft to resize $ATTRIBUTE_LIST. */ static int ntfs_resident_attr_resize_i(ntfs_attr *na, const s64 newsize, hole_type holes) { ntfs_attr_search_ctx *ctx; ntfs_volume *vol; ntfs_inode *ni; int err, ret = STATUS_ERROR; ntfs_log_trace("Inode 0x%llx attr 0x%x new size %lld\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)newsize); /* Get the attribute record that needs modification. */ ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; if (ntfs_attr_lookup(na->type, na->name, na->name_len, 0, 0, NULL, 0, ctx)) { err = errno; ntfs_log_perror("ntfs_attr_lookup failed"); goto put_err_out; } vol = na->ni->vol; /* * Check the attribute type and the corresponding minimum and maximum * sizes against @newsize and fail if @newsize is out of bounds. */ if (ntfs_attr_size_bounds_check(vol, na->type, newsize) < 0) { err = errno; if (err == ENOENT) err = EIO; ntfs_log_perror("%s: bounds check failed", __FUNCTION__); goto put_err_out; } /* * If @newsize is bigger than the mft record we need to make the * attribute non-resident if the attribute type supports it. If it is * smaller we can go ahead and attempt the resize. */ if ((newsize < vol->mft_record_size) && (holes != HOLES_NONRES)) { /* Perform the resize of the attribute record. */ if (!(ret = ntfs_resident_attr_value_resize(ctx->mrec, ctx->attr, newsize))) { /* Update attribute size everywhere. */ na->data_size = na->initialized_size = newsize; na->allocated_size = (newsize + 7) & ~7; if ((na->data_flags & ATTR_COMPRESSION_MASK) || NAttrSparse(na)) na->compressed_size = na->allocated_size; if (na->ni->mrec->flags & MFT_RECORD_IS_DIRECTORY ? na->type == AT_INDEX_ROOT && na->name == NTFS_INDEX_I30 : na->type == AT_DATA && na->name == AT_UNNAMED) { na->ni->data_size = na->data_size; if (((na->data_flags & ATTR_COMPRESSION_MASK) || NAttrSparse(na)) && NAttrNonResident(na)) na->ni->allocated_size = na->compressed_size; else na->ni->allocated_size = na->allocated_size; set_nino_flag(na->ni,KnownSize); if (na->type == AT_DATA) NInoFileNameSetDirty(na->ni); } goto resize_done; } /* Prefer AT_INDEX_ALLOCATION instead of AT_ATTRIBUTE_LIST */ if (ret == STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT) { err = errno; goto put_err_out; } } /* There is not enough space in the mft record to perform the resize. */ /* Make the attribute non-resident if possible. */ if (!ntfs_attr_make_non_resident(na, ctx)) { ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); /* * do not truncate when forcing non-resident, this * could cause the attribute to be made resident again, * so size changes are not allowed. */ if (holes == HOLES_NONRES) { ret = 0; if (newsize != na->data_size) { ntfs_log_error("Cannot change size when" " forcing non-resident\n"); errno = EIO; ret = STATUS_ERROR; } return (ret); } /* Resize non-resident attribute */ return ntfs_attr_truncate_i(na, newsize, holes); } else if (errno != ENOSPC && errno != EPERM) { err = errno; ntfs_log_perror("Failed to make attribute non-resident"); goto put_err_out; } /* Try to make other attributes non-resident and retry each time. */ ntfs_attr_init_search_ctx(ctx, NULL, na->ni->mrec); while (!ntfs_attr_lookup(AT_UNUSED, NULL, 0, 0, 0, NULL, 0, ctx)) { ntfs_attr *tna; ATTR_RECORD *a; a = ctx->attr; if (a->non_resident) continue; /* * Check out whether convert is reasonable. Assume that mapping * pairs will take 8 bytes. */ if (le32_to_cpu(a->length) <= offsetof(ATTR_RECORD, compressed_size) + ((a->name_length * sizeof(ntfschar) + 7) & ~7) + 8) continue; tna = ntfs_attr_open(na->ni, a->type, (ntfschar*)((u8*)a + le16_to_cpu(a->name_offset)), a->name_length); if (!tna) { err = errno; ntfs_log_perror("Couldn't open attribute"); goto put_err_out; } if (ntfs_attr_make_non_resident(tna, ctx)) { ntfs_attr_close(tna); continue; } if ((tna->type == AT_DATA) && !tna->name_len) { /* * If we had to make the unnamed data attribute * non-resident, propagate its new allocated size * to all name attributes and directory indexes */ tna->ni->allocated_size = tna->allocated_size; NInoFileNameSetDirty(tna->ni); } if (((tna->data_flags & ATTR_COMPRESSION_MASK) == ATTR_IS_COMPRESSED) && ntfs_attr_pclose(tna)) { err = errno; ntfs_attr_close(tna); goto put_err_out; } ntfs_inode_mark_dirty(tna->ni); ntfs_attr_close(tna); ntfs_attr_put_search_ctx(ctx); return ntfs_resident_attr_resize_i(na, newsize, holes); } /* Check whether error occurred. */ if (errno != ENOENT) { err = errno; ntfs_log_perror("%s: Attribute lookup failed 1", __FUNCTION__); goto put_err_out; } /* * The standard information and attribute list attributes can't be * moved out from the base MFT record, so try to move out others. */ if (na->type==AT_STANDARD_INFORMATION || na->type==AT_ATTRIBUTE_LIST) { ntfs_attr_put_search_ctx(ctx); if (!NInoAttrList(na->ni) && ntfs_inode_add_attrlist(na->ni)) { ntfs_log_perror("Could not add attribute list"); return -1; } if (ntfs_inode_free_space(na->ni, offsetof(ATTR_RECORD, non_resident_end) + 8)) { ntfs_log_perror("Could not free space in MFT record"); return -1; } return ntfs_resident_attr_resize_i(na, newsize, holes); } /* * Move the attribute to a new mft record, creating an attribute list * attribute or modifying it if it is already present. */ /* Point search context back to attribute which we need resize. */ ntfs_attr_init_search_ctx(ctx, na->ni, NULL); if (ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("%s: Attribute lookup failed 2", __FUNCTION__); err = errno; goto put_err_out; } /* * Check whether attribute is already single in this MFT record. * 8 added for the attribute terminator. */ if (le32_to_cpu(ctx->mrec->bytes_in_use) == le16_to_cpu(ctx->mrec->attrs_offset) + le32_to_cpu(ctx->attr->length) + 8) { err = ENOSPC; ntfs_log_trace("MFT record is filled with one attribute\n"); ret = STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT; goto put_err_out; } /* Add attribute list if not present. */ if (na->ni->nr_extents == -1) ni = na->ni->base_ni; else ni = na->ni; if (!NInoAttrList(ni)) { ntfs_attr_put_search_ctx(ctx); if (ntfs_inode_add_attrlist(ni)) return -1; return ntfs_resident_attr_resize_i(na, newsize, holes); } /* Allocate new mft record. */ ni = ntfs_mft_record_alloc(vol, ni); if (!ni) { err = errno; ntfs_log_perror("Couldn't allocate new MFT record"); goto put_err_out; } /* Move attribute to it. */ if (ntfs_attr_record_move_to(ctx, ni)) { err = errno; ntfs_log_perror("Couldn't move attribute to new MFT record"); goto put_err_out; } /* Update ntfs attribute. */ if (na->ni->nr_extents == -1) na->ni = ni; ntfs_attr_put_search_ctx(ctx); /* Try to perform resize once again. */ return ntfs_resident_attr_resize_i(na, newsize, holes); resize_done: /* * Set the inode (and its base inode if it exists) dirty so it is * written out later. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); return 0; put_err_out: ntfs_attr_put_search_ctx(ctx); errno = err; return ret; } static int ntfs_resident_attr_resize(ntfs_attr *na, const s64 newsize) { int ret; ntfs_log_enter("Entering\n"); ret = ntfs_resident_attr_resize_i(na, newsize, HOLES_OK); ntfs_log_leave("\n"); return ret; } /* * Force an attribute to be made non-resident without * changing its size. * * This is particularly needed when the attribute has no data, * as the non-resident variant requires more space in the MFT * record, and may imply expelling some other attribute. * * As a consequence the existing ntfs_attr_search_ctx's have to * be closed or reinitialized. * * returns 0 if successful, * < 0 if failed, with errno telling why */ int ntfs_attr_force_non_resident(ntfs_attr *na) { int res; res = ntfs_resident_attr_resize_i(na, na->data_size, HOLES_NONRES); if (!res && !NAttrNonResident(na)) { res = -1; errno = EIO; ntfs_log_error("Failed to force non-resident\n"); } return (res); } /** * ntfs_attr_make_resident - convert a non-resident to a resident attribute * @na: open ntfs attribute to make resident * @ctx: ntfs search context describing the attribute * * Convert a non-resident ntfs attribute to a resident one. * * Return 0 on success and -1 on error with errno set to the error code. The * following error codes are defined: * EINVAL - Invalid arguments passed. * EPERM - The attribute is not allowed to be resident. * EIO - I/O error, damaged inode or bug. * ENOSPC - There is no enough space to perform conversion. * EOPNOTSUPP - Requested conversion is not supported yet. * * Warning: We do not set the inode dirty and we do not write out anything! * We expect the caller to do this as this is a fairly low level * function and it is likely there will be further changes made. */ int ntfs_attr_make_resident(ntfs_attr *na, ntfs_attr_search_ctx *ctx) { ntfs_volume *vol = na->ni->vol; ATTR_REC *a = ctx->attr; int name_ofs, val_ofs, err = EIO; s64 arec_size, bytes_read; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); /* Should be called for the first extent of the attribute. */ if (sle64_to_cpu(a->lowest_vcn)) { ntfs_log_trace("Eeek! Should be called for the first extent of the " "attribute. Aborting...\n"); errno = EINVAL; return -1; } /* Some preliminary sanity checking. */ if (!NAttrNonResident(na)) { ntfs_log_trace("Eeek! Trying to make resident attribute resident. " "Aborting...\n"); errno = EINVAL; return -1; } /* Make sure this is not $MFT/$BITMAP or Windows will not boot! */ if (na->type == AT_BITMAP && na->ni->mft_no == FILE_MFT) { errno = EPERM; return -1; } /* Check that the attribute is allowed to be resident. */ if (ntfs_attr_can_be_resident(vol, na->type)) return -1; if (na->data_flags & ATTR_IS_ENCRYPTED) { ntfs_log_trace("Making encrypted streams resident is not " "implemented yet.\n"); errno = EOPNOTSUPP; return -1; } /* Work out offsets into and size of the resident attribute. */ name_ofs = 24; /* = sizeof(resident_ATTR_REC); */ val_ofs = (name_ofs + a->name_length * sizeof(ntfschar) + 7) & ~7; arec_size = (val_ofs + na->data_size + 7) & ~7; /* Sanity check the size before we start modifying the attribute. */ if (le32_to_cpu(ctx->mrec->bytes_in_use) - le32_to_cpu(a->length) + arec_size > le32_to_cpu(ctx->mrec->bytes_allocated)) { errno = ENOSPC; ntfs_log_trace("Not enough space to make attribute resident\n"); return -1; } /* Read and cache the whole runlist if not already done. */ if (ntfs_attr_map_whole_runlist(na)) return -1; /* Move the attribute name if it exists and update the offset. */ if (a->name_length) { memmove((u8*)a + name_ofs, (u8*)a + le16_to_cpu(a->name_offset), a->name_length * sizeof(ntfschar)); } a->name_offset = cpu_to_le16(name_ofs); /* Resize the resident part of the attribute record. */ if (ntfs_attr_record_resize(ctx->mrec, a, arec_size) < 0) { /* * Bug, because ntfs_attr_record_resize should not fail (we * already checked that attribute fits MFT record). */ ntfs_log_error("BUG! Failed to resize attribute record. " "Please report to the %s. Aborting...\n", NTFS_DEV_LIST); errno = EIO; return -1; } /* Convert the attribute record to describe a resident attribute. */ a->non_resident = 0; a->flags = const_cpu_to_le16(0); a->value_length = cpu_to_le32(na->data_size); a->value_offset = cpu_to_le16(val_ofs); /* * If a data stream was wiped out, adjust the compression mode * to current state of compression flag */ if (!na->data_size && (na->type == AT_DATA) && (na->ni->vol->major_ver >= 3) && NVolCompression(na->ni->vol) && (na->ni->vol->cluster_size <= MAX_COMPRESSION_CLUSTER_SIZE) && (na->ni->flags & FILE_ATTR_COMPRESSED)) { a->flags |= ATTR_IS_COMPRESSED; na->data_flags = a->flags; } /* * File names cannot be non-resident so we would never see this here * but at least it serves as a reminder that there may be attributes * for which we do need to set this flag. (AIA) */ if (a->type == AT_FILE_NAME) a->resident_flags = RESIDENT_ATTR_IS_INDEXED; else a->resident_flags = 0; a->reservedR = 0; /* Sanity fixup... Shouldn't really happen. (AIA) */ if (na->initialized_size > na->data_size) na->initialized_size = na->data_size; /* Copy data from run list to resident attribute value. */ bytes_read = ntfs_rl_pread(vol, na->rl, 0, na->initialized_size, (u8*)a + val_ofs); if (bytes_read != na->initialized_size) { if (bytes_read < 0) err = errno; ntfs_log_trace("Eeek! Failed to read attribute data. Leaving " "inconstant metadata. Run chkdsk. " "Aborting...\n"); errno = err; return -1; } /* Clear memory in gap between initialized_size and data_size. */ if (na->initialized_size < na->data_size) memset((u8*)a + val_ofs + na->initialized_size, 0, na->data_size - na->initialized_size); /* * Deallocate clusters from the runlist. * * NOTE: We can use ntfs_cluster_free() because we have already mapped * the whole run list and thus it doesn't matter that the attribute * record is in a transiently corrupted state at this moment in time. */ if (ntfs_cluster_free(vol, na, 0, -1) < 0) { ntfs_log_perror("Eeek! Failed to release allocated clusters"); ntfs_log_trace("Ignoring error and leaving behind wasted " "clusters.\n"); } /* Throw away the now unused runlist. */ free(na->rl); na->rl = NULL; /* Update in-memory struct ntfs_attr. */ NAttrClearNonResident(na); NAttrClearFullyMapped(na); NAttrClearSparse(na); NAttrClearEncrypted(na); na->initialized_size = na->data_size; na->allocated_size = na->compressed_size = (na->data_size + 7) & ~7; na->compression_block_size = 0; na->compression_block_size_bits = na->compression_block_clusters = 0; return 0; } /* * If we are in the first extent, then set/clean sparse bit, * update allocated and compressed size. */ static int ntfs_attr_update_meta(ATTR_RECORD *a, ntfs_attr *na, MFT_RECORD *m, hole_type holes, ntfs_attr_search_ctx *ctx) { int sparse, ret = 0; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); if (a->lowest_vcn) goto out; a->allocated_size = cpu_to_sle64(na->allocated_size); /* Update sparse bit, unless this is an intermediate state */ if (holes == HOLES_DELAY) sparse = (a->flags & ATTR_IS_SPARSE) != const_cpu_to_le16(0); else { sparse = ntfs_rl_sparse(na->rl); if (sparse == -1) { errno = EIO; goto error; } } /* Check whether attribute becomes sparse, unless check is delayed. */ if ((holes != HOLES_DELAY) && sparse && !(a->flags & (ATTR_IS_SPARSE | ATTR_IS_COMPRESSED))) { /* * Move attribute to another mft record, if attribute is too * small to add compressed_size field to it and we have no * free space in the current mft record. */ if ((le32_to_cpu(a->length) - le16_to_cpu(a->mapping_pairs_offset) == 8) && !(le32_to_cpu(m->bytes_allocated) - le32_to_cpu(m->bytes_in_use))) { if (!NInoAttrList(na->ni)) { ntfs_attr_put_search_ctx(ctx); if (ntfs_inode_add_attrlist(na->ni)) goto leave; goto retry; } if (ntfs_attr_record_move_away(ctx, 8)) { ntfs_log_perror("Failed to move attribute"); goto error; } ntfs_attr_put_search_ctx(ctx); goto retry; } if (!(le32_to_cpu(a->length) - le16_to_cpu( a->mapping_pairs_offset))) { errno = EIO; ntfs_log_perror("Mapping pairs space is 0"); goto error; } NAttrSetSparse(na); a->flags |= ATTR_IS_SPARSE; na->data_flags = a->flags; a->compression_unit = STANDARD_COMPRESSION_UNIT; /* Windows set it so, even if attribute is not actually compressed. */ memmove((u8*)a + le16_to_cpu(a->name_offset) + 8, (u8*)a + le16_to_cpu(a->name_offset), a->name_length * sizeof(ntfschar)); a->name_offset = cpu_to_le16(le16_to_cpu(a->name_offset) + 8); a->mapping_pairs_offset = cpu_to_le16(le16_to_cpu(a->mapping_pairs_offset) + 8); } /* Attribute no longer sparse. */ if (!sparse && (a->flags & ATTR_IS_SPARSE) && !(a->flags & ATTR_IS_COMPRESSED)) { NAttrClearSparse(na); a->flags &= ~ATTR_IS_SPARSE; na->data_flags = a->flags; a->compression_unit = 0; memmove((u8*)a + le16_to_cpu(a->name_offset) - 8, (u8*)a + le16_to_cpu(a->name_offset), a->name_length * sizeof(ntfschar)); if (le16_to_cpu(a->name_offset) >= 8) a->name_offset = cpu_to_le16(le16_to_cpu(a->name_offset) - 8); a->mapping_pairs_offset = cpu_to_le16(le16_to_cpu(a->mapping_pairs_offset) - 8); } /* Update compressed size if required. */ if (NAttrFullyMapped(na) && (sparse || (na->data_flags & ATTR_COMPRESSION_MASK))) { s64 new_compr_size; new_compr_size = ntfs_rl_get_compressed_size(na->ni->vol, na->rl); if (new_compr_size == -1) goto error; na->compressed_size = new_compr_size; a->compressed_size = cpu_to_sle64(new_compr_size); } /* * Set FILE_NAME dirty flag, to update sparse bit and * allocated size in the index. */ if (na->type == AT_DATA && na->name == AT_UNNAMED) { if (sparse || (na->data_flags & ATTR_COMPRESSION_MASK)) na->ni->allocated_size = na->compressed_size; else na->ni->allocated_size = na->allocated_size; NInoFileNameSetDirty(na->ni); } out: return ret; leave: ret = -1; goto out; /* return -1 */ retry: ret = -2; goto out; error: ret = -3; goto out; } #define NTFS_VCN_DELETE_MARK -2 /** * ntfs_attr_update_mapping_pairs_i - see ntfs_attr_update_mapping_pairs */ static int ntfs_attr_update_mapping_pairs_i(ntfs_attr *na, VCN from_vcn, hole_type holes) { ntfs_attr_search_ctx *ctx; ntfs_inode *ni, *base_ni; MFT_RECORD *m; ATTR_RECORD *a; VCN stop_vcn; const runlist_element *stop_rl; int err, mp_size, cur_max_mp_size, exp_max_mp_size, ret = -1; BOOL finished_build; BOOL first_updated = FALSE; retry: if (!na || !na->rl) { errno = EINVAL; ntfs_log_perror("%s: na=%p", __FUNCTION__, na); return -1; } ntfs_log_trace("Entering for inode %llu, attr 0x%x\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type)); if (!NAttrNonResident(na)) { errno = EINVAL; ntfs_log_perror("%s: resident attribute", __FUNCTION__); return -1; } #if PARTIAL_RUNLIST_UPDATING /* * For a file just been made sparse, we will have * to reformat the first extent, so be sure the * runlist is fully mapped and fully processed. * Same if the file was sparse and is not any more. * Note : not needed if the full runlist is to be processed */ if ((holes != HOLES_DELAY) && (!NAttrFullyMapped(na) || from_vcn) && !(na->data_flags & ATTR_IS_COMPRESSED)) { BOOL changed; if (!(na->data_flags & ATTR_IS_SPARSE)) { int sparse = 0; runlist_element *xrl; /* * If attribute was not sparse, we only * have to check whether there is a hole * in the updated region. */ for (xrl = na->rl; xrl->length; xrl++) { if (xrl->lcn < 0) { if (xrl->lcn == LCN_HOLE) { sparse = 1; break; } if (xrl->lcn != LCN_RL_NOT_MAPPED) { sparse = -1; break; } } } if (sparse < 0) { ntfs_log_error("Could not check whether sparse\n"); errno = EIO; return (-1); } changed = sparse > 0; } else { /* * If attribute was sparse, the compressed * size has been maintained, and it gives * and easy way to check whether the * attribute is still sparse. */ changed = (((na->data_size - 1) | (na->ni->vol->cluster_size - 1)) + 1) == na->compressed_size; } if (changed) { if (ntfs_attr_map_whole_runlist(na)) { ntfs_log_error("Could not map whole for sparse change\n"); errno = EIO; return (-1); } from_vcn = 0; } } #endif if (na->ni->nr_extents == -1) base_ni = na->ni->base_ni; else base_ni = na->ni; ctx = ntfs_attr_get_search_ctx(base_ni, NULL); if (!ctx) return -1; /* Fill attribute records with new mapping pairs. */ stop_vcn = 0; stop_rl = na->rl; finished_build = FALSE; while (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, from_vcn, NULL, 0, ctx)) { a = ctx->attr; m = ctx->mrec; if (!a->lowest_vcn) first_updated = TRUE; /* * If runlist is updating not from the beginning, then set * @stop_vcn properly, i.e. to the lowest vcn of record that * contain @from_vcn. Also we do not need @from_vcn anymore, * set it to 0 to make ntfs_attr_lookup enumerate attributes. */ if (from_vcn) { LCN first_lcn; stop_vcn = sle64_to_cpu(a->lowest_vcn); from_vcn = 0; /* * Check whether the first run we need to update is * the last run in runlist, if so, then deallocate * all attrubute extents starting this one. */ first_lcn = ntfs_rl_vcn_to_lcn(na->rl, stop_vcn); if (first_lcn == LCN_EINVAL) { errno = EIO; ntfs_log_perror("Bad runlist"); goto put_err_out; } if (first_lcn == LCN_ENOENT || first_lcn == LCN_RL_NOT_MAPPED) finished_build = TRUE; } /* * Check whether we finished mapping pairs build, if so mark * extent as need to delete (by setting highest vcn to * NTFS_VCN_DELETE_MARK (-2), we shall check it later and * delete extent) and continue search. */ if (finished_build) { ntfs_log_trace("Mark attr 0x%x for delete in inode " "%lld.\n", (unsigned)le32_to_cpu(a->type), (long long)ctx->ntfs_ino->mft_no); a->highest_vcn = cpu_to_sle64(NTFS_VCN_DELETE_MARK); ntfs_inode_mark_dirty(ctx->ntfs_ino); continue; } switch (ntfs_attr_update_meta(a, na, m, holes, ctx)) { case -1: return -1; case -2: goto retry; case -3: goto put_err_out; } /* * Determine maximum possible length of mapping pairs, * if we shall *not* expand space for mapping pairs. */ cur_max_mp_size = le32_to_cpu(a->length) - le16_to_cpu(a->mapping_pairs_offset); /* * Determine maximum possible length of mapping pairs in the * current mft record, if we shall expand space for mapping * pairs. */ exp_max_mp_size = le32_to_cpu(m->bytes_allocated) - le32_to_cpu(m->bytes_in_use) + cur_max_mp_size; /* Get the size for the rest of mapping pairs array. */ mp_size = ntfs_get_size_for_mapping_pairs(na->ni->vol, stop_rl, stop_vcn, exp_max_mp_size); if (mp_size <= 0) { ntfs_log_perror("%s: get MP size failed", __FUNCTION__); goto put_err_out; } /* Test mapping pairs for fitting in the current mft record. */ if (mp_size > exp_max_mp_size) { /* * Mapping pairs of $ATTRIBUTE_LIST attribute must fit * in the base mft record. Try to move out other * attributes and try again. */ if (na->type == AT_ATTRIBUTE_LIST) { ntfs_attr_put_search_ctx(ctx); if (ntfs_inode_free_space(na->ni, mp_size - cur_max_mp_size)) { ntfs_log_perror("Attribute list is too " "big. Defragment the " "volume\n"); return -1; } goto retry; } /* Add attribute list if it isn't present, and retry. */ if (!NInoAttrList(base_ni)) { ntfs_attr_put_search_ctx(ctx); if (ntfs_inode_add_attrlist(base_ni)) { ntfs_log_perror("Can not add attrlist"); return -1; } goto retry; } /* * Set mapping pairs size to maximum possible for this * mft record. We shall write the rest of mapping pairs * to another MFT records. */ mp_size = exp_max_mp_size; } /* Change space for mapping pairs if we need it. */ if (((mp_size + 7) & ~7) != cur_max_mp_size) { if (ntfs_attr_record_resize(m, a, le16_to_cpu(a->mapping_pairs_offset) + mp_size)) { errno = EIO; ntfs_log_perror("Failed to resize attribute"); goto put_err_out; } } /* Update lowest vcn. */ a->lowest_vcn = cpu_to_sle64(stop_vcn); ntfs_inode_mark_dirty(ctx->ntfs_ino); if ((ctx->ntfs_ino->nr_extents == -1 || NInoAttrList(ctx->ntfs_ino)) && ctx->attr->type != AT_ATTRIBUTE_LIST) { ctx->al_entry->lowest_vcn = cpu_to_sle64(stop_vcn); ntfs_attrlist_mark_dirty(ctx->ntfs_ino); } /* * Generate the new mapping pairs array directly into the * correct destination, i.e. the attribute record itself. */ if (!ntfs_mapping_pairs_build(na->ni->vol, (u8*)a + le16_to_cpu( a->mapping_pairs_offset), mp_size, na->rl, stop_vcn, &stop_rl)) finished_build = TRUE; if (stop_rl) stop_vcn = stop_rl->vcn; else stop_vcn = 0; if (!finished_build && errno != ENOSPC) { ntfs_log_perror("Failed to build mapping pairs"); goto put_err_out; } a->highest_vcn = cpu_to_sle64(stop_vcn - 1); } /* Check whether error occurred. */ if (errno != ENOENT) { ntfs_log_perror("%s: Attribute lookup failed", __FUNCTION__); goto put_err_out; } /* * If the base extent was skipped in the above process, * we still may have to update the sizes. */ if (!first_updated) { le16 spcomp; ntfs_attr_reinit_search_ctx(ctx); if (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { a = ctx->attr; a->allocated_size = cpu_to_sle64(na->allocated_size); spcomp = na->data_flags & (ATTR_IS_COMPRESSED | ATTR_IS_SPARSE); if (spcomp) a->compressed_size = cpu_to_sle64(na->compressed_size); /* Updating sizes taints the extent holding the attr */ if (ctx->ntfs_ino) NInoSetDirty(ctx->ntfs_ino); if ((na->type == AT_DATA) && (na->name == AT_UNNAMED)) { na->ni->allocated_size = (spcomp ? na->compressed_size : na->allocated_size); NInoFileNameSetDirty(na->ni); } } else { ntfs_log_error("Failed to update sizes in base extent\n"); goto put_err_out; } } /* Deallocate not used attribute extents and return with success. */ if (finished_build) { ntfs_attr_reinit_search_ctx(ctx); ntfs_log_trace("Deallocate marked extents.\n"); while (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (sle64_to_cpu(ctx->attr->highest_vcn) != NTFS_VCN_DELETE_MARK) continue; /* Remove unused attribute record. */ if (ntfs_attr_record_rm(ctx)) { ntfs_log_perror("Could not remove unused attr"); goto put_err_out; } ntfs_attr_reinit_search_ctx(ctx); } if (errno != ENOENT) { ntfs_log_perror("%s: Attr lookup failed", __FUNCTION__); goto put_err_out; } ntfs_log_trace("Deallocate done.\n"); ntfs_attr_put_search_ctx(ctx); goto ok; } ntfs_attr_put_search_ctx(ctx); ctx = NULL; /* Allocate new MFT records for the rest of mapping pairs. */ while (1) { /* Calculate size of rest mapping pairs. */ mp_size = ntfs_get_size_for_mapping_pairs(na->ni->vol, na->rl, stop_vcn, INT_MAX); if (mp_size <= 0) { ntfs_log_perror("%s: get mp size failed", __FUNCTION__); goto put_err_out; } /* Allocate new mft record, with special case for mft itself */ if (!na->ni->mft_no) ni = ntfs_mft_rec_alloc(na->ni->vol, na->type == AT_DATA); else ni = ntfs_mft_record_alloc(na->ni->vol, base_ni); if (!ni) { ntfs_log_perror("Could not allocate new MFT record"); goto put_err_out; } m = ni->mrec; /* * If mapping size exceed available space, set them to * possible maximum. */ cur_max_mp_size = le32_to_cpu(m->bytes_allocated) - le32_to_cpu(m->bytes_in_use) - (offsetof(ATTR_RECORD, compressed_size) + (((na->data_flags & ATTR_COMPRESSION_MASK) || NAttrSparse(na)) ? sizeof(a->compressed_size) : 0)) - ((sizeof(ntfschar) * na->name_len + 7) & ~7); if (mp_size > cur_max_mp_size) mp_size = cur_max_mp_size; /* Add attribute extent to new record. */ err = ntfs_non_resident_attr_record_add(ni, na->type, na->name, na->name_len, stop_vcn, mp_size, na->data_flags); if (err == -1) { err = errno; ntfs_log_perror("Could not add attribute extent"); if (ntfs_mft_record_free(na->ni->vol, ni)) ntfs_log_perror("Could not free MFT record"); errno = err; goto put_err_out; } a = (ATTR_RECORD*)((u8*)m + err); err = ntfs_mapping_pairs_build(na->ni->vol, (u8*)a + le16_to_cpu(a->mapping_pairs_offset), mp_size, na->rl, stop_vcn, &stop_rl); if (stop_rl) stop_vcn = stop_rl->vcn; else stop_vcn = 0; if (err < 0 && errno != ENOSPC) { err = errno; ntfs_log_perror("Failed to build MP"); if (ntfs_mft_record_free(na->ni->vol, ni)) ntfs_log_perror("Couldn't free MFT record"); errno = err; goto put_err_out; } a->highest_vcn = cpu_to_sle64(stop_vcn - 1); ntfs_inode_mark_dirty(ni); /* All mapping pairs has been written. */ if (!err) break; } ok: NAttrClearRunlistDirty(na); ret = 0; out: return ret; put_err_out: if (ctx) ntfs_attr_put_search_ctx(ctx); goto out; } #undef NTFS_VCN_DELETE_MARK /** * ntfs_attr_update_mapping_pairs - update mapping pairs for ntfs attribute * @na: non-resident ntfs open attribute for which we need update * @from_vcn: update runlist starting this VCN * * Build mapping pairs from @na->rl and write them to the disk. Also, this * function updates sparse bit, allocated and compressed size (allocates/frees * space for this field if required). * * @na->allocated_size should be set to correct value for the new runlist before * call to this function. Vice-versa @na->compressed_size will be calculated and * set to correct value during this function. * * FIXME: This function does not update sparse bit and compressed size correctly * if called with @from_vcn != 0. * * FIXME: Rewrite without using NTFS_VCN_DELETE_MARK define. * * On success return 0 and on error return -1 with errno set to the error code. * The following error codes are defined: * EINVAL - Invalid arguments passed. * ENOMEM - Not enough memory to complete operation. * ENOSPC - There is no enough space in base mft to resize $ATTRIBUTE_LIST * or there is no free MFT records left to allocate. */ int ntfs_attr_update_mapping_pairs(ntfs_attr *na, VCN from_vcn) { int ret; ntfs_log_enter("Entering\n"); ret = ntfs_attr_update_mapping_pairs_i(na, from_vcn, HOLES_OK); ntfs_log_leave("\n"); return ret; } /** * ntfs_non_resident_attr_shrink - shrink a non-resident, open ntfs attribute * @na: non-resident ntfs attribute to shrink * @newsize: new size (in bytes) to which to shrink the attribute * * Reduce the size of a non-resident, open ntfs attribute @na to @newsize bytes. * * On success return 0 and on error return -1 with errno set to the error code. * The following error codes are defined: * ENOMEM - Not enough memory to complete operation. * ERANGE - @newsize is not valid for the attribute type of @na. */ int ntfs_non_resident_attr_shrink(ntfs_attr *na, const s64 newsize) { ntfs_volume *vol; ntfs_attr_search_ctx *ctx; VCN first_free_vcn; s64 nr_freed_clusters; int err; ntfs_log_trace("Inode 0x%llx attr 0x%x new size %lld\n", (unsigned long long) na->ni->mft_no, le32_to_cpu(na->type), (long long)newsize); vol = na->ni->vol; /* * Check the attribute type and the corresponding minimum size * against @newsize and fail if @newsize is too small. */ if (ntfs_attr_size_bounds_check(vol, na->type, newsize) < 0) { if (errno == ERANGE) { ntfs_log_trace("Eeek! Size bounds check failed. " "Aborting...\n"); } else if (errno == ENOENT) errno = EIO; return -1; } /* The first cluster outside the new allocation. */ if (na->data_flags & ATTR_COMPRESSION_MASK) /* * For compressed files we must keep full compressions blocks, * but currently we do not decompress/recompress the last * block to truncate the data, so we may leave more allocated * clusters than really needed. */ first_free_vcn = (((newsize - 1) | (na->compression_block_size - 1)) + 1) >> vol->cluster_size_bits; else first_free_vcn = (newsize + vol->cluster_size - 1) >> vol->cluster_size_bits; /* * Compare the new allocation with the old one and only deallocate * clusters if there is a change. */ if ((na->allocated_size >> vol->cluster_size_bits) != first_free_vcn) { if (ntfs_attr_map_whole_runlist(na)) { ntfs_log_trace("Eeek! ntfs_attr_map_whole_runlist " "failed.\n"); return -1; } /* Deallocate all clusters starting with the first free one. */ nr_freed_clusters = ntfs_cluster_free(vol, na, first_free_vcn, -1); if (nr_freed_clusters < 0) { ntfs_log_trace("Eeek! Freeing of clusters failed. " "Aborting...\n"); return -1; } /* Truncate the runlist itself. */ if (ntfs_rl_truncate(&na->rl, first_free_vcn)) { /* * Failed to truncate the runlist, so just throw it * away, it will be mapped afresh on next use. */ free(na->rl); na->rl = NULL; ntfs_log_trace("Eeek! Run list truncation failed.\n"); return -1; } NAttrSetRunlistDirty(na); /* Prepare to mapping pairs update. */ na->allocated_size = first_free_vcn << vol->cluster_size_bits; /* Write mapping pairs for new runlist. */ if (ntfs_attr_update_mapping_pairs(na, 0 /*first_free_vcn*/)) { ntfs_log_trace("Eeek! Mapping pairs update failed. " "Leaving inconstant metadata. " "Run chkdsk.\n"); return -1; } } /* Get the first attribute record. */ ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) return -1; if (ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { err = errno; if (err == ENOENT) err = EIO; ntfs_log_trace("Eeek! Lookup of first attribute extent failed. " "Leaving inconstant metadata.\n"); goto put_err_out; } /* Update data and initialized size. */ na->data_size = newsize; ctx->attr->data_size = cpu_to_sle64(newsize); if (newsize < na->initialized_size) { na->initialized_size = newsize; ctx->attr->initialized_size = cpu_to_sle64(newsize); } /* Update data size in the index. */ if (na->ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { if (na->type == AT_INDEX_ROOT && na->name == NTFS_INDEX_I30) { na->ni->data_size = na->data_size; na->ni->allocated_size = na->allocated_size; set_nino_flag(na->ni,KnownSize); } } else { if (na->type == AT_DATA && na->name == AT_UNNAMED) { na->ni->data_size = na->data_size; NInoFileNameSetDirty(na->ni); } } /* If the attribute now has zero size, make it resident. */ if (!newsize) { if (!(na->data_flags & ATTR_IS_ENCRYPTED) && ntfs_attr_make_resident(na, ctx)) { /* If couldn't make resident, just continue. */ if (errno != EPERM) ntfs_log_error("Failed to make attribute " "resident. Leaving as is...\n"); } } /* Set the inode dirty so it is written out later. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); /* Done! */ ntfs_attr_put_search_ctx(ctx); return 0; put_err_out: ntfs_attr_put_search_ctx(ctx); errno = err; return -1; } /** * ntfs_non_resident_attr_expand - expand a non-resident, open ntfs attribute * @na: non-resident ntfs attribute to expand * @newsize: new size (in bytes) to which to expand the attribute * * Expand the size of a non-resident, open ntfs attribute @na to @newsize bytes, * by allocating new clusters. * * On success return 0 and on error return -1 with errno set to the error code. * The following error codes are defined: * ENOMEM - Not enough memory to complete operation. * ERANGE - @newsize is not valid for the attribute type of @na. * ENOSPC - There is no enough space in base mft to resize $ATTRIBUTE_LIST. */ static int ntfs_non_resident_attr_expand_i(ntfs_attr *na, const s64 newsize, hole_type holes) { LCN lcn_seek_from; VCN first_free_vcn; ntfs_volume *vol; ntfs_attr_search_ctx *ctx; runlist *rl, *rln; s64 org_alloc_size; int err; ntfs_log_trace("Inode %lld, attr 0x%x, new size %lld old size %lld\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)newsize, (long long)na->data_size); vol = na->ni->vol; /* * Check the attribute type and the corresponding maximum size * against @newsize and fail if @newsize is too big. */ if (ntfs_attr_size_bounds_check(vol, na->type, newsize) < 0) { if (errno == ENOENT) errno = EIO; ntfs_log_perror("%s: bounds check failed", __FUNCTION__); return -1; } if (na->type == AT_DATA) NAttrSetDataAppending(na); /* Save for future use. */ org_alloc_size = na->allocated_size; /* The first cluster outside the new allocation. */ first_free_vcn = (newsize + vol->cluster_size - 1) >> vol->cluster_size_bits; /* * Compare the new allocation with the old one and only allocate * clusters if there is a change. */ if ((na->allocated_size >> vol->cluster_size_bits) < first_free_vcn) { #if PARTIAL_RUNLIST_UPDATING s64 start_update; /* * Update from the last previously allocated run, * as we may have to expand an existing hole. */ start_update = na->allocated_size >> vol->cluster_size_bits; if (start_update) start_update--; if (ntfs_attr_map_partial_runlist(na, start_update)) { ntfs_log_perror("failed to map partial runlist"); return -1; } #else if (ntfs_attr_map_whole_runlist(na)) { ntfs_log_perror("ntfs_attr_map_whole_runlist failed"); return -1; } #endif /* * If we extend $DATA attribute on NTFS 3+ volume, we can add * sparse runs instead of real allocation of clusters. */ if ((na->type == AT_DATA) && (vol->major_ver >= 3) && (holes != HOLES_NO)) { rl = ntfs_malloc(0x1000); if (!rl) return -1; rl[0].vcn = (na->allocated_size >> vol->cluster_size_bits); rl[0].lcn = LCN_HOLE; rl[0].length = first_free_vcn - (na->allocated_size >> vol->cluster_size_bits); rl[1].vcn = first_free_vcn; rl[1].lcn = LCN_ENOENT; rl[1].length = 0; } else { /* * Determine first after last LCN of attribute. * We will start seek clusters from this LCN to avoid * fragmentation. If there are no valid LCNs in the * attribute let the cluster allocator choose the * starting LCN. */ lcn_seek_from = -1; if (na->rl->length) { /* Seek to the last run list element. */ for (rl = na->rl; (rl + 1)->length; rl++) ; /* * If the last LCN is a hole or similar seek * back to last valid LCN. */ while (rl->lcn < 0 && rl != na->rl) rl--; /* * Only set lcn_seek_from it the LCN is valid. */ if (rl->lcn >= 0) lcn_seek_from = rl->lcn + rl->length; } rl = ntfs_cluster_alloc(vol, na->allocated_size >> vol->cluster_size_bits, first_free_vcn - (na->allocated_size >> vol->cluster_size_bits), lcn_seek_from, DATA_ZONE); if (!rl) { ntfs_log_perror("Cluster allocation failed " "(%lld)", (long long)first_free_vcn - ((long long)na->allocated_size >> vol->cluster_size_bits)); return -1; } } /* Append new clusters to attribute runlist. */ rln = ntfs_runlists_merge(na->rl, rl); if (!rln) { /* Failed, free just allocated clusters. */ err = errno; ntfs_log_perror("Run list merge failed"); ntfs_cluster_free_from_rl(vol, rl); free(rl); errno = err; return -1; } na->rl = rln; NAttrSetRunlistDirty(na); /* Prepare to mapping pairs update. */ na->allocated_size = first_free_vcn << vol->cluster_size_bits; #if PARTIAL_RUNLIST_UPDATING /* * Write mapping pairs for new runlist, unless this is * a temporary state before appending data. * If the update is not done, we must be sure to do * it later, and to get to a clean state even on errors. */ if ((holes != HOLES_DELAY) && ntfs_attr_update_mapping_pairs_i(na, start_update, holes)) { #else /* Write mapping pairs for new runlist. */ if (ntfs_attr_update_mapping_pairs(na, 0)) { #endif err = errno; ntfs_log_perror("Mapping pairs update failed"); goto rollback; } } ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) { err = errno; if (na->allocated_size == org_alloc_size) { errno = err; return -1; } else goto rollback; } if (ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { err = errno; ntfs_log_perror("Lookup of first attribute extent failed"); if (err == ENOENT) err = EIO; if (na->allocated_size != org_alloc_size) { ntfs_attr_put_search_ctx(ctx); goto rollback; } else goto put_err_out; } /* Update data size. */ na->data_size = newsize; ctx->attr->data_size = cpu_to_sle64(newsize); /* Update data size in the index. */ if (na->ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { if (na->type == AT_INDEX_ROOT && na->name == NTFS_INDEX_I30) { na->ni->data_size = na->data_size; na->ni->allocated_size = na->allocated_size; set_nino_flag(na->ni,KnownSize); } } else { if (na->type == AT_DATA && na->name == AT_UNNAMED) { na->ni->data_size = na->data_size; NInoFileNameSetDirty(na->ni); } } /* Set the inode dirty so it is written out later. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); /* Done! */ ntfs_attr_put_search_ctx(ctx); return 0; rollback: /* Free allocated clusters. */ if (ntfs_cluster_free(vol, na, org_alloc_size >> vol->cluster_size_bits, -1) < 0) { err = EIO; ntfs_log_perror("Leaking clusters"); } /* Now, truncate the runlist itself. */ if (ntfs_rl_truncate(&na->rl, org_alloc_size >> vol->cluster_size_bits)) { /* * Failed to truncate the runlist, so just throw it away, it * will be mapped afresh on next use. */ free(na->rl); na->rl = NULL; ntfs_log_perror("Couldn't truncate runlist. Rollback failed"); } else { NAttrSetRunlistDirty(na); /* Prepare to mapping pairs update. */ na->allocated_size = org_alloc_size; /* Restore mapping pairs. */ if (ntfs_attr_update_mapping_pairs(na, 0 /*na->allocated_size >> vol->cluster_size_bits*/)) { ntfs_log_perror("Failed to restore old mapping pairs"); } } errno = err; return -1; put_err_out: ntfs_attr_put_search_ctx(ctx); errno = err; return -1; } static int ntfs_non_resident_attr_expand(ntfs_attr *na, const s64 newsize, hole_type holes) { int ret; ntfs_log_enter("Entering\n"); ret = ntfs_non_resident_attr_expand_i(na, newsize, holes); ntfs_log_leave("\n"); return ret; } /** * ntfs_attr_truncate - resize an ntfs attribute * @na: open ntfs attribute to resize * @newsize: new size (in bytes) to which to resize the attribute * @holes: how to create a hole if expanding * * Change the size of an open ntfs attribute @na to @newsize bytes. If the * attribute is made bigger and the attribute is resident the newly * "allocated" space is cleared and if the attribute is non-resident the * newly allocated space is marked as not initialised and no real allocation * on disk is performed. * * On success return 0. * On error return values are: * STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT * STATUS_ERROR - otherwise * The following error codes are defined: * EINVAL - Invalid arguments were passed to the function. * EOPNOTSUPP - The desired resize is not implemented yet. * EACCES - Encrypted attribute. */ static int ntfs_attr_truncate_i(ntfs_attr *na, const s64 newsize, hole_type holes) { int ret = STATUS_ERROR; s64 fullsize; BOOL compressed; if (!na || newsize < 0 || (na->ni->mft_no == FILE_MFT && na->type == AT_DATA)) { ntfs_log_trace("Invalid arguments passed.\n"); errno = EINVAL; return STATUS_ERROR; } ntfs_log_enter("Entering for inode %lld, attr 0x%x, size %lld\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)newsize); if (na->data_size == newsize) { ntfs_log_trace("Size is already ok\n"); ret = STATUS_OK; goto out; } /* * Encrypted attributes are not supported. We return access denied, * which is what Windows NT4 does, too. */ if ((na->data_flags & ATTR_IS_ENCRYPTED) && !na->ni->vol->efs_raw) { errno = EACCES; ntfs_log_trace("Cannot truncate encrypted attribute\n"); goto out; } /* * TODO: Implement making handling of compressed attributes. * Currently we can only expand the attribute or delete it, * and only for ATTR_IS_COMPRESSED. This is however possible * for resident attributes when there is no open fuse context * (important case : $INDEX_ROOT:$I30) */ compressed = (na->data_flags & ATTR_COMPRESSION_MASK) != const_cpu_to_le16(0); if (compressed && NAttrNonResident(na) && ((na->data_flags & ATTR_COMPRESSION_MASK) != ATTR_IS_COMPRESSED)) { errno = EOPNOTSUPP; ntfs_log_perror("Failed to truncate compressed attribute"); goto out; } if (NAttrNonResident(na)) { /* * For compressed data, the last block must be fully * allocated, and we do not know the size of compression * block until the attribute has been made non-resident. * Moreover we can only process a single compression * block at a time (from where we are about to write), * so we silently do not allocate more. * * Note : do not request upsizing of compressed files * unless being able to face the consequences ! */ if (compressed && newsize && (newsize > na->data_size)) fullsize = (na->initialized_size | (na->compression_block_size - 1)) + 1; else fullsize = newsize; if (fullsize > na->data_size) ret = ntfs_non_resident_attr_expand(na, fullsize, holes); else ret = ntfs_non_resident_attr_shrink(na, fullsize); } else ret = ntfs_resident_attr_resize_i(na, newsize, holes); out: ntfs_log_leave("Return status %d\n", ret); return ret; } /* * Resize an attribute, creating a hole if relevant */ int ntfs_attr_truncate(ntfs_attr *na, const s64 newsize) { int r; r = ntfs_attr_truncate_i(na, newsize, HOLES_OK); NAttrClearDataAppending(na); NAttrClearBeingNonResident(na); return (r); } /* * Resize an attribute, avoiding hole creation */ int ntfs_attr_truncate_solid(ntfs_attr *na, const s64 newsize) { return (ntfs_attr_truncate_i(na, newsize, HOLES_NO)); } /* * Stuff a hole in a compressed file * * An unallocated hole must be aligned on compression block size. * If needed current block and target block are stuffed with zeroes. * * Returns 0 if succeeded, * -1 if it failed (as explained in errno) */ static int stuff_hole(ntfs_attr *na, const s64 pos) { s64 size; s64 begin_size; s64 end_size; char *buf; int ret; ret = 0; /* * If the attribute is resident, the compression block size * is not defined yet and we can make no decision. * So we first try resizing to the target and if the * attribute is still resident, we're done */ if (!NAttrNonResident(na)) { ret = ntfs_resident_attr_resize(na, pos); if (!ret && !NAttrNonResident(na)) na->initialized_size = na->data_size = pos; } if (!ret && NAttrNonResident(na)) { /* does the hole span over several compression block ? */ if ((pos ^ na->initialized_size) & ~(na->compression_block_size - 1)) { begin_size = ((na->initialized_size - 1) | (na->compression_block_size - 1)) + 1 - na->initialized_size; end_size = pos & (na->compression_block_size - 1); size = (begin_size > end_size ? begin_size : end_size); } else { /* short stuffing in a single compression block */ begin_size = size = pos - na->initialized_size; end_size = 0; } if (size) buf = (char*)ntfs_malloc(size); else buf = (char*)NULL; if (buf || !size) { memset(buf,0,size); /* stuff into current block */ if (begin_size && (ntfs_attr_pwrite(na, na->initialized_size, begin_size, buf) != begin_size)) ret = -1; /* create an unstuffed hole */ if (!ret && ((na->initialized_size + end_size) < pos) && ntfs_non_resident_attr_expand(na, pos - end_size, HOLES_OK)) ret = -1; else na->initialized_size = na->data_size = pos - end_size; /* stuff into the target block */ if (!ret && end_size && (ntfs_attr_pwrite(na, na->initialized_size, end_size, buf) != end_size)) ret = -1; if (buf) free(buf); } else ret = -1; } /* make absolutely sure we have reached the target */ if (!ret && (na->initialized_size != pos)) { ntfs_log_error("Failed to stuff a compressed file" "target %lld reached %lld\n", (long long)pos, (long long)na->initialized_size); errno = EIO; ret = -1; } return (ret); } /** * ntfs_attr_readall - read the entire data from an ntfs attribute * @ni: open ntfs inode in which the ntfs attribute resides * @type: attribute type * @name: attribute name in little endian Unicode or AT_UNNAMED or NULL * @name_len: length of attribute @name in Unicode characters (if @name given) * @data_size: if non-NULL then store here the data size * * This function will read the entire content of an ntfs attribute. * If @name is AT_UNNAMED then look specifically for an unnamed attribute. * If @name is NULL then the attribute could be either named or not. * In both those cases @name_len is not used at all. * * On success a buffer is allocated with the content of the attribute * and which needs to be freed when it's not needed anymore. If the * @data_size parameter is non-NULL then the data size is set there. * * On error NULL is returned with errno set to the error code. */ void *ntfs_attr_readall(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len, s64 *data_size) { ntfs_attr *na; void *data, *ret = NULL; s64 size; ntfs_log_enter("Entering\n"); na = ntfs_attr_open(ni, type, name, name_len); if (!na) { ntfs_log_perror("ntfs_attr_open failed, inode %lld attr 0x%lx", (long long)ni->mft_no,(long)le32_to_cpu(type)); goto err_exit; } /* * Consistency check : restrict to 65536 bytes. * index bitmaps may need more, but still limited by * the number of clusters. */ if (((u64)na->data_size > 65536) && ((type != AT_BITMAP) || ((u64)na->data_size > (u64)((ni->vol->nr_clusters + 7) >> 3)))) { ntfs_log_error("Corrupt attribute 0x%lx in inode %lld\n", (long)le32_to_cpu(type),(long long)ni->mft_no); errno = EOVERFLOW; goto out; } data = ntfs_malloc(na->data_size); if (!data) goto out; size = ntfs_attr_pread(na, 0, na->data_size, data); if (size != na->data_size) { ntfs_log_perror("ntfs_attr_pread failed"); free(data); goto out; } ret = data; if (data_size) *data_size = size; out: ntfs_attr_close(na); err_exit: ntfs_log_leave("\n"); return ret; } /* * Read some data from a data attribute * * Returns the amount of data read, negative if there was an error */ int ntfs_attr_data_read(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, char *buf, size_t size, off_t offset) { ntfs_attr *na = NULL; int res, total = 0; na = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_len); if (!na) { res = -errno; goto exit; } if ((size_t)offset < (size_t)na->data_size) { if (offset + size > (size_t)na->data_size) size = na->data_size - offset; while (size) { res = ntfs_attr_pread(na, offset, size, buf + total); if ((off_t)res < (off_t)size) ntfs_log_perror("ntfs_attr_pread partial read " "(%lld : %lld <> %d)", (long long)offset, (long long)size, res); if (res <= 0) { res = -errno; goto exit; } size -= res; offset += res; total += res; } } res = total; exit: if (na) ntfs_attr_close(na); return res; } /* * Write some data into a data attribute * * Returns the amount of data written, negative if there was an error */ int ntfs_attr_data_write(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, const char *buf, size_t size, off_t offset) { ntfs_attr *na = NULL; int res, total = 0; na = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_len); if (!na) { res = -errno; goto exit; } while (size) { res = ntfs_attr_pwrite(na, offset, size, buf + total); if (res < (s64)size) ntfs_log_perror("ntfs_attr_pwrite partial write (%lld: " "%lld <> %d)", (long long)offset, (long long)size, res); if (res <= 0) { res = -errno; goto exit; } size -= res; offset += res; total += res; } res = total; exit: if (na) ntfs_attr_close(na); return res; } /* * Shrink the size of a data attribute if needed * * For non-resident attributes only. * The space remains allocated. * * Returns 0 if successful * -1 if failed, with errno telling why */ int ntfs_attr_shrink_size(ntfs_inode *ni, ntfschar *stream_name, int stream_name_len, off_t offset) { ntfs_attr_search_ctx *ctx; ATTR_RECORD *a; int res; res = -1; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (ctx) { if (!ntfs_attr_lookup(AT_DATA, stream_name, stream_name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { a = ctx->attr; if (a->non_resident && (sle64_to_cpu(a->initialized_size) > offset)) { a->initialized_size = cpu_to_sle64(offset); a->data_size = a->initialized_size; } res = 0; } ntfs_attr_put_search_ctx(ctx); } return (res); } int ntfs_attr_exist(ntfs_inode *ni, const ATTR_TYPES type, const ntfschar *name, u32 name_len) { ntfs_attr_search_ctx *ctx; int ret; ntfs_log_trace("Entering\n"); ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return 0; ret = ntfs_attr_lookup(type, name, name_len, CASE_SENSITIVE, 0, NULL, 0, ctx); ntfs_attr_put_search_ctx(ctx); return !ret; } int ntfs_attr_remove(ntfs_inode *ni, const ATTR_TYPES type, ntfschar *name, u32 name_len) { ntfs_attr *na; int ret; ntfs_log_trace("Entering\n"); if (!ni) { ntfs_log_error("%s: NULL inode pointer", __FUNCTION__); errno = EINVAL; return -1; } na = ntfs_attr_open(ni, type, name, name_len); if (!na) { /* do not log removal of non-existent stream */ if (type != AT_DATA) { ntfs_log_perror("Failed to open attribute 0x%02x of inode " "0x%llx", le32_to_cpu(type), (unsigned long long)ni->mft_no); } return -1; } ret = ntfs_attr_rm(na); if (ret) ntfs_log_perror("Failed to remove attribute 0x%02x of inode " "0x%llx", le32_to_cpu(type), (unsigned long long)ni->mft_no); ntfs_attr_close(na); return ret; } /* Below macros are 32-bit ready. */ #define BCX(x) ((x) - (((x) >> 1) & 0x77777777) - \ (((x) >> 2) & 0x33333333) - \ (((x) >> 3) & 0x11111111)) #define BITCOUNT(x) (((BCX(x) + (BCX(x) >> 4)) & 0x0F0F0F0F) % 255) static u8 *ntfs_init_lut256(void) { int i; u8 *lut; lut = ntfs_malloc(256); if (lut) for(i = 0; i < 256; i++) *(lut + i) = 8 - BITCOUNT(i); return lut; } s64 ntfs_attr_get_free_bits(ntfs_attr *na) { u8 *buf, *lut; s64 br = 0; s64 total = 0; s64 nr_free = 0; lut = ntfs_init_lut256(); if (!lut) return -1; buf = ntfs_malloc(65536); if (!buf) goto out; while (1) { u32 *p; br = ntfs_attr_pread(na, total, 65536, buf); if (br <= 0) break; total += br; p = (u32 *)buf + br / 4 - 1; for (; (u8 *)p >= buf; p--) { nr_free += lut[ *p & 255] + lut[(*p >> 8) & 255] + lut[(*p >> 16) & 255] + lut[(*p >> 24) ]; } switch (br % 4) { case 3: nr_free += lut[*(buf + br - 3)]; /* FALLTHRU */ case 2: nr_free += lut[*(buf + br - 2)]; /* FALLTHRU */ case 1: nr_free += lut[*(buf + br - 1)]; } } free(buf); out: free(lut); if (!total || br < 0) return -1; return nr_free; } ntfsprogs-plus-1.0.0/libntfs/attrlist.c000066400000000000000000000214421507404161300201750ustar00rootroot00000000000000/** * attrlist.c - Attribute list attribute handling code. Originated from the Linux-NTFS * project. * * Copyright (c) 2004-2005 Anton Altaparmakov * Copyright (c) 2004-2005 Yura Pakhuchiy * Copyright (c) 2006 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "types.h" #include "layout.h" #include "attrib.h" #include "attrlist.h" #include "debug.h" #include "unistr.h" #include "logging.h" #include "misc.h" /** * ntfs_attrlist_need - check whether inode need attribute list * @ni: opened ntfs inode for which perform check * * Check whether all are attributes belong to one MFT record, in that case * attribute list is not needed. * * Return 1 if inode need attribute list, 0 if not, -1 on error with errno set * to the error code. If function succeed errno set to 0. The following error * codes are defined: * EINVAL - Invalid arguments passed to function or attribute haven't got * attribute list. */ int ntfs_attrlist_need(ntfs_inode *ni) { ATTR_LIST_ENTRY *ale; if (!ni) { ntfs_log_trace("Invalid arguments.\n"); errno = EINVAL; return -1; } ntfs_log_trace("Entering for inode 0x%llx.\n", (long long) ni->mft_no); if (!NInoAttrList(ni)) { ntfs_log_trace("Inode haven't got attribute list.\n"); errno = EINVAL; return -1; } if (!ni->attr_list) { ntfs_log_trace("Corrupt in-memory struct.\n"); errno = EINVAL; return -1; } errno = 0; ale = (ATTR_LIST_ENTRY *)ni->attr_list; while ((u8*)ale < ni->attr_list + ni->attr_list_size) { if (MREF_LE(ale->mft_reference) != ni->mft_no) return 1; ale = (ATTR_LIST_ENTRY *)((u8*)ale + le16_to_cpu(ale->length)); } return 0; } /** * ntfs_attrlist_entry_add - add an attribute list attribute entry * @ni: opened ntfs inode, which contains that attribute * @attr: attribute record to add to attribute list * * Return 0 on success and -1 on error with errno set to the error code. The * following error codes are defined: * EINVAL - Invalid arguments passed to function. * ENOMEM - Not enough memory to allocate necessary buffers. * EIO - I/O error occurred or damaged filesystem. * EEXIST - Such attribute already present in attribute list. */ int ntfs_attrlist_entry_add(ntfs_inode *ni, ATTR_RECORD *attr) { ATTR_LIST_ENTRY *ale; leMFT_REF mref; ntfs_attr *na = NULL; ntfs_attr_search_ctx *ctx; u8 *new_al; int entry_len, entry_offset, err; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x.\n", (long long) ni->mft_no, (unsigned) le32_to_cpu(attr->type)); if (!ni || !attr) { ntfs_log_trace("Invalid arguments.\n"); errno = EINVAL; return -1; } mref = MK_LE_MREF(ni->mft_no, le16_to_cpu(ni->mrec->sequence_number)); if (ni->nr_extents == -1) ni = ni->base_ni; if (!NInoAttrList(ni)) { ntfs_log_trace("Attribute list isn't present.\n"); errno = ENOENT; return -1; } /* Determine size and allocate memory for new attribute list. */ entry_len = (sizeof(ATTR_LIST_ENTRY) + sizeof(ntfschar) * attr->name_length + 7) & ~7; new_al = ntfs_calloc(ni->attr_list_size + entry_len); if (!new_al) return -1; /* Find place for the new entry. */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) { err = errno; goto err_out; } if (!ntfs_attr_lookup(attr->type, (attr->name_length) ? (ntfschar*) ((u8*)attr + le16_to_cpu(attr->name_offset)) : AT_UNNAMED, attr->name_length, CASE_SENSITIVE, (attr->non_resident) ? sle64_to_cpu(attr->lowest_vcn) : 0, (attr->non_resident) ? NULL : ((u8*)attr + le16_to_cpu(attr->value_offset)), (attr->non_resident) ? 0 : le32_to_cpu(attr->value_length), ctx)) { /* Found some extent, check it to be before new extent. */ if (ctx->al_entry->lowest_vcn == attr->lowest_vcn) { err = EEXIST; ntfs_log_trace("Such attribute already present in the " "attribute list.\n"); ntfs_attr_put_search_ctx(ctx); goto err_out; } /* Add new entry after this extent. */ ale = (ATTR_LIST_ENTRY*)((u8*)ctx->al_entry + le16_to_cpu(ctx->al_entry->length)); } else { /* Check for real errors. */ if (errno != ENOENT) { err = errno; ntfs_log_trace("Attribute lookup failed.\n"); ntfs_attr_put_search_ctx(ctx); goto err_out; } /* No previous extents found. */ ale = ctx->al_entry; } /* Don't need it anymore, @ctx->al_entry points to @ni->attr_list. */ ntfs_attr_put_search_ctx(ctx); /* Determine new entry offset. */ entry_offset = ((u8 *)ale - ni->attr_list); /* Set pointer to new entry. */ ale = (ATTR_LIST_ENTRY *)(new_al + entry_offset); /* Zero it to fix valgrind warning. */ memset(ale, 0, entry_len); /* Form new entry. */ ale->type = attr->type; ale->length = cpu_to_le16(entry_len); ale->name_length = attr->name_length; ale->name_offset = offsetof(ATTR_LIST_ENTRY, name); if (attr->non_resident) ale->lowest_vcn = attr->lowest_vcn; else ale->lowest_vcn = const_cpu_to_sle64(0); ale->mft_reference = mref; ale->instance = attr->instance; memcpy(ale->name, (u8 *)attr + le16_to_cpu(attr->name_offset), attr->name_length * sizeof(ntfschar)); /* Resize $ATTRIBUTE_LIST to new length. */ na = ntfs_attr_open(ni, AT_ATTRIBUTE_LIST, AT_UNNAMED, 0); if (!na) { err = errno; ntfs_log_trace("Failed to open $ATTRIBUTE_LIST attribute.\n"); goto err_out; } if (ntfs_attr_truncate(na, ni->attr_list_size + entry_len)) { err = errno; ntfs_log_trace("$ATTRIBUTE_LIST resize failed.\n"); goto err_out; } /* Copy entries from old attribute list to new. */ memcpy(new_al, ni->attr_list, entry_offset); memcpy(new_al + entry_offset + entry_len, ni->attr_list + entry_offset, ni->attr_list_size - entry_offset); /* Set new runlist. */ free(ni->attr_list); ni->attr_list = new_al; ni->attr_list_size = ni->attr_list_size + entry_len; NInoAttrListSetDirty(ni); /* Done! */ ntfs_attr_close(na); return 0; err_out: if (na) ntfs_attr_close(na); free(new_al); errno = err; return -1; } /** * ntfs_attrlist_entry_rm - remove an attribute list attribute entry * @ctx: attribute search context describing the attribute list entry * * Remove the attribute list entry @ctx->al_entry from the attribute list. * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_attrlist_entry_rm(ntfs_attr_search_ctx *ctx) { u8 *new_al; int new_al_len; ntfs_inode *base_ni; ntfs_attr *na; ATTR_LIST_ENTRY *ale; int err; if (!ctx || !ctx->ntfs_ino || !ctx->al_entry) { ntfs_log_trace("Invalid arguments.\n"); errno = EINVAL; return -1; } if (ctx->base_ntfs_ino) base_ni = ctx->base_ntfs_ino; else base_ni = ctx->ntfs_ino; ale = ctx->al_entry; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, lowest_vcn %lld.\n", (long long) ctx->ntfs_ino->mft_no, (unsigned) le32_to_cpu(ctx->al_entry->type), (long long) sle64_to_cpu(ctx->al_entry->lowest_vcn)); if (!NInoAttrList(base_ni)) { ntfs_log_trace("Attribute list isn't present.\n"); errno = ENOENT; return -1; } /* Allocate memory for new attribute list. */ new_al_len = base_ni->attr_list_size - le16_to_cpu(ale->length); new_al = ntfs_calloc(new_al_len); if (!new_al) return -1; /* Reisze $ATTRIBUTE_LIST to new length. */ na = ntfs_attr_open(base_ni, AT_ATTRIBUTE_LIST, AT_UNNAMED, 0); if (!na) { err = errno; ntfs_log_trace("Failed to open $ATTRIBUTE_LIST attribute.\n"); goto err_out; } if (ntfs_attr_truncate(na, new_al_len)) { err = errno; ntfs_log_trace("$ATTRIBUTE_LIST resize failed.\n"); goto err_out; } /* Copy entries from old attribute list to new. */ memcpy(new_al, base_ni->attr_list, (u8*)ale - base_ni->attr_list); memcpy(new_al + ((u8*)ale - base_ni->attr_list), (u8*)ale + le16_to_cpu( ale->length), new_al_len - ((u8*)ale - base_ni->attr_list)); /* Set new runlist. */ free(base_ni->attr_list); base_ni->attr_list = new_al; base_ni->attr_list_size = new_al_len; NInoAttrListSetDirty(base_ni); /* Done! */ ntfs_attr_close(na); return 0; err_out: if (na) ntfs_attr_close(na); free(new_al); errno = err; return -1; } ntfsprogs-plus-1.0.0/libntfs/bitmap.c000066400000000000000000000265611507404161300176120ustar00rootroot00000000000000/** * bitmap.c - Bitmap handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2006 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2004-2008 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "types.h" #include "attrib.h" #include "bitmap.h" #include "debug.h" #include "logging.h" #include "misc.h" /* GENMASK macro from linux code */ #define GENMASK(h, l) \ (((~(0UL)) - ((1UL) << (l)) + 1) & \ (~(0UL) >> (BITS_PER_LONG - 1 - (h)))) #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) & (BITS_PER_LONG - 1))) #define BITMAP_LAST_WORD_MASK(nbits) (~0UL >> (-(nbits) & (BITS_PER_LONG - 1))) /** * ntfs_bit_set - set a bit in a field of bits * @bitmap: field of bits * @bit: bit to set * @new_value: value to set bit to (0 or 1) * * Set the bit @bit in the @bitmap to @new_value. Ignore all errors. */ void ntfs_bit_set(u8 *bitmap, const u64 bit, const u8 new_value) { if (!bitmap || new_value > 1) return; if (!new_value) bitmap[bit >> 3] &= ~(1 << (bit & 7)); else bitmap[bit >> 3] |= (1 << (bit & 7)); } /** * ntfs_bit_get - get value of a bit in a field of bits * @bitmap: field of bits * @bit: bit to get * * Get and return the value of the bit @bit in @bitmap (0 or 1). * Return -1 on error. */ char ntfs_bit_get(const u8 *bitmap, const u64 bit) { if (!bitmap) return -1; return (bitmap[bit >> 3] >> (bit & 7)) & 1; } /** * ntfs_bit_get_and_set - get value of a bit in a field of bits and set it * @bitmap: field of bits * @bit: bit to get/set * @new_value: value to set bit to (0 or 1) * * Return the value of the bit @bit and set it to @new_value (0 or 1). * Return -1 on error. */ char ntfs_bit_get_and_set(u8 *bitmap, const u64 bit, const u8 new_value) { register u8 old_bit, shift; if (!bitmap || new_value > 1) return -1; shift = bit & 7; old_bit = (bitmap[bit >> 3] >> shift) & 1; if (new_value != old_bit) bitmap[bit >> 3] ^= 1 << shift; return old_bit; } /** * ntfs_bitmap_set_bits_in_run - set a run of bits in a bitmap to a value * @na: attribute containing the bitmap * @start_bit: first bit to set * @count: number of bits to set * @value: value to set the bits to (i.e. 0 or 1) * * Set @count bits starting at bit @start_bit in the bitmap described by the * attribute @na to @value, where @value is either 0 or 1. * * On success return 0 and on error return -1 with errno set to the error code. */ static int ntfs_bitmap_set_bits_in_run(ntfs_attr *na, s64 start_bit, s64 count, int value) { s64 bufsize, br, tmp; u8 *buf, *lastbyte_buf; int bit, firstbyte, lastbyte, lastbyte_pos, ret = -1; if (!na || start_bit < 0 || count < 0) { errno = EINVAL; ntfs_log_perror("%s: Invalid argument (%p, %lld, %lld)", __FUNCTION__, na, (long long)start_bit, (long long)count); return -1; } bit = start_bit & 7; if (bit) firstbyte = 1; else firstbyte = 0; /* Calculate the required buffer size in bytes, capping it at 8kiB. */ bufsize = ((count - (bit ? 8 - bit : 0) + 7) >> 3) + firstbyte; if (bufsize > 8192) bufsize = 8192; buf = ntfs_malloc(bufsize); if (!buf) return -1; /* Depending on @value, zero or set all bits in the allocated buffer. */ memset(buf, value ? 0xff : 0, bufsize); /* If there is a first partial byte... */ if (bit) { /* read it in... */ br = ntfs_attr_pread(na, start_bit >> 3, 1, buf); if (br != 1) { if (br >= 0) errno = EIO; goto free_err_out; } /* and set or clear the appropriate bits in it. */ while ((bit & 7) && count--) { if (value) *buf |= 1 << bit++; else *buf &= ~(1 << bit++); } /* Update @start_bit to the new position. */ start_bit = (start_bit + 7) & ~7; } /* Loop until @count reaches zero. */ lastbyte = 0; lastbyte_buf = NULL; bit = count & 7; do { /* If there is a last partial byte... */ if (count > 0 && bit) { lastbyte_pos = ((count + 7) >> 3) + firstbyte; if (!lastbyte_pos) { // FIXME: Eeek! BUG! ntfs_log_error("Lastbyte is zero. Leaving " "inconsistent metadata.\n"); errno = EIO; goto free_err_out; } /* and it is in the currently loaded bitmap window... */ if (lastbyte_pos <= bufsize) { lastbyte_buf = buf + lastbyte_pos - 1; /* read the byte in... */ br = ntfs_attr_pread(na, (start_bit + count) >> 3, 1, lastbyte_buf); if (br != 1) { // FIXME: Eeek! We need rollback! (AIA) if (br >= 0) errno = EIO; ntfs_log_perror("Reading of last byte " "failed (%lld). Leaving inconsistent " "metadata", (long long)br); goto free_err_out; } /* and set/clear the appropriate bits in it. */ while (bit && count--) { if (value) *lastbyte_buf |= 1 << --bit; else *lastbyte_buf &= ~(1 << --bit); } /* We don't want to come back here... */ bit = 0; /* We have a last byte that we have handled. */ lastbyte = 1; } } /* Write the prepared buffer to disk. */ tmp = (start_bit >> 3) - firstbyte; br = ntfs_attr_pwrite(na, tmp, bufsize, buf); if (br != bufsize) { // FIXME: Eeek! We need rollback! (AIA) if (br >= 0) errno = EIO; ntfs_log_perror("Failed to write buffer to bitmap " "(%lld != %lld). Leaving inconsistent metadata", (long long)br, (long long)bufsize); goto free_err_out; } /* Update counters. */ tmp = (bufsize - firstbyte - lastbyte) << 3; if (firstbyte) { firstbyte = 0; /* * Re-set the partial first byte so a subsequent write * of the buffer does not have stale, incorrect bits. */ *buf = value ? 0xff : 0; } start_bit += tmp; count -= tmp; if (bufsize > (tmp = (count + 7) >> 3)) bufsize = tmp; if (lastbyte && count != 0) { // FIXME: Eeek! BUG! ntfs_log_error("Last buffer but count is not zero " "(%lld). Leaving inconsistent metadata.\n", (long long)count); errno = EIO; goto free_err_out; } } while (count > 0); ret = 0; free_err_out: free(buf); return ret; } /** * ntfs_bitmap_set_run - set a run of bits in a bitmap * @na: attribute containing the bitmap * @start_bit: first bit to set * @count: number of bits to set * * Set @count bits starting at bit @start_bit in the bitmap described by the * attribute @na. * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_bitmap_set_run(ntfs_attr *na, s64 start_bit, s64 count) { int ret; ntfs_log_enter("Set from bit %lld, count %lld\n", (long long)start_bit, (long long)count); ret = ntfs_bitmap_set_bits_in_run(na, start_bit, count, 1); ntfs_log_leave("\n"); return ret; } /** * ntfs_bitmap_clear_run - clear a run of bits in a bitmap * @na: attribute containing the bitmap * @start_bit: first bit to clear * @count: number of bits to clear * * Clear @count bits starting at bit @start_bit in the bitmap described by the * attribute @na. * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_bitmap_clear_run(ntfs_attr *na, s64 start_bit, s64 count) { int ret; ntfs_log_enter("Clear from bit %lld, count %lld\n", (long long)start_bit, (long long)count); ret = ntfs_bitmap_set_bits_in_run(na, start_bit, count, 0); ntfs_log_leave("\n"); return ret; } #define ffzl(x) ffsl(~(x)) /* codes from linux, find_bit.c and find.h */ static unsigned long _find_first_bit(const unsigned long *addr, unsigned long size) { unsigned long idx; for (idx = 0; idx * BITS_PER_LONG < size; idx++) { if (addr[idx]) return idx * BITS_PER_LONG + ffsl(addr[idx]) - 1; } return size; } /** * ntfs_find_first_bit() find first set bit in addr with 'size' * addr : address to find set bit * size : size of address to find set bit * * return 0 ~ ('size' - 1) for set bit, and return 'size' * if 'addr' has no set bit within 'size'. */ unsigned long ntfs_find_first_bit(const unsigned long *addr, unsigned long size) { if (size > 0 && size <= BITS_PER_LONG) { unsigned long val = *addr & GENMASK(size - 1, 0); return val ? (ffsl(val) - 1) : size; } return _find_first_bit(addr, size); } static unsigned long _find_next_bit(const unsigned long *addr, unsigned long nbits, unsigned long start, unsigned long invert) { unsigned long tmp, mask; if (start >= nbits) return nbits; tmp = addr[start / BITS_PER_LONG]; tmp ^= invert; /* Handle 1st word */ mask = BITMAP_FIRST_WORD_MASK(start); tmp &= mask; start = round_down(start, BITS_PER_LONG); while (!tmp) { start += BITS_PER_LONG; if (start >= nbits) return nbits; tmp = addr[start / BITS_PER_LONG]; tmp ^= invert; } return tmp ? (start + ffsl(tmp) - 1) : nbits; } /** * */ unsigned long ntfs_find_next_bit(const unsigned long *addr, unsigned long size, unsigned long offset) { if (size > 0 && size <= BITS_PER_LONG) { unsigned long val; if (offset >= size) return size; val = *addr & GENMASK(size - 1, offset); return val ? ffsl(val) - 1 : size; } return _find_next_bit(addr, size, offset, 0UL); } /* * Find the first cleared bit in a memory region. */ unsigned long _find_first_zero_bit(const unsigned long *addr, unsigned long size) { unsigned long idx; for (idx = 0; idx * BITS_PER_LONG < size; idx++) { if (addr[idx] != ~0UL) return idx * BITS_PER_LONG + ffzl(addr[idx]) - 1; } return size; } /** * find_first_zero_bit - find the first cleared bit in a memory region * @addr: The address to start the search at * @size: The maximum number of bits to search * * Returns the bit number of the first cleared bit. * If no bits are zero, returns @size. */ static inline unsigned long ntfs_find_first_zero_bit(const unsigned long *addr, unsigned long size) { if (size > 0 && size <= BITS_PER_LONG) { unsigned long val = *addr | ~GENMASK(size - 1, 0); return val == ~0UL ? size : ffzl(val) - 1; } return _find_first_zero_bit(addr, size); } /** * find_next_zero_bit - find the next cleared bit in a memory region * @addr: The address to base the search on * @offset: The bitnumber to start searching at * @size: The bitmap size in bits * * Returns the bit number of the next zero bit * If no bits are zero, returns @size. */ static inline unsigned long ntfs_find_next_zero_bit(const unsigned long *addr, unsigned long size, unsigned long offset) { if (size > 0 && size <= BITS_PER_LONG) { unsigned long val; if (offset >= size) return size; val = *addr | ~GENMASK(size - 1, offset); return val == ~0UL ? size : ffzl(val) - 1; } return _find_next_bit(addr, size, offset, ~0UL); } ntfsprogs-plus-1.0.0/libntfs/bootsect.c000066400000000000000000000253031507404161300201510ustar00rootroot00000000000000/** * bootsect.c - Boot sector handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2006 Anton Altaparmakov * Copyright (c) 2003-2008 Szabolcs Szakacsits * Copyright (c) 2005 Yura Pakhuchiy * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "param.h" #include "compat.h" #include "bootsect.h" #include "debug.h" #include "logging.h" /** * ntfs_boot_sector_is_ntfs - check if buffer contains a valid ntfs boot sector * @b: buffer containing putative boot sector to analyze * @silent: if zero, output progress messages to stderr * * Check if the buffer @b contains a valid ntfs boot sector. The buffer @b * must be at least 512 bytes in size. * * If @silent is zero, output progress messages to stderr. Otherwise, do not * output any messages (except when configured with --enable-debug in which * case warning/debug messages may be displayed). * * Return TRUE if @b contains a valid ntfs boot sector and FALSE if not. */ BOOL ntfs_boot_sector_is_ntfs(NTFS_BOOT_SECTOR *b) { u32 i; BOOL ret = FALSE; u16 sectors_per_cluster; ntfs_log_debug("Beginning bootsector check.\n"); ntfs_log_debug("Checking OEMid, NTFS signature.\n"); if (b->oem_id != const_cpu_to_le64(0x202020205346544eULL)) { /* "NTFS " */ ntfs_log_error("NTFS signature is missing.\n"); goto not_ntfs; } ntfs_log_debug("Checking bytes per sector.\n"); if (le16_to_cpu(b->bpb.bytes_per_sector) < 256 || le16_to_cpu(b->bpb.bytes_per_sector) > 4096) { ntfs_log_error("Unexpected bytes per sector value (%d).\n", le16_to_cpu(b->bpb.bytes_per_sector)); goto not_ntfs; } ntfs_log_debug("Checking sectors per cluster.\n"); switch (b->bpb.sectors_per_cluster) { case 1: case 2: case 4: case 8: case 16: case 32: case 64: case 128: break; default: if ((b->bpb.sectors_per_cluster < 240) || (b->bpb.sectors_per_cluster > 253)) { if (b->bpb.sectors_per_cluster > 128) ntfs_log_error("Unexpected sectors" " per cluster value (code 0x%x)\n", b->bpb.sectors_per_cluster); else ntfs_log_error("Unexpected sectors" " per cluster value (%d).\n", b->bpb.sectors_per_cluster); goto not_ntfs; } } ntfs_log_debug("Checking cluster size.\n"); if (b->bpb.sectors_per_cluster > 128) sectors_per_cluster = 1 << (256 - b->bpb.sectors_per_cluster); else sectors_per_cluster = b->bpb.sectors_per_cluster; i = (u32)le16_to_cpu(b->bpb.bytes_per_sector) * sectors_per_cluster; if (i == 0 || i > NTFS_MAX_CLUSTER_SIZE) { ntfs_log_error("Unexpected cluster size (%d).\n", i); goto not_ntfs; } ntfs_log_debug("Checking reserved fields are zero.\n"); if (le16_to_cpu(b->bpb.reserved_sectors) || le16_to_cpu(b->bpb.root_entries) || le16_to_cpu(b->bpb.sectors) || le16_to_cpu(b->bpb.sectors_per_fat) || le32_to_cpu(b->bpb.large_sectors) || b->bpb.fats) { ntfs_log_error("Reserved fields aren't zero " "(%d, %d, %d, %d, %d, %d).\n", le16_to_cpu(b->bpb.reserved_sectors), le16_to_cpu(b->bpb.root_entries), le16_to_cpu(b->bpb.sectors), le16_to_cpu(b->bpb.sectors_per_fat), le32_to_cpu(b->bpb.large_sectors), b->bpb.fats); goto not_ntfs; } ntfs_log_debug("Checking clusters per mft record.\n"); if ((u8)b->clusters_per_mft_record < 0xe1 || (u8)b->clusters_per_mft_record > 0xf7) { switch (b->clusters_per_mft_record) { case 1: case 2: case 4: case 8: case 0x10: case 0x20: case 0x40: break; default: ntfs_log_error("Unexpected clusters per mft record " "(%d).\n", b->clusters_per_mft_record); goto not_ntfs; } } ntfs_log_debug("Checking clusters per index block.\n"); if ((u8)b->clusters_per_index_record < 0xe1 || (u8)b->clusters_per_index_record > 0xf7) { switch (b->clusters_per_index_record) { case 1: case 2: case 4: case 8: case 0x10: case 0x20: case 0x40: break; default: ntfs_log_error("Unexpected clusters per index record " "(%d).\n", b->clusters_per_index_record); goto not_ntfs; } } /* MFT and MFTMirr may not overlap the boot sector or be the same */ if (((s64)sle64_to_cpu(b->mft_lcn) <= 0) || ((s64)sle64_to_cpu(b->mftmirr_lcn) <= 0) || (b->mft_lcn == b->mftmirr_lcn)) { ntfs_log_error("Invalid location of MFT or MFTMirr.\n"); goto not_ntfs; } if (b->end_of_sector_marker != const_cpu_to_le16(0xaa55)) ntfs_log_debug("Warning: Bootsector has invalid end of sector " "marker.\n"); ntfs_log_debug("Bootsector check completed successfully.\n"); ret = TRUE; not_ntfs: return ret; } static const char *last_sector_error = "HINTS: Either the volume is a RAID/LDM but it wasn't setup yet,\n" " or it was not setup correctly (e.g. by not using mdadm --build ...),\n" " or a wrong device is tried to be mounted,\n" " or the partition table is corrupt (partition is smaller than NTFS),\n" " or the NTFS boot sector is corrupt (NTFS size is not valid).\n"; /** * ntfs_boot_sector_parse - setup an ntfs volume from an ntfs boot sector * @vol: ntfs_volume to setup * @bs: buffer containing ntfs boot sector to parse * * Parse the ntfs bootsector @bs and setup the ntfs volume @vol with the * obtained values. * * Return 0 on success or -1 on error with errno set to the error code EINVAL. */ int ntfs_boot_sector_parse(ntfs_volume *vol, const NTFS_BOOT_SECTOR *bs) { s64 sectors; u16 sectors_per_cluster; s8 c; /* We return -1 with errno = EINVAL on error. */ errno = EINVAL; vol->sector_size = le16_to_cpu(bs->bpb.bytes_per_sector); vol->sector_size_bits = ffs(vol->sector_size) - 1; ntfs_log_debug("SectorSize = 0x%x\n", vol->sector_size); ntfs_log_debug("SectorSizeBits = %u\n", vol->sector_size_bits); /* * The bounds checks on mft_lcn and mft_mirr_lcn (i.e. them being * below or equal the number_of_clusters) really belong in the * ntfs_boot_sector_is_ntfs but in this way we can just do this once. */ if (bs->bpb.sectors_per_cluster > 128) sectors_per_cluster = 1 << (256 - bs->bpb.sectors_per_cluster); else sectors_per_cluster = bs->bpb.sectors_per_cluster; ntfs_log_debug("SectorsPerCluster = 0x%x\n", sectors_per_cluster); if (sectors_per_cluster & (sectors_per_cluster - 1)) { ntfs_log_error("sectors_per_cluster (%d) is not a power of 2." "\n", sectors_per_cluster); return -1; } sectors = sle64_to_cpu(bs->number_of_sectors); ntfs_log_debug("NumberOfSectors = %lld\n", (long long)sectors); if (!sectors) { ntfs_log_error("Volume size is set to zero.\n"); return -1; } if (vol->dev->d_ops->seek(vol->dev, (sectors - 1) << vol->sector_size_bits, SEEK_SET) == -1) { ntfs_log_perror("Failed to read last sector (%lld)", (long long)(sectors - 1)); ntfs_log_error("%s", last_sector_error); return -1; } vol->nr_clusters = sectors >> (ffs(sectors_per_cluster) - 1); vol->nr_sectors = sectors; vol->mft_lcn = sle64_to_cpu(bs->mft_lcn); vol->mftmirr_lcn = sle64_to_cpu(bs->mftmirr_lcn); ntfs_log_debug("MFT LCN = %lld\n", (long long)vol->mft_lcn); ntfs_log_debug("MFTMirr LCN = %lld\n", (long long)vol->mftmirr_lcn); if ((vol->mft_lcn < 0 || vol->mft_lcn > vol->nr_clusters) || (vol->mftmirr_lcn < 0 || vol->mftmirr_lcn > vol->nr_clusters)) { ntfs_log_error("$MFT LCN (%lld) or $MFTMirr LCN (%lld) is " "greater than the number of clusters (%lld).\n", (long long)vol->mft_lcn, (long long)vol->mftmirr_lcn, (long long)vol->nr_clusters); return -1; } vol->cluster_size = sectors_per_cluster * vol->sector_size; if (vol->cluster_size & (vol->cluster_size - 1)) { ntfs_log_error("cluster_size (%d) is not a power of 2.\n", vol->cluster_size); return -1; } vol->cluster_size_bits = ffs(vol->cluster_size) - 1; /* * Need to get the clusters per mft record and handle it if it is * negative. Then calculate the mft_record_size. A value of 0x80 is * illegal, thus signed char is actually ok! */ c = bs->clusters_per_mft_record; ntfs_log_debug("ClusterSize = 0x%x\n", (unsigned)vol->cluster_size); ntfs_log_debug("ClusterSizeBits = %u\n", vol->cluster_size_bits); ntfs_log_debug("ClustersPerMftRecord = 0x%x\n", c); /* * When clusters_per_mft_record is negative, it means that it is to * be taken to be the negative base 2 logarithm of the mft_record_size * min bytes. Then: * mft_record_size = 2^(-clusters_per_mft_record) bytes. */ if (c < 0) vol->mft_record_size = 1 << -c; else vol->mft_record_size = c << vol->cluster_size_bits; if (!vol->mft_record_size || vol->mft_record_size & (vol->mft_record_size - 1)) { ntfs_log_error("mft_record_size (%d) is not a power of 2.\n", vol->mft_record_size); return -1; } vol->mft_record_size_bits = ffs(vol->mft_record_size) - 1; ntfs_log_debug("MftRecordSize = 0x%x\n", (unsigned)vol->mft_record_size); ntfs_log_debug("MftRecordSizeBits = %u\n", vol->mft_record_size_bits); /* Same as above for INDX record. */ c = bs->clusters_per_index_record; ntfs_log_debug("ClustersPerINDXRecord = 0x%x\n", c); if (c < 0) vol->indx_record_size = 1 << -c; else vol->indx_record_size = c << vol->cluster_size_bits; vol->indx_record_size_bits = ffs(vol->indx_record_size) - 1; ntfs_log_debug("INDXRecordSize = 0x%x\n", (unsigned)vol->indx_record_size); ntfs_log_debug("INDXRecordSizeBits = %u\n", vol->indx_record_size_bits); /* * Work out the size of the MFT mirror in number of mft records. If the * cluster size is less than or equal to the size taken by four mft * records, the mft mirror stores the first four mft records. If the * cluster size is bigger than the size taken by four mft records, the * mft mirror contains as many mft records as will fit into one * cluster. */ if (vol->cluster_size <= 4 * vol->mft_record_size) vol->mftmirr_size = 4; else vol->mftmirr_size = vol->cluster_size >> vol->mft_record_size_bits; return 0; } ntfsprogs-plus-1.0.0/libntfs/cache.c000066400000000000000000000363541507404161300174020ustar00rootroot00000000000000/** * cache.c : deal with LRU caches * * Copyright (c) 2008-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #include "types.h" #include "security.h" #include "cache.h" #include "misc.h" #include "logging.h" /* * General functions to deal with LRU caches * * The cached data have to be organized in a structure in which * the first fields must follow a mandatory pattern and further * fields may contain any fixed size data. They are stored in an * LRU list. * * A compare function must be provided for finding a wanted entry * in the cache. Another function may be provided for invalidating * an entry to facilitate multiple invalidation. * * These functions never return error codes. When there is a * shortage of memory, data is simply not cached. * When there is a hashing bug, hashing is dropped, and sequential * searches are used. */ /* * Enter a new hash index, after a new record has been inserted * * Do not call when a record has been modified (with no key change) */ static void inserthashindex(struct CACHE_HEADER *cache, struct CACHED_GENERIC *current) { int h; struct HASH_ENTRY *link; struct HASH_ENTRY *first; if (cache->dohash) { h = cache->dohash(current); if ((h >= 0) && (h < cache->max_hash)) { /* get a free link and insert at top of hash list */ link = cache->free_hash; if (link) { cache->free_hash = link->next; first = cache->first_hash[h]; if (first) link->next = first; else link->next = NULL; link->entry = current; cache->first_hash[h] = link; } else { ntfs_log_error("No more hash entries," " cache %s hashing dropped\n", cache->name); cache->dohash = (cache_hash)NULL; } } else { ntfs_log_error("Illegal hash value," " cache %s hashing dropped\n", cache->name); cache->dohash = (cache_hash)NULL; } } } /* * Drop a hash index when a record is about to be deleted */ static void drophashindex(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *current, int hash) { struct HASH_ENTRY *link; struct HASH_ENTRY *previous; if (cache->dohash) { if ((hash >= 0) && (hash < cache->max_hash)) { /* find the link and unlink */ link = cache->first_hash[hash]; previous = (struct HASH_ENTRY*)NULL; while (link && (link->entry != current)) { previous = link; link = link->next; } if (link) { if (previous) previous->next = link->next; else cache->first_hash[hash] = link->next; link->next = cache->free_hash; cache->free_hash = link; } else { ntfs_log_error("Bad hash list," " cache %s hashing dropped\n", cache->name); cache->dohash = (cache_hash)NULL; } } else { ntfs_log_error("Illegal hash value," " cache %s hashing dropped\n", cache->name); cache->dohash = (cache_hash)NULL; } } } /* * Fetch an entry from cache * * returns the cache entry, or NULL if not available * The returned entry may be modified, but not freed */ struct CACHED_GENERIC *ntfs_fetch_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *wanted, cache_compare compare) { struct CACHED_GENERIC *current; struct CACHED_GENERIC *previous; struct HASH_ENTRY *link; int h; current = (struct CACHED_GENERIC*)NULL; if (cache) { if (cache->dohash) { /* * When possible, use the hash table to * locate the entry if present */ h = cache->dohash(wanted); link = cache->first_hash[h]; while (link && compare(link->entry, wanted)) link = link->next; if (link) current = link->entry; } if (!cache->dohash) { /* * Search sequentially in LRU list if no hash table * or if hashing has just failed */ current = cache->most_recent_entry; while (current && compare(current, wanted)) { current = current->next; } } if (current) { previous = current->previous; cache->hits++; if (previous) { /* * found and not at head of list, unlink from current * position and relink as head of list */ previous->next = current->next; if (current->next) current->next->previous = current->previous; else cache->oldest_entry = current->previous; current->next = cache->most_recent_entry; current->previous = (struct CACHED_GENERIC*)NULL; cache->most_recent_entry->previous = current; cache->most_recent_entry = current; } } cache->reads++; } return (current); } /* * Enter an inode number into cache * returns the cache entry or NULL if not possible */ struct CACHED_GENERIC *ntfs_enter_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *item, cache_compare compare) { struct CACHED_GENERIC *current; struct CACHED_GENERIC *before; struct HASH_ENTRY *link; int h; current = (struct CACHED_GENERIC*)NULL; if (cache) { if (cache->dohash) { /* * When possible, use the hash table to * find out whether the entry if present */ h = cache->dohash(item); link = cache->first_hash[h]; while (link && compare(link->entry, item)) link = link->next; if (link) { current = link->entry; } } if (!cache->dohash) { /* * Search sequentially in LRU list to locate the end, * and find out whether the entry is already in list * As we normally go to the end, no statistics is * kept. */ current = cache->most_recent_entry; while (current && compare(current, item)) { current = current->next; } } if (!current) { /* * Not in list, get a free entry or reuse the * last entry, and relink as head of list * Note : we assume at least three entries, so * before, previous and first are different when * an entry is reused. */ if (cache->free_entry) { current = cache->free_entry; cache->free_entry = cache->free_entry->next; if (item->varsize) { current->variable = ntfs_malloc( item->varsize); } else current->variable = (void*)NULL; current->varsize = item->varsize; if (!cache->oldest_entry) cache->oldest_entry = current; } else { /* reusing the oldest entry */ current = cache->oldest_entry; before = current->previous; before->next = (struct CACHED_GENERIC*)NULL; if (cache->dohash) drophashindex(cache,current, cache->dohash(current)); if (cache->dofree) cache->dofree(current); cache->oldest_entry = current->previous; if (item->varsize) { if (current->varsize) current->variable = realloc( current->variable, item->varsize); else current->variable = ntfs_malloc( item->varsize); } else { if (current->varsize) free(current->variable); current->variable = (void*)NULL; } current->varsize = item->varsize; } current->next = cache->most_recent_entry; current->previous = (struct CACHED_GENERIC*)NULL; if (cache->most_recent_entry) cache->most_recent_entry->previous = current; cache->most_recent_entry = current; memcpy(current->payload, item->payload, cache->fixed_size); if (item->varsize) { if (current->variable) { memcpy(current->variable, item->variable, item->varsize); } else { /* * no more memory for variable part * recycle entry in free list * not an error, just uncacheable */ cache->most_recent_entry = current->next; current->next = cache->free_entry; cache->free_entry = current; current = (struct CACHED_GENERIC*)NULL; } } else { current->variable = (void*)NULL; current->varsize = 0; } if (cache->dohash && current) inserthashindex(cache,current); } else { if (cache->dofree) cache->dofree(item); } cache->writes++; } return (current); } /* * Invalidate a cache entry * The entry is moved to the free entry list * A specific function may be called for entry deletion */ static void do_invalidate(struct CACHE_HEADER *cache, struct CACHED_GENERIC *current, int flags) { struct CACHED_GENERIC *previous; previous = current->previous; if ((flags & CACHE_FREE) && cache->dofree) cache->dofree(current); /* * Relink into free list */ if (current->next) current->next->previous = current->previous; else cache->oldest_entry = current->previous; if (previous) previous->next = current->next; else cache->most_recent_entry = current->next; current->next = cache->free_entry; cache->free_entry = current; if (current->variable) free(current->variable); current->varsize = 0; } /* * Invalidate entries in cache * * Several entries may have to be invalidated (at least for inodes * associated to directories which have been renamed), a different * compare function may be provided to select entries to invalidate * * Returns the number of deleted entries, this can be used by * the caller to signal a cache corruption if the entry was * supposed to be found. */ int ntfs_invalidate_cache(struct CACHE_HEADER *cache, const struct CACHED_GENERIC *item, cache_compare compare, int flags) { struct CACHED_GENERIC *current; struct CACHED_GENERIC *next; struct HASH_ENTRY *link; int count; int h; current = (struct CACHED_GENERIC*)NULL; count = 0; if (cache) { if (!(flags & CACHE_NOHASH) && cache->dohash) { /* * When possible, use the hash table to * find out whether the entry if present */ h = cache->dohash(item); link = cache->first_hash[h]; while (link) { if (compare(link->entry, item)) link = link->next; else { current = link->entry; link = link->next; if (current) { drophashindex(cache,current,h); do_invalidate(cache, current,flags); count++; } } } } if ((flags & CACHE_NOHASH) || !cache->dohash) { /* * Search sequentially in LRU list */ current = cache->most_recent_entry; while (current) { if (!compare(current, item)) { next = current->next; if (cache->dohash) drophashindex(cache,current, cache->dohash(current)); do_invalidate(cache,current,flags); current = next; count++; } else { current = current->next; } } } } return (count); } int ntfs_remove_cache(struct CACHE_HEADER *cache, struct CACHED_GENERIC *item, int flags) { int count; count = 0; if (cache) { if (cache->dohash) drophashindex(cache,item,cache->dohash(item)); do_invalidate(cache,item,flags); count++; } return (count); } /* * Free memory allocated to a cache */ static void ntfs_free_cache(struct CACHE_HEADER *cache) { struct CACHED_GENERIC *entry; if (cache) { for (entry=cache->most_recent_entry; entry; entry=entry->next) { if (cache->dofree) cache->dofree(entry); if (entry->variable) free(entry->variable); } free(cache); } } /* * Create a cache * * Returns the cache header, or NULL if the cache could not be created */ static struct CACHE_HEADER *ntfs_create_cache(const char *name, cache_free dofree, cache_hash dohash, int full_item_size, int item_count, int max_hash) { struct CACHE_HEADER *cache; struct CACHED_GENERIC *pc; struct CACHED_GENERIC *qc; struct HASH_ENTRY *ph; struct HASH_ENTRY *qh; struct HASH_ENTRY **px; size_t size; int i; size = sizeof(struct CACHE_HEADER) + item_count*full_item_size; if (max_hash) size += item_count*sizeof(struct HASH_ENTRY) + max_hash*sizeof(struct HASH_ENTRY*); cache = (struct CACHE_HEADER*)ntfs_malloc(size); if (cache) { /* header */ cache->name = name; cache->dofree = dofree; if (dohash && max_hash) { cache->dohash = dohash; cache->max_hash = max_hash; } else { cache->dohash = (cache_hash)NULL; cache->max_hash = 0; } cache->fixed_size = full_item_size - sizeof(struct CACHED_GENERIC); cache->reads = 0; cache->writes = 0; cache->hits = 0; /* chain the data entries, and mark an invalid entry */ cache->most_recent_entry = (struct CACHED_GENERIC*)NULL; cache->oldest_entry = (struct CACHED_GENERIC*)NULL; cache->free_entry = &cache->entry[0]; pc = &cache->entry[0]; for (i=0; i<(item_count - 1); i++) { qc = (struct CACHED_GENERIC*)((char*)pc + full_item_size); pc->next = qc; pc->variable = (void*)NULL; pc->varsize = 0; pc = qc; } /* special for the last entry */ pc->next = (struct CACHED_GENERIC*)NULL; pc->variable = (void*)NULL; pc->varsize = 0; if (max_hash) { /* chain the hash entries */ ph = (struct HASH_ENTRY*)(((char*)pc) + full_item_size); cache->free_hash = ph; for (i=0; i<(item_count - 1); i++) { qh = &ph[1]; ph->next = qh; ph = qh; } /* special for the last entry */ if (item_count) { ph->next = (struct HASH_ENTRY*)NULL; } /* create and initialize the hash indexes */ px = (struct HASH_ENTRY**)&ph[1]; cache->first_hash = px; for (i=0; ifree_hash = (struct HASH_ENTRY*)NULL; cache->first_hash = (struct HASH_ENTRY**)NULL; } } return (cache); } /* * Create all LRU caches * * No error return, if creation is not possible, cacheing will * just be not available */ void ntfs_create_lru_caches(ntfs_volume *vol) { #if CACHE_INODE_SIZE /* inode cache */ vol->xinode_cache = ntfs_create_cache("inode",(cache_free)NULL, ntfs_dir_inode_hash, sizeof(struct CACHED_INODE), CACHE_INODE_SIZE, 2*CACHE_INODE_SIZE); #endif #if CACHE_NIDATA_SIZE /* idata cache */ vol->nidata_cache = ntfs_create_cache("nidata", ntfs_inode_nidata_free, ntfs_inode_nidata_hash, sizeof(struct CACHED_NIDATA), CACHE_NIDATA_SIZE, 2*CACHE_NIDATA_SIZE); #endif #if CACHE_LOOKUP_SIZE /* lookup cache */ vol->lookup_cache = ntfs_create_cache("lookup", (cache_free)NULL, ntfs_dir_lookup_hash, sizeof(struct CACHED_LOOKUP), CACHE_LOOKUP_SIZE, 2*CACHE_LOOKUP_SIZE); #endif vol->securid_cache = ntfs_create_cache("securid",(cache_free)NULL, (cache_hash)NULL,sizeof(struct CACHED_SECURID), CACHE_SECURID_SIZE, 0); #if CACHE_LEGACY_SIZE vol->legacy_cache = ntfs_create_cache("legacy",(cache_free)NULL, (cache_hash)NULL, sizeof(struct CACHED_PERMISSIONS_LEGACY), CACHE_LEGACY_SIZE, 0); #endif } /* * Free all LRU caches */ void ntfs_free_lru_caches(ntfs_volume *vol) { #if CACHE_INODE_SIZE ntfs_free_cache(vol->xinode_cache); #endif #if CACHE_NIDATA_SIZE ntfs_free_cache(vol->nidata_cache); #endif #if CACHE_LOOKUP_SIZE ntfs_free_cache(vol->lookup_cache); #endif ntfs_free_cache(vol->securid_cache); #if CACHE_LEGACY_SIZE ntfs_free_cache(vol->legacy_cache); #endif } ntfsprogs-plus-1.0.0/libntfs/collate.c000066400000000000000000000141721507404161300177540ustar00rootroot00000000000000/** * collate.c - NTFS collation handling. Originated from the Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2005 Yura Pakhuchiy * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "attrib.h" #include "index.h" #include "collate.h" #include "debug.h" #include "unistr.h" #include "logging.h" /** * ntfs_collate_binary - Which of two binary objects should be listed first * @vol: unused * @data1: * @data1_len: * @data2: * @data2_len: * * Description... * * Returns: */ static int ntfs_collate_binary(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, const void *data2, const int data2_len) { int rc; ntfs_log_trace("Entering.\n"); rc = memcmp(data1, data2, min(data1_len, data2_len)); if (!rc && (data1_len != data2_len)) { if (data1_len < data2_len) rc = -1; else rc = 1; } ntfs_log_trace("Done, returning %i.\n", rc); return rc; } /** * ntfs_collate_ntofs_ulong - Which of two long ints should be listed first * @vol: unused * @data1: * @data1_len: * @data2: * @data2_len: * * Description... * * Returns: */ static int ntfs_collate_ntofs_ulong(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, const void *data2, const int data2_len) { int rc; u32 d1, d2; ntfs_log_trace("Entering.\n"); if (data1_len != data2_len || data1_len != 4) { ntfs_log_error("data1_len or/and data2_len not equal to 4.\n"); return NTFS_COLLATION_ERROR; } d1 = le32_to_cpup(data1); d2 = le32_to_cpup(data2); if (d1 < d2) rc = -1; else { if (d1 == d2) rc = 0; else rc = 1; } ntfs_log_trace("Done, returning %i.\n", rc); return rc; } /** * ntfs_collate_ntofs_ulongs - Which of two le32 arrays should be listed first * * Returns: -1, 0 or 1 depending of how the arrays compare */ static int ntfs_collate_ntofs_ulongs(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, const void *data2, const int data2_len) { int rc; int len; const le32 *p1, *p2; u32 d1, d2; ntfs_log_trace("Entering.\n"); if ((data1_len != data2_len) || (data1_len <= 0) || (data1_len & 3)) { ntfs_log_error("data1_len or data2_len not valid\n"); return NTFS_COLLATION_ERROR; } p1 = (const le32*)data1; p2 = (const le32*)data2; len = data1_len; do { d1 = le32_to_cpup(p1); p1++; d2 = le32_to_cpup(p2); p2++; } while ((d1 == d2) && ((len -= 4) > 0)); if (d1 < d2) rc = -1; else { if (d1 == d2) rc = 0; else rc = 1; } ntfs_log_trace("Done, returning %i.\n", rc); return rc; } /** * ntfs_collate_ntofs_security_hash - Which of two security descriptors * should be listed first * @vol: unused * @data1: * @data1_len: * @data2: * @data2_len: * * JPA compare two security hash keys made of two unsigned le32 * * Returns: -1, 0 or 1 depending of how the keys compare */ static int ntfs_collate_ntofs_security_hash(ntfs_volume *vol __attribute__((unused)), const void *data1, const int data1_len, const void *data2, const int data2_len) { int rc; u32 d1, d2; const le32 *p1, *p2; ntfs_log_trace("Entering.\n"); if (data1_len != data2_len || data1_len != 8) { ntfs_log_error("data1_len or/and data2_len not equal to 8.\n"); return NTFS_COLLATION_ERROR; } p1 = (const le32*)data1; p2 = (const le32*)data2; d1 = le32_to_cpup(p1); d2 = le32_to_cpup(p2); if (d1 < d2) rc = -1; else { if (d1 > d2) rc = 1; else { p1++; p2++; d1 = le32_to_cpup(p1); d2 = le32_to_cpup(p2); if (d1 < d2) rc = -1; else { if (d1 > d2) rc = 1; else rc = 0; } } } ntfs_log_trace("Done, returning %i.\n", rc); return rc; } /** * ntfs_collate_file_name - Which of two filenames should be listed first * @vol: * @data1: * @data1_len: unused * @data2: * @data2_len: unused * * Description... * * Returns: */ static int ntfs_collate_file_name(ntfs_volume *vol, const void *data1, const int data1_len __attribute__((unused)), const void *data2, const int data2_len __attribute__((unused))) { const FILE_NAME_ATTR *file_name_attr1; const FILE_NAME_ATTR *file_name_attr2; int rc; ntfs_log_trace("Entering.\n"); file_name_attr1 = (const FILE_NAME_ATTR*)data1; file_name_attr2 = (const FILE_NAME_ATTR*)data2; rc = ntfs_names_full_collate( (ntfschar*)&file_name_attr1->file_name, file_name_attr1->file_name_length, (ntfschar*)&file_name_attr2->file_name, file_name_attr2->file_name_length, CASE_SENSITIVE, vol->upcase, vol->upcase_len); ntfs_log_trace("Done, returning %i.\n", rc); return rc; } /* * Get a pointer to appropriate collation function. * * Returns NULL if the needed function is not implemented */ COLLATE ntfs_get_collate_function(COLLATION_RULES cr) { COLLATE collate; switch (cr) { case COLLATION_BINARY : collate = ntfs_collate_binary; break; case COLLATION_FILE_NAME : collate = ntfs_collate_file_name; break; case COLLATION_NTOFS_SECURITY_HASH : collate = ntfs_collate_ntofs_security_hash; break; case COLLATION_NTOFS_ULONG : collate = ntfs_collate_ntofs_ulong; break; case COLLATION_NTOFS_ULONGS : collate = ntfs_collate_ntofs_ulongs; break; default : errno = EOPNOTSUPP; collate = (COLLATE)NULL; break; } return (collate); } ntfsprogs-plus-1.0.0/libntfs/compat.c000066400000000000000000000170741507404161300176200ustar00rootroot00000000000000/** * compat.c - Tweaks for Windows compatibility * * Copyright (c) 2002 Richard Russon * Copyright (c) 2002-2004 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "compat.h" #ifndef HAVE_FFS /** * ffs - Find the first set bit in an int * @x: * * Description... * * Returns: */ int ffs(int x) { int r = 1; if (!x) return 0; if (!(x & 0xffff)) { x >>= 16; r += 16; } if (!(x & 0xff)) { x >>= 8; r += 8; } if (!(x & 0xf)) { x >>= 4; r += 4; } if (!(x & 3)) { x >>= 2; r += 2; } if (!(x & 1)) { x >>= 1; r += 1; } return r; } #endif /* HAVE_FFS */ #ifndef HAVE_DAEMON /* ************************************************************ * From: src.opensolaris.org * src/lib/libresolv2/common/bsd/daemon.c */ /* * Copyright (c) 1997-2000 by Sun Microsystems, Inc. * All rights reserved. */ #if defined(LIBC_SCCS) && !defined(lint) static const char sccsid[] = "@(#)daemon.c 8.1 (Berkeley) 6/4/93"; static const char rcsid[] = "$Id: compat.c,v 1.1.1.1.2.1 2008-08-16 15:17:44 jpandre Exp $"; #endif /* LIBC_SCCS and not lint */ /* * Copyright (c) 1990, 1993 * The Regents of the University of California. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif int daemon(int nochdir, int noclose) { int fd; switch (fork()) { case -1: return (-1); case 0: break; default: _exit(0); } if (setsid() == -1) return (-1); if (!nochdir) (void)chdir("/"); if (!noclose && (fd = open("/dev/null", O_RDWR, 0)) != -1) { (void)dup2(fd, 0); (void)dup2(fd, 1); (void)dup2(fd, 2); if (fd > 2) (void)close (fd); } return (0); } /* * End: src/lib/libresolv2/common/bsd/daemon.c *************************************************************/ #endif /* HAVE_DAEMON */ #ifndef HAVE_STRSEP /* ************************************************************ * From: src.opensolaris.org * src/lib/libresolv2/common/bsd/strsep.c */ /* * Copyright (c) 1997, by Sun Microsystems, Inc. * All rights reserved. */ #if defined(LIBC_SCCS) && !defined(lint) static const char sccsid[] = "strsep.c 8.1 (Berkeley) 6/4/93"; static const char rcsid[] = "$Id: compat.c,v 1.1.1.1.2.1 2008-08-16 15:17:44 jpandre Exp $"; #endif /* LIBC_SCCS and not lint */ /* * Copyright (c) 1990, 1993 * The Regents of the University of California. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the University of * California, Berkeley and its contributors. * 4. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDIO_H #include #endif /* * Get next token from string *stringp, where tokens are possibly-empty * strings separated by characters from delim. * * Writes NULs into the string at *stringp to end tokens. * delim need not remain constant from call to call. * On return, *stringp points past the last NUL written (if there might * be further tokens), or is NULL (if there are definitely no more tokens). * * If *stringp is NULL, strsep returns NULL. */ char *strsep(char **stringp, const char *delim) { char *s; const char *spanp; int c, sc; char *tok; if ((s = *stringp) == NULL) return (NULL); for (tok = s;;) { c = *s++; spanp = delim; do { if ((sc = *spanp++) == c) { if (c == 0) s = NULL; else s[-1] = 0; *stringp = s; return (tok); } } while (sc != 0); } /* NOTREACHED */ } /* * End: src/lib/libresolv2/common/bsd/strsep.c *************************************************************/ #endif /* HAVE_STRSEP */ ntfsprogs-plus-1.0.0/libntfs/compress.c000066400000000000000000001541021507404161300201620ustar00rootroot00000000000000/** * compress.c - Compressed attribute handling code. Originated from the Linux-NTFS * project. * * Copyright (c) 2004-2005 Anton Altaparmakov * Copyright (c) 2004-2006 Szabolcs Szakacsits * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2009-2014 Jean-Pierre Andre * Copyright (c) 2014 Eric Biggers * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "attrib.h" #include "debug.h" #include "volume.h" #include "types.h" #include "layout.h" #include "runlist.h" #include "compress.h" #include "lcnalloc.h" #include "logging.h" #include "misc.h" #undef le16_to_cpup /* the standard le16_to_cpup() crashes for unaligned data on some processors */ #define le16_to_cpup(p) (*(u8*)(p) + (((u8*)(p))[1] << 8)) /** * enum ntfs_compression_constants - constants used in the compression code */ typedef enum { /* Token types and access mask. */ NTFS_SYMBOL_TOKEN = 0, NTFS_PHRASE_TOKEN = 1, NTFS_TOKEN_MASK = 1, /* Compression sub-block constants. */ NTFS_SB_SIZE_MASK = 0x0fff, NTFS_SB_SIZE = 0x1000, NTFS_SB_IS_COMPRESSED = 0x8000, } ntfs_compression_constants; /* Match length at or above which ntfs_best_match() will stop searching for * longer matches. */ #define NICE_MATCH_LEN 18 /* Maximum number of potential matches that ntfs_best_match() will consider at * each position. */ #define MAX_SEARCH_DEPTH 24 /* log base 2 of the number of entries in the hash table for match-finding. */ #define HASH_SHIFT 14 /* Constant for the multiplicative hash function. */ #define HASH_MULTIPLIER 0x1E35A7BD struct COMPRESS_CONTEXT { const unsigned char *inbuf; int bufsize; int size; int rel; int mxsz; s16 head[1 << HASH_SHIFT]; s16 prev[NTFS_SB_SIZE]; } ; /* * Hash the next 3-byte sequence in the input buffer */ static inline unsigned int ntfs_hash(const u8 *p) { u32 str; u32 hash; #if defined(__i386__) || defined(__x86_64__) /* Unaligned access allowed, and little endian CPU. * Callers ensure that at least 4 (not 3) bytes are remaining. */ str = *(const u32 *)p & 0xFFFFFF; #else str = ((u32)p[0] << 0) | ((u32)p[1] << 8) | ((u32)p[2] << 16); #endif hash = str * HASH_MULTIPLIER; /* High bits are more random than the low bits. */ return hash >> (32 - HASH_SHIFT); } /* * Search for the longest sequence matching current position * * A hash table, each entry of which points to a chain of sequence * positions sharing the corresponding hash code, is maintained to speed up * searching for matches. To maintain the hash table, either * ntfs_best_match() or ntfs_skip_position() has to be called for each * consecutive position. * * This function is heavily used; it has to be optimized carefully. * * This function sets pctx->size and pctx->rel to the length and offset, * respectively, of the longest match found. * * The minimum match length is assumed to be 3, and the maximum match * length is assumed to be pctx->mxsz. If this function produces * pctx->size < 3, then no match was found. * * Note: for the following reasons, this function is not guaranteed to find * *the* longest match up to pctx->mxsz: * * (1) If this function finds a match of NICE_MATCH_LEN bytes or greater, * it ends early because a match this long is good enough and it's not * worth spending more time searching. * * (2) If this function considers MAX_SEARCH_DEPTH matches with a single * position, it ends early and returns the longest match found so far. * This saves a lot of time on degenerate inputs. */ static void ntfs_best_match(struct COMPRESS_CONTEXT *pctx, const int i, int best_len) { const u8 * const inbuf = pctx->inbuf; const u8 * const strptr = &inbuf[i]; /* String we're matching against */ s16 * const prev = pctx->prev; const int max_len = min(pctx->bufsize - i, pctx->mxsz); const int nice_len = min(NICE_MATCH_LEN, max_len); int depth_remaining = MAX_SEARCH_DEPTH; const u8 *best_matchptr = strptr; unsigned int hash; s16 cur_match; const u8 *matchptr; int len; if (max_len < 4) goto out; /* Insert the current sequence into the appropriate hash chain. */ hash = ntfs_hash(strptr); cur_match = pctx->head[hash]; prev[i] = cur_match; pctx->head[hash] = i; if (best_len >= max_len) { /* Lazy match is being attempted, but there aren't enough length * bits remaining to code a longer match. */ goto out; } /* Search the appropriate hash chain for matches. */ for (; cur_match >= 0 && depth_remaining--; cur_match = prev[cur_match]) { matchptr = &inbuf[cur_match]; /* Considering the potential match at 'matchptr': is it longer * than 'best_len'? * * The bytes at index 'best_len' are the most likely to differ, * so check them first. * * The bytes at indices 'best_len - 1' and '0' are less * important to check separately. But doing so still gives a * slight performance improvement, at least on x86_64, probably * because they create separate branches for the CPU to predict * independently of the branches in the main comparison loops. */ if (matchptr[best_len] != strptr[best_len] || matchptr[best_len - 1] != strptr[best_len - 1] || matchptr[0] != strptr[0]) goto next_match; for (len = 1; len < best_len - 1; len++) if (matchptr[len] != strptr[len]) goto next_match; /* The match is the longest found so far --- * at least 'best_len' + 1 bytes. Continue extending it. */ best_matchptr = matchptr; do { if (++best_len >= nice_len) { /* 'nice_len' reached; don't waste time * searching for longer matches. Extend the * match as far as possible and terminate the * search. */ while (best_len < max_len && (best_matchptr[best_len] == strptr[best_len])) { best_len++; } goto out; } } while (best_matchptr[best_len] == strptr[best_len]); /* Found a longer match, but 'nice_len' not yet reached. */ next_match: /* Continue to next match in the chain. */ ; } /* Reached end of chain, or ended early due to reaching the maximum * search depth. */ out: /* Return the longest match we were able to find. */ pctx->size = best_len; pctx->rel = best_matchptr - strptr; /* given as a negative number! */ } /* * Advance the match-finder, but don't search for matches. */ static void ntfs_skip_position(struct COMPRESS_CONTEXT *pctx, const int i) { unsigned int hash; if (pctx->bufsize - i < 4) return; /* Insert the current sequence into the appropriate hash chain. */ hash = ntfs_hash(pctx->inbuf + i); pctx->prev[i] = pctx->head[hash]; pctx->head[hash] = i; } /* * Compress a 4096-byte block * * Returns a header of two bytes followed by the compressed data. * If compression is not effective, the header and an uncompressed * block is returned. * * Note : two bytes may be output before output buffer overflow * is detected, so a 4100-bytes output buffer must be reserved. * * Returns the size of the compressed block, including the * header (minimal size is 2, maximum size is 4098) * 0 if an error has been met. */ static unsigned int ntfs_compress_block(const char *inbuf, const int bufsize, char *outbuf) { struct COMPRESS_CONTEXT *pctx; int i; /* current position */ int j; /* end of best match from current position */ int k; /* end of best match from next position */ int offs; /* offset to best match */ int bp; /* bits to store offset */ int bp_cur; /* saved bits to store offset at current position */ int mxoff; /* max match offset : 1 << bp */ unsigned int xout; unsigned int q; /* aggregated offset and size */ int have_match; /* do we have a match at the current position? */ char *ptag; /* location reserved for a tag */ int tag; /* current value of tag */ int ntag; /* count of bits still undefined in tag */ pctx = ntfs_malloc(sizeof(struct COMPRESS_CONTEXT)); if (!pctx) { errno = ENOMEM; return 0; } /* All hash chains start as empty. The special value '-1' indicates the * end of each hash chain. */ memset(pctx->head, 0xFF, sizeof(pctx->head)); pctx->inbuf = (const unsigned char*)inbuf; pctx->bufsize = bufsize; xout = 2; i = 0; bp = 4; mxoff = 1 << bp; pctx->mxsz = (1 << (16 - bp)) + 2; have_match = 0; tag = 0; ntag = 8; ptag = &outbuf[xout++]; while ((i < bufsize) && (xout < (NTFS_SB_SIZE + 2))) { /* This implementation uses "lazy" parsing: it always chooses * the longest match, unless the match at the next position is * longer. This is the same strategy used by the high * compression modes of zlib. */ if (!have_match) { /* Find the longest match at the current position. But * first adjust the maximum match length if needed. * (This loop might need to run more than one time in * the case that we just output a long match.) */ while (mxoff < i) { bp++; mxoff <<= 1; pctx->mxsz = (pctx->mxsz + 2) >> 1; } ntfs_best_match(pctx, i, 2); } if (pctx->size >= 3) { /* Found a match at the current position. */ j = i + pctx->size; bp_cur = bp; offs = pctx->rel; if (pctx->size >= NICE_MATCH_LEN) { /* Choose long matches immediately. */ q = (~offs << (16 - bp_cur)) + (j - i - 3); outbuf[xout++] = q & 255; outbuf[xout++] = (q >> 8) & 255; tag |= (1 << (8 - ntag)); if (j == bufsize) { /* Shortcut if the match extends to the * end of the buffer. */ i = j; --ntag; break; } i += 1; do { ntfs_skip_position(pctx, i); } while (++i != j); have_match = 0; } else { /* Check for a longer match at the next * position. */ /* Doesn't need to be while() since we just * adjusted the maximum match length at the * previous position. */ if (mxoff < i + 1) { bp++; mxoff <<= 1; pctx->mxsz = (pctx->mxsz + 2) >> 1; } ntfs_best_match(pctx, i + 1, pctx->size); k = i + 1 + pctx->size; if (k > (j + 1)) { /* Next match is longer. * Output a literal. */ outbuf[xout++] = inbuf[i++]; have_match = 1; } else { /* Next match isn't longer. * Output the current match. */ q = (~offs << (16 - bp_cur)) + (j - i - 3); outbuf[xout++] = q & 255; outbuf[xout++] = (q >> 8) & 255; tag |= (1 << (8 - ntag)); /* The minimum match length is 3, and * we've run two bytes through the * matchfinder already. So the minimum * number of positions we need to skip * is 1. */ i += 2; do { ntfs_skip_position(pctx, i); } while (++i != j); have_match = 0; } } } else { /* No match at current position. Output a literal. */ outbuf[xout++] = inbuf[i++]; have_match = 0; } /* Store the tag if fully used. */ if (!--ntag) { *ptag = tag; ntag = 8; ptag = &outbuf[xout++]; tag = 0; } } /* Store the last tag if partially used. */ if (ntag == 8) xout--; else *ptag = tag; /* Determine whether to store the data compressed or uncompressed. */ if ((i >= bufsize) && (xout < (NTFS_SB_SIZE + 2))) { /* Compressed. */ outbuf[0] = (xout - 3) & 255; outbuf[1] = 0xb0 + (((xout - 3) >> 8) & 15); } else { /* Uncompressed. */ memcpy(&outbuf[2], inbuf, bufsize); if (bufsize < NTFS_SB_SIZE) memset(&outbuf[bufsize + 2], 0, NTFS_SB_SIZE - bufsize); outbuf[0] = 0xff; outbuf[1] = 0x3f; xout = NTFS_SB_SIZE + 2; } /* Free the compression context and return the total number of bytes * written to 'outbuf'. */ free(pctx); return (xout); } /** * ntfs_decompress - decompress a compression block into an array of pages * @dest: buffer to which to write the decompressed data * @dest_size: size of buffer @dest in bytes * @cb_start: compression block to decompress * @cb_size: size of compression block @cb_start in bytes * * This decompresses the compression block @cb_start into the destination * buffer @dest. * * @cb_start is a pointer to the compression block which needs decompressing * and @cb_size is the size of @cb_start in bytes (8-64kiB). * * Return 0 if success or -EOVERFLOW on error in the compressed stream. */ static int ntfs_decompress(u8 *dest, const u32 dest_size, u8 *const cb_start, const u32 cb_size) { /* * Pointers into the compressed data, i.e. the compression block (cb), * and the therein contained sub-blocks (sb). */ u8 *cb_end = cb_start + cb_size; /* End of cb. */ u8 *cb = cb_start; /* Current position in cb. */ u8 *cb_sb_start = cb; /* Beginning of the current sb in the cb. */ u8 *cb_sb_end; /* End of current sb / beginning of next sb. */ /* Variables for uncompressed data / destination. */ u8 *dest_end = dest + dest_size; /* End of dest buffer. */ u8 *dest_sb_start; /* Start of current sub-block in dest. */ u8 *dest_sb_end; /* End of current sb in dest. */ /* Variables for tag and token parsing. */ u8 tag; /* Current tag. */ int token; /* Loop counter for the eight tokens in tag. */ ntfs_log_trace("Entering, cb_size = 0x%x.\n", (unsigned)cb_size); do_next_sb: ntfs_log_debug("Beginning sub-block at offset = %d in the cb.\n", (int)(cb - cb_start)); /* * Have we reached the end of the compression block or the end of the * decompressed data? The latter can happen for example if the current * position in the compression block is one byte before its end so the * first two checks do not detect it. */ if (cb == cb_end || !le16_to_cpup((le16*)cb) || dest == dest_end) { if (dest_end > dest) memset(dest, 0, dest_end - dest); ntfs_log_debug("Completed. Returning success (0).\n"); return 0; } /* Setup offset for the current sub-block destination. */ dest_sb_start = dest; dest_sb_end = dest + NTFS_SB_SIZE; /* Check that we are still within allowed boundaries. */ if (dest_sb_end > dest_end) goto return_overflow; /* Does the minimum size of a compressed sb overflow valid range? */ if (cb + 6 > cb_end) goto return_overflow; /* Setup the current sub-block source pointers and validate range. */ cb_sb_start = cb; cb_sb_end = cb_sb_start + (le16_to_cpup((le16*)cb) & NTFS_SB_SIZE_MASK) + 3; if (cb_sb_end > cb_end) goto return_overflow; /* Now, we are ready to process the current sub-block (sb). */ if (!(le16_to_cpup((le16*)cb) & NTFS_SB_IS_COMPRESSED)) { ntfs_log_debug("Found uncompressed sub-block.\n"); /* This sb is not compressed, just copy it into destination. */ /* Advance source position to first data byte. */ cb += 2; /* An uncompressed sb must be full size. */ if (cb_sb_end - cb != NTFS_SB_SIZE) goto return_overflow; /* Copy the block and advance the source position. */ memcpy(dest, cb, NTFS_SB_SIZE); cb += NTFS_SB_SIZE; /* Advance destination position to next sub-block. */ dest += NTFS_SB_SIZE; goto do_next_sb; } ntfs_log_debug("Found compressed sub-block.\n"); /* This sb is compressed, decompress it into destination. */ /* Forward to the first tag in the sub-block. */ cb += 2; do_next_tag: if (cb == cb_sb_end) { /* Check if the decompressed sub-block was not full-length. */ if (dest < dest_sb_end) { int nr_bytes = dest_sb_end - dest; ntfs_log_debug("Filling incomplete sub-block with zeroes.\n"); /* Zero remainder and update destination position. */ memset(dest, 0, nr_bytes); dest += nr_bytes; } /* We have finished the current sub-block. */ goto do_next_sb; } /* Check we are still in range. */ if (cb > cb_sb_end || dest > dest_sb_end) goto return_overflow; /* Get the next tag and advance to first token. */ tag = *cb++; /* Parse the eight tokens described by the tag. */ for (token = 0; token < 8; token++, tag >>= 1) { u16 lg, pt, length, max_non_overlap; register u16 i; u8 *dest_back_addr; /* Check if we are done / still in range. */ if (cb >= cb_sb_end || dest > dest_sb_end) break; /* Determine token type and parse appropriately.*/ if ((tag & NTFS_TOKEN_MASK) == NTFS_SYMBOL_TOKEN) { /* * We have a symbol token, copy the symbol across, and * advance the source and destination positions. */ *dest++ = *cb++; /* Continue with the next token. */ continue; } /* * We have a phrase token. Make sure it is not the first tag in * the sb as this is illegal and would confuse the code below. */ if (dest == dest_sb_start) goto return_overflow; /* * Determine the number of bytes to go back (p) and the number * of bytes to copy (l). We use an optimized algorithm in which * we first calculate log2(current destination position in sb), * which allows determination of l and p in O(1) rather than * O(n). We just need an arch-optimized log2() function now. */ lg = 0; for (i = dest - dest_sb_start - 1; i >= 0x10; i >>= 1) lg++; /* Get the phrase token into i. */ pt = le16_to_cpup((le16*)cb); /* * Calculate starting position of the byte sequence in * the destination using the fact that p = (pt >> (12 - lg)) + 1 * and make sure we don't go too far back. */ dest_back_addr = dest - (pt >> (12 - lg)) - 1; if (dest_back_addr < dest_sb_start) goto return_overflow; /* Now calculate the length of the byte sequence. */ length = (pt & (0xfff >> lg)) + 3; /* Verify destination is in range. */ if (dest + length > dest_sb_end) goto return_overflow; /* The number of non-overlapping bytes. */ max_non_overlap = dest - dest_back_addr; if (length <= max_non_overlap) { /* The byte sequence doesn't overlap, just copy it. */ memcpy(dest, dest_back_addr, length); /* Advance destination pointer. */ dest += length; } else { /* * The byte sequence does overlap, copy non-overlapping * part and then do a slow byte by byte copy for the * overlapping part. Also, advance the destination * pointer. */ memcpy(dest, dest_back_addr, max_non_overlap); dest += max_non_overlap; dest_back_addr += max_non_overlap; length -= max_non_overlap; while (length--) *dest++ = *dest_back_addr++; } /* Advance source position and continue with the next token. */ cb += 2; } /* No tokens left in the current tag. Continue with the next tag. */ goto do_next_tag; return_overflow: errno = EOVERFLOW; ntfs_log_perror("Failed to decompress file"); return -1; } /** * ntfs_is_cb_compressed - internal function, do not use * * This is a very specialised function determining if a cb is compressed or * uncompressed. It is assumed that checking for a sparse cb has already been * performed and that the cb is not sparse. It makes all sorts of other * assumptions as well and hence it is not useful anywhere other than where it * is used at the moment. Please, do not make this function available for use * outside of compress.c as it is bound to confuse people and not do what they * want. * * Return TRUE on errors so that the error will be detected later on in the * code. Might be a bit confusing to debug but there really should never be * errors coming from here. */ static BOOL ntfs_is_cb_compressed(ntfs_attr *na, runlist_element *rl, VCN cb_start_vcn, int cb_clusters) { /* * The simplest case: the run starting at @cb_start_vcn contains * @cb_clusters clusters which are all not sparse, thus the cb is not * compressed. */ restart: cb_clusters -= rl->length - (cb_start_vcn - rl->vcn); while (cb_clusters > 0) { /* Go to the next run. */ rl++; /* Map the next runlist fragment if it is not mapped. */ if (rl->lcn < LCN_HOLE || !rl->length) { cb_start_vcn = rl->vcn; rl = ntfs_attr_find_vcn(na, rl->vcn); if (!rl || rl->lcn < LCN_HOLE || !rl->length) return TRUE; /* * If the runs were merged need to deal with the * resulting partial run so simply restart. */ if (rl->vcn < cb_start_vcn) goto restart; } /* If the current run is sparse, the cb is compressed. */ if (rl->lcn == LCN_HOLE) return TRUE; /* If the whole cb is not sparse, it is not compressed. */ if (rl->length >= cb_clusters) return FALSE; cb_clusters -= rl->length; }; /* All cb_clusters were not sparse thus the cb is not compressed. */ return FALSE; } /** * ntfs_compressed_attr_pread - read from a compressed attribute * @na: ntfs attribute to read from * @pos: byte position in the attribute to begin reading from * @count: number of bytes to read * @b: output data buffer * * NOTE: You probably want to be using attrib.c::ntfs_attr_pread() instead. * * This function will read @count bytes starting at offset @pos from the * compressed ntfs attribute @na into the data buffer @b. * * On success, return the number of successfully read bytes. If this number * is lower than @count this means that the read reached end of file or that * an error was encountered during the read so that the read is partial. * 0 means end of file or nothing was read (also return 0 when @count is 0). * * On error and nothing has been read, return -1 with errno set appropriately * to the return code of ntfs_pread(), or to EINVAL in case of invalid * arguments. */ s64 ntfs_compressed_attr_pread(ntfs_attr *na, s64 pos, s64 count, void *b) { s64 br, to_read, ofs, total, total2; u64 cb_size_mask; VCN start_vcn, vcn, end_vcn; ntfs_volume *vol; runlist_element *rl; u8 *dest, *cb, *cb_pos, *cb_end; u32 cb_size; int err; ATTR_FLAGS data_flags; FILE_ATTR_FLAGS compression; unsigned int nr_cbs, cb_clusters; ntfs_log_trace("Entering for inode 0x%llx, attr 0x%x, pos 0x%llx, count 0x%llx.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)pos, (long long)count); data_flags = na->data_flags; compression = na->ni->flags & FILE_ATTR_COMPRESSED; if (!na || !na->ni || !na->ni->vol || !b || ((data_flags & ATTR_COMPRESSION_MASK) != ATTR_IS_COMPRESSED) || pos < 0 || count < 0) { errno = EINVAL; return -1; } /* * Encrypted attributes are not supported. We return access denied, * which is what Windows NT4 does, too. */ if (NAttrEncrypted(na)) { errno = EACCES; return -1; } if (!count) return 0; /* Truncate reads beyond end of attribute. */ if (pos + count > na->data_size) { if (pos >= na->data_size) { return 0; } count = na->data_size - pos; } /* If it is a resident attribute, simply use ntfs_attr_pread(). */ if (!NAttrNonResident(na)) return ntfs_attr_pread(na, pos, count, b); if (na->compression_block_size < NTFS_SB_SIZE) { ntfs_log_error("Unsupported compression block size %ld\n", (long)na->compression_block_size); errno = EOVERFLOW; return (-1); } total = total2 = 0; /* Zero out reads beyond initialized size. */ if (pos + count > na->initialized_size) { if (pos >= na->initialized_size) { memset(b, 0, count); return count; } total2 = pos + count - na->initialized_size; count -= total2; memset((u8*)b + count, 0, total2); } vol = na->ni->vol; cb_size = na->compression_block_size; cb_size_mask = cb_size - 1UL; cb_clusters = na->compression_block_clusters; /* Need a temporary buffer for each loaded compression block. */ cb = (u8*)ntfs_malloc(cb_size); if (!cb) return -1; /* Need a temporary buffer for each uncompressed block. */ dest = (u8*)ntfs_malloc(cb_size); if (!dest) { free(cb); return -1; } /* * The first vcn in the first compression block (cb) which we need to * decompress. */ start_vcn = (pos & ~cb_size_mask) >> vol->cluster_size_bits; /* Offset in the uncompressed cb at which to start reading data. */ ofs = pos & cb_size_mask; /* * The first vcn in the cb after the last cb which we need to * decompress. */ end_vcn = ((pos + count + cb_size - 1) & ~cb_size_mask) >> vol->cluster_size_bits; /* Number of compression blocks (cbs) in the wanted vcn range. */ nr_cbs = (end_vcn - start_vcn) << vol->cluster_size_bits >> na->compression_block_size_bits; cb_end = cb + cb_size; do_next_cb: nr_cbs--; cb_pos = cb; vcn = start_vcn; start_vcn += cb_clusters; /* Check whether the compression block is sparse. */ rl = ntfs_attr_find_vcn(na, vcn); if (!rl || rl->lcn < LCN_HOLE) { free(cb); free(dest); if (total) return total; /* FIXME: Do we want EIO or the error code? (AIA) */ errno = EIO; return -1; } if (rl->lcn == LCN_HOLE) { /* Sparse cb, zero out destination range overlapping the cb. */ ntfs_log_debug("Found sparse compression block.\n"); to_read = min(count, cb_size - ofs); memset(b, 0, to_read); ofs = 0; total += to_read; count -= to_read; b = (u8*)b + to_read; } else if (!ntfs_is_cb_compressed(na, rl, vcn, cb_clusters)) { s64 tdata_size, tinitialized_size; /* * Uncompressed cb, read it straight into the destination range * overlapping the cb. */ ntfs_log_debug("Found uncompressed compression block.\n"); /* * Read the uncompressed data into the destination buffer. * NOTE: We cheat a little bit here by marking the attribute as * not compressed in the ntfs_attr structure so that we can * read the data by simply using ntfs_attr_pread(). (-8 * NOTE: we have to modify data_size and initialized_size * temporarily as well... */ to_read = min(count, cb_size - ofs); ofs += vcn << vol->cluster_size_bits; NAttrClearCompressed(na); na->data_flags &= ~ATTR_COMPRESSION_MASK; tdata_size = na->data_size; tinitialized_size = na->initialized_size; na->data_size = na->initialized_size = na->allocated_size; do { br = ntfs_attr_pread(na, ofs, to_read, b); if (br <= 0) { if (!br) { ntfs_log_error("Failed to read an" " uncompressed cluster," " inode %lld offs 0x%llx\n", (long long)na->ni->mft_no, (long long)ofs); errno = EIO; } err = errno; na->data_size = tdata_size; na->initialized_size = tinitialized_size; na->ni->flags |= compression; na->data_flags = data_flags; free(cb); free(dest); if (total) return total; errno = err; return br; } total += br; count -= br; b = (u8*)b + br; to_read -= br; ofs += br; } while (to_read > 0); na->data_size = tdata_size; na->initialized_size = tinitialized_size; na->ni->flags |= compression; na->data_flags = data_flags; ofs = 0; } else { s64 tdata_size, tinitialized_size; u32 decompsz; /* * Compressed cb, decompress it into the temporary buffer, then * copy the data to the destination range overlapping the cb. */ ntfs_log_debug("Found compressed compression block.\n"); /* * Read the compressed data into the temporary buffer. * NOTE: We cheat a little bit here by marking the attribute as * not compressed in the ntfs_attr structure so that we can * read the raw, compressed data by simply using * ntfs_attr_pread(). (-8 * NOTE: We have to modify data_size and initialized_size * temporarily as well... */ to_read = cb_size; NAttrClearCompressed(na); na->data_flags &= ~ATTR_COMPRESSION_MASK; tdata_size = na->data_size; tinitialized_size = na->initialized_size; na->data_size = na->initialized_size = na->allocated_size; do { br = ntfs_attr_pread(na, (vcn << vol->cluster_size_bits) + (cb_pos - cb), to_read, cb_pos); if (br <= 0) { if (!br) { ntfs_log_error("Failed to read a" " compressed cluster, " " inode %lld offs 0x%llx\n", (long long)na->ni->mft_no, (long long)(vcn << vol->cluster_size_bits)); errno = EIO; } err = errno; na->data_size = tdata_size; na->initialized_size = tinitialized_size; na->ni->flags |= compression; na->data_flags = data_flags; free(cb); free(dest); if (total) return total; errno = err; return br; } cb_pos += br; to_read -= br; } while (to_read > 0); na->data_size = tdata_size; na->initialized_size = tinitialized_size; na->ni->flags |= compression; na->data_flags = data_flags; /* Just a precaution. */ if (cb_pos + 2 <= cb_end) *(u16*)cb_pos = 0; ntfs_log_debug("Successfully read the compression block.\n"); /* Do not decompress beyond the requested block */ to_read = min(count, cb_size - ofs); decompsz = ((ofs + to_read - 1) | (NTFS_SB_SIZE - 1)) + 1; if (ntfs_decompress(dest, decompsz, cb, cb_size) < 0) { err = errno; free(cb); free(dest); if (total) return total; errno = err; return -1; } memcpy(b, dest + ofs, to_read); total += to_read; count -= to_read; b = (u8*)b + to_read; ofs = 0; } /* Do we have more work to do? */ if (nr_cbs) goto do_next_cb; /* We no longer need the buffers. */ free(cb); free(dest); /* Return number of bytes read. */ return total + total2; } /* * Read data from a set of clusters * * Returns the amount of data read */ static u32 read_clusters(ntfs_volume *vol, const runlist_element *rl, s64 offs, u32 to_read, char *inbuf) { u32 count; int xgot; u32 got; s64 xpos; BOOL first; char *xinbuf; const runlist_element *xrl; got = 0; xrl = rl; xinbuf = inbuf; first = TRUE; do { count = xrl->length << vol->cluster_size_bits; xpos = xrl->lcn << vol->cluster_size_bits; if (first) { count -= offs; xpos += offs; } if ((to_read - got) < count) count = to_read - got; xgot = ntfs_pread(vol->dev, xpos, count, xinbuf); if (xgot == (int)count) { got += count; xpos += count; xinbuf += count; xrl++; } first = FALSE; } while ((xgot == (int)count) && (got < to_read)); return (got); } /* * Write data to a set of clusters * * Returns the amount of data written */ static s32 write_clusters(ntfs_volume *vol, const runlist_element *rl, s64 offs, s32 to_write, const char *outbuf) { s32 count; s32 put, xput; s64 xpos; BOOL first; const char *xoutbuf; const runlist_element *xrl; put = 0; xrl = rl; xoutbuf = outbuf; first = TRUE; do { count = xrl->length << vol->cluster_size_bits; xpos = xrl->lcn << vol->cluster_size_bits; if (first) { count -= offs; xpos += offs; } if ((to_write - put) < count) count = to_write - put; xput = ntfs_pwrite(vol->dev, xpos, count, xoutbuf); if (xput == count) { put += count; xpos += count; xoutbuf += count; xrl++; } first = FALSE; } while ((xput == count) && (put < to_write)); return (put); } /* * Compress and write a set of blocks * * returns the size actually written (rounded to a full cluster) * or 0 if all zeroes (nothing is written) * or -1 if could not compress (nothing is written) * or -2 if there were an irrecoverable error (errno set) */ static s32 ntfs_comp_set(ntfs_attr *na, runlist_element *rl, s64 offs, u32 insz, const char *inbuf) { ntfs_volume *vol; char *outbuf; char *pbuf; u32 compsz; s32 written; s32 rounded; unsigned int clsz; u32 p; unsigned int sz; unsigned int bsz; BOOL fail; BOOL allzeroes; /* a single compressed zero */ static char onezero[] = { 0x01, 0xb0, 0x00, 0x00 } ; /* a couple of compressed zeroes */ static char twozeroes[] = { 0x02, 0xb0, 0x00, 0x00, 0x00 } ; /* more compressed zeroes, to be followed by some count */ static char morezeroes[] = { 0x03, 0xb0, 0x02, 0x00 } ; vol = na->ni->vol; written = -1; /* default return */ clsz = 1 << vol->cluster_size_bits; /* may need 2 extra bytes per block and 2 more bytes */ outbuf = (char*)ntfs_malloc(na->compression_block_size + 2*(na->compression_block_size/NTFS_SB_SIZE) + 2); if (outbuf) { fail = FALSE; compsz = 0; allzeroes = TRUE; for (p=0; (p na->compression_block_size)) fail = TRUE; else { if (allzeroes) { /* check whether this is all zeroes */ switch (sz) { case 4 : allzeroes = !memcmp( pbuf,onezero,4); break; case 5 : allzeroes = !memcmp( pbuf,twozeroes,5); break; case 6 : allzeroes = !memcmp( pbuf,morezeroes,4); break; default : allzeroes = FALSE; break; } } compsz += sz; } } if (!fail && !allzeroes) { /* add a couple of null bytes, space has been checked */ outbuf[compsz++] = 0; outbuf[compsz++] = 0; /* write a full cluster, to avoid partial reading */ rounded = ((compsz - 1) | (clsz - 1)) + 1; memset(&outbuf[compsz], 0, rounded - compsz); written = write_clusters(vol, rl, offs, rounded, outbuf); if (written != rounded) { /* * TODO : previously written text has been * spoilt, should return a specific error */ ntfs_log_error("error writing compressed data\n"); errno = EIO; written = -2; } } else if (!fail) written = 0; free(outbuf); } return (written); } /* * Check the validity of a compressed runlist * The check starts at the beginning of current run and ends * at the end of runlist * errno is set if the runlist is not valid */ static BOOL valid_compressed_run(ntfs_attr *na, runlist_element *rl, BOOL fullcheck, const char *text) { runlist_element *xrl; const char *err; BOOL ok = TRUE; xrl = rl; while (xrl->vcn & (na->compression_block_clusters - 1)) xrl--; err = (const char*)NULL; while (xrl->length) { if ((xrl->vcn + xrl->length) != xrl[1].vcn) err = "Runs not adjacent"; if (xrl->lcn == LCN_HOLE) { if ((xrl->vcn + xrl->length) & (na->compression_block_clusters - 1)) { err = "Invalid hole"; } if (fullcheck && (xrl[1].lcn == LCN_HOLE)) { err = "Adjacent holes"; } } if (err) { ntfs_log_error("%s at %s index %ld inode %lld\n", err, text, (long)(xrl - na->rl), (long long)na->ni->mft_no); errno = EIO; ok = FALSE; err = (const char*)NULL; } xrl++; } return (ok); } /* * Free unneeded clusters after overwriting compressed data * * This generally requires one or two empty slots at the end of runlist, * but we do not want to reallocate the runlist here because * there are many pointers to it. * So the empty slots have to be reserved beforehand * * Returns zero unless some error occurred (described by errno) * * +======= start of block =====+ * 0 |A chunk may overflow | <-- rl usedcnt : A + B * |A on previous block | then B * |A | * +-- end of allocated chunk --+ freelength : C * |B | (incl overflow) * +== end of compressed data ==+ * |C | <-- freerl freecnt : C + D * |C chunk may overflow | * |C on next block | * +-- end of allocated chunk --+ * |D | * |D chunk may overflow | * 15 |D on next block | * +======== end of block ======+ * */ static int ntfs_compress_overwr_free(ntfs_attr *na, runlist_element *rl, s32 usedcnt, s32 freecnt, VCN *update_from) { BOOL beginhole; BOOL mergeholes; s32 oldlength; s32 freelength; s64 freelcn; s64 freevcn; runlist_element *freerl; ntfs_volume *vol; s32 carry; int res; vol = na->ni->vol; res = 0; freelcn = rl->lcn + usedcnt; freevcn = rl->vcn + usedcnt; freelength = rl->length - usedcnt; beginhole = !usedcnt && !rl->vcn; /* can merge with hole before ? */ mergeholes = !usedcnt && rl[0].vcn && (rl[-1].lcn == LCN_HOLE); /* truncate current run, carry to subsequent hole */ carry = freelength; oldlength = rl->length; if (mergeholes) { /* merging with a hole before */ freerl = rl; } else { rl->length -= freelength; /* warning : can be zero */ freerl = ++rl; } if (!mergeholes && (usedcnt || beginhole)) { s32 freed; runlist_element *frl; runlist_element *erl; int holes = 0; BOOL threeparts; /* free the unneeded clusters from initial run, then freerl */ threeparts = (freelength > freecnt); freed = 0; frl = freerl; if (freelength) { res = ntfs_cluster_free_basic(vol,freelcn, (threeparts ? freecnt : freelength)); if (!res) freed += (threeparts ? freecnt : freelength); if (!usedcnt) { holes++; freerl--; freerl->length += (threeparts ? freecnt : freelength); if (freerl->vcn < *update_from) *update_from = freerl->vcn; } } while (!res && frl->length && (freed < freecnt)) { if (frl->length <= (freecnt - freed)) { res = ntfs_cluster_free_basic(vol, frl->lcn, frl->length); if (!res) { freed += frl->length; frl->lcn = LCN_HOLE; frl->length += carry; carry = 0; holes++; } } else { res = ntfs_cluster_free_basic(vol, frl->lcn, freecnt - freed); if (!res) { frl->lcn += freecnt - freed; frl->vcn += freecnt - freed; frl->length -= freecnt - freed; freed = freecnt; } } frl++; } na->compressed_size -= freed << vol->cluster_size_bits; switch (holes) { case 0 : /* there are no hole, must insert one */ /* space for hole has been prereserved */ if (freerl->lcn == LCN_HOLE) { if (threeparts) { erl = freerl; while (erl->length) erl++; do { erl[2] = *erl; } while (erl-- != freerl); freerl[1].length = freelength - freecnt; freerl->length = freecnt; freerl[1].lcn = freelcn + freecnt; freerl[1].vcn = freevcn + freecnt; freerl[2].lcn = LCN_HOLE; freerl[2].vcn = freerl[1].vcn + freerl[1].length; freerl->vcn = freevcn; } else { freerl->vcn = freevcn; freerl->length += freelength; } } else { erl = freerl; while (erl->length) erl++; if (threeparts) { do { erl[2] = *erl; } while (erl-- != freerl); freerl[1].lcn = freelcn + freecnt; freerl[1].vcn = freevcn + freecnt; freerl[1].length = oldlength - usedcnt - freecnt; } else { do { erl[1] = *erl; } while (erl-- != freerl); } freerl->lcn = LCN_HOLE; freerl->vcn = freevcn; freerl->length = freecnt; } break; case 1 : /* there is a single hole, may have to merge */ freerl->vcn = freevcn; freerl->length = freecnt; if (freerl[1].lcn == LCN_HOLE) { freerl->length += freerl[1].length; erl = freerl; do { erl++; *erl = erl[1]; } while (erl->length); } break; default : /* there were several holes, must merge them */ freerl->lcn = LCN_HOLE; freerl->vcn = freevcn; freerl->length = freecnt; if (freerl[holes].lcn == LCN_HOLE) { freerl->length += freerl[holes].length; holes++; } erl = freerl; do { erl++; *erl = erl[holes - 1]; } while (erl->length); break; } } else { s32 freed; runlist_element *frl; runlist_element *xrl; freed = 0; frl = freerl--; if (freerl->vcn < *update_from) *update_from = freerl->vcn; while (!res && frl->length && (freed < freecnt)) { if (frl->length <= (freecnt - freed)) { freerl->length += frl->length; freed += frl->length; res = ntfs_cluster_free_basic(vol, frl->lcn, frl->length); frl++; } else { freerl->length += freecnt - freed; res = ntfs_cluster_free_basic(vol, frl->lcn, freecnt - freed); frl->lcn += freecnt - freed; frl->vcn += freecnt - freed; frl->length -= freecnt - freed; freed = freecnt; } } /* remove unneded runlist entries */ xrl = freerl; /* group with next run if also a hole */ if (frl->length && (frl->lcn == LCN_HOLE)) { xrl->length += frl->length; frl++; } while (frl->length) { *++xrl = *frl++; } *++xrl = *frl; /* terminator */ na->compressed_size -= freed << vol->cluster_size_bits; } return (res); } /* * Free unneeded clusters after compression * * This generally requires one or two empty slots at the end of runlist, * but we do not want to reallocate the runlist here because * there are many pointers to it. * So the empty slots have to be reserved beforehand * * Returns zero unless some error occurred (described by errno) */ static int ntfs_compress_free(ntfs_attr *na, runlist_element *rl, s64 used, s64 reserved, BOOL appending, VCN *update_from) { s32 freecnt; s32 usedcnt; int res; s64 freelcn; s64 freevcn; s32 freelength; BOOL mergeholes; BOOL beginhole; ntfs_volume *vol; runlist_element *freerl; res = -1; /* default return */ vol = na->ni->vol; freecnt = (reserved - used) >> vol->cluster_size_bits; usedcnt = (reserved >> vol->cluster_size_bits) - freecnt; if (rl->vcn < *update_from) *update_from = rl->vcn; /* skip entries fully used, if any */ while (rl->length && (rl->length < usedcnt)) { usedcnt -= rl->length; /* must be > 0 */ rl++; } if (rl->length) { /* * Splitting the current allocation block requires * an extra runlist element to create the hole. * The required entry has been prereserved when * mapping the runlist. */ /* get the free part in initial run */ freelcn = rl->lcn + usedcnt; freevcn = rl->vcn + usedcnt; /* new count of allocated clusters */ if (!((freevcn + freecnt) & (na->compression_block_clusters - 1))) { if (!appending) res = ntfs_compress_overwr_free(na,rl, usedcnt,freecnt,update_from); else { freelength = rl->length - usedcnt; beginhole = !usedcnt && !rl->vcn; mergeholes = !usedcnt && rl[0].vcn && (rl[-1].lcn == LCN_HOLE); if (mergeholes) { s32 carry; /* shorten the runs which have free space */ carry = freecnt; freerl = rl; while (freerl->length < carry) { carry -= freerl->length; freerl++; } freerl->length = carry; freerl = rl; } else { rl->length = usedcnt; /* can be zero ? */ freerl = ++rl; } if ((freelength > 0) && !mergeholes && (usedcnt || beginhole)) { /* * move the unused part to the end. Doing so, * the vcn will be out of order. This does * not harm, the vcn are meaningless now, and * only the lcn are meaningful for freeing. */ /* locate current end */ while (rl->length) rl++; /* new terminator relocated */ rl[1].vcn = rl->vcn; rl[1].lcn = LCN_ENOENT; rl[1].length = 0; /* hole, currently allocated */ rl->vcn = freevcn; rl->lcn = freelcn; rl->length = freelength; } else { /* why is this different from the begin hole case ? */ if ((freelength > 0) && !mergeholes && !usedcnt) { freerl--; freerl->length = freelength; if (freerl->vcn < *update_from) *update_from = freerl->vcn; } } /* free the hole */ res = ntfs_cluster_free_from_rl(vol,freerl); if (!res) { na->compressed_size -= freecnt << vol->cluster_size_bits; if (mergeholes) { /* merge with adjacent hole */ freerl--; freerl->length += freecnt; } else { if (beginhole) freerl--; /* mark hole as free */ freerl->lcn = LCN_HOLE; freerl->vcn = freevcn; freerl->length = freecnt; } if (freerl->vcn < *update_from) *update_from = freerl->vcn; /* and set up the new end */ freerl[1].lcn = LCN_ENOENT; freerl[1].vcn = freevcn + freecnt; freerl[1].length = 0; } } } else { ntfs_log_error("Bad end of a compression block set\n"); errno = EIO; } } else { ntfs_log_error("No cluster to free after compression\n"); errno = EIO; } NAttrSetRunlistDirty(na); return (res); } /* * Read existing data, decompress and append buffer * Do nothing if something fails */ static int ntfs_read_append(ntfs_attr *na, const runlist_element *rl, s64 offs, u32 compsz, s32 pos, BOOL appending, char *outbuf, s64 to_write, const void *b) { int fail = 1; char *compbuf; u32 decompsz; u32 got; if (compsz == na->compression_block_size) { /* if the full block was requested, it was a hole */ memset(outbuf,0,compsz); memcpy(&outbuf[pos],b,to_write); fail = 0; } else { compbuf = (char*)ntfs_malloc(compsz); if (compbuf) { /* must align to full block for decompression */ if (appending) decompsz = ((pos - 1) | (NTFS_SB_SIZE - 1)) + 1; else decompsz = na->compression_block_size; got = read_clusters(na->ni->vol, rl, offs, compsz, compbuf); if ((got == compsz) && !ntfs_decompress((u8*)outbuf,decompsz, (u8*)compbuf,compsz)) { memcpy(&outbuf[pos],b,to_write); fail = 0; } free(compbuf); } } return (fail); } /* * Flush a full compression block * * returns the size actually written (rounded to a full cluster) * or 0 if could not compress (and written uncompressed) * or -1 if there were an irrecoverable error (errno set) */ static s32 ntfs_flush(ntfs_attr *na, runlist_element *rl, s64 offs, char *outbuf, s32 count, BOOL compress, BOOL appending, VCN *update_from) { s32 rounded; s32 written; int clsz; if (compress) { written = ntfs_comp_set(na, rl, offs, count, outbuf); if (written == -1) compress = FALSE; if ((written >= 0) && ntfs_compress_free(na,rl,offs + written, offs + na->compression_block_size, appending, update_from)) written = -1; } else written = 0; if (!compress) { clsz = 1 << na->ni->vol->cluster_size_bits; rounded = ((count - 1) | (clsz - 1)) + 1; if (rounded > count) memset(&outbuf[count], 0, rounded - count); written = write_clusters(na->ni->vol, rl, offs, rounded, outbuf); if (written != rounded) written = -1; } return (written); } /* * Write some data to be compressed. * Compression only occurs when a few clusters (usually 16) are * full. When this occurs an extra runlist slot may be needed, so * it has to be reserved beforehand. * * Returns the size of uncompressed data written, * or negative if an error occurred. * When the returned size is less than requested, new clusters have * to be allocated before the function is called again. */ s64 ntfs_compressed_pwrite(ntfs_attr *na, runlist_element *wrl, s64 wpos, s64 offs, s64 to_write, s64 rounded, const void *b, int compressed_part, VCN *update_from) { ntfs_volume *vol; runlist_element *brl; /* entry containing the beginning of block */ int compression_length; s64 written; s64 to_read; s64 to_flush; s64 roffs; s64 got; s64 start_vcn; s64 nextblock; s64 endwrite; u32 compsz; char *inbuf; char *outbuf; BOOL fail; BOOL done; BOOL compress; BOOL appending; if (!valid_compressed_run(na,wrl,FALSE,"begin compressed write")) { return (-1); } if ((*update_from < 0) || (compressed_part < 0) || (compressed_part > (int)na->compression_block_clusters)) { ntfs_log_error("Bad update vcn or compressed_part %d for compressed write\n", compressed_part); errno = EIO; return (-1); } /* make sure there are two unused entries in runlist */ if (na->unused_runs < 2) { ntfs_log_error("No unused runs for compressed write\n"); errno = EIO; return (-1); } if (na->compression_block_size < NTFS_SB_SIZE) { ntfs_log_error("Unsupported compression block size %ld\n", (long)na->compression_block_size); errno = EOVERFLOW; return (-1); } if (wrl->vcn < *update_from) *update_from = wrl->vcn; written = -1; /* default return */ vol = na->ni->vol; compression_length = na->compression_block_clusters; compress = FALSE; done = FALSE; /* * Cannot accept writing beyond the current compression set * because when compression occurs, clusters are freed * and have to be reallocated. * (cannot happen with standard fuse 4K buffers) * Caller has to avoid this situation, or face consequences. */ nextblock = ((offs + (wrl->vcn << vol->cluster_size_bits)) | (na->compression_block_size - 1)) + 1; /* determine whether we are appending to file */ endwrite = offs + to_write + (wrl->vcn << vol->cluster_size_bits); appending = endwrite >= na->initialized_size; if (endwrite >= nextblock) { /* it is time to compress */ compress = TRUE; /* only process what we can */ to_write = rounded = nextblock - (offs + (wrl->vcn << vol->cluster_size_bits)); } start_vcn = 0; fail = FALSE; brl = wrl; roffs = 0; /* * If we are about to compress or we need to decompress * existing data, we have to process a full set of blocks. * So relocate the parameters to the beginning of allocation * containing the first byte of the set of blocks. */ if (compress || compressed_part) { /* find the beginning of block */ start_vcn = (wrl->vcn + (offs >> vol->cluster_size_bits)) & -compression_length; if (start_vcn < *update_from) *update_from = start_vcn; while (brl->vcn && (brl->vcn > start_vcn)) { /* jumping back a hole means big trouble */ if (brl->lcn == (LCN)LCN_HOLE) { ntfs_log_error("jump back over a hole when appending\n"); fail = TRUE; errno = EIO; } brl--; offs += brl->length << vol->cluster_size_bits; } roffs = (start_vcn - brl->vcn) << vol->cluster_size_bits; } if (compressed_part && !fail) { /* * The set of compression blocks contains compressed data * (we are reopening an existing file to append to it) * Decompress the data and append */ compsz = (s32)compressed_part << vol->cluster_size_bits; outbuf = (char*)ntfs_malloc(na->compression_block_size); if (outbuf) { if (appending) { to_read = offs - roffs; to_flush = to_read + to_write; } else { to_read = na->data_size - (brl->vcn << vol->cluster_size_bits); if (to_read > na->compression_block_size) to_read = na->compression_block_size; to_flush = to_read; } if (!ntfs_read_append(na, brl, roffs, compsz, (s32)(offs - roffs), appending, outbuf, to_write, b)) { written = ntfs_flush(na, brl, roffs, outbuf, to_flush, compress, appending, update_from); if (written >= 0) { written = to_write; done = TRUE; } } free(outbuf); } } else { if (compress && !fail) { /* * we are filling up a block, read the full set * of blocks and compress it */ inbuf = (char*)ntfs_malloc(na->compression_block_size); if (inbuf) { to_read = offs - roffs; if (to_read) got = read_clusters(vol, brl, roffs, to_read, inbuf); else got = 0; if (got == to_read) { memcpy(&inbuf[to_read],b,to_write); written = ntfs_comp_set(na, brl, roffs, to_read + to_write, inbuf); /* * if compression was not successful, * only write the part which was requested */ if ((written >= 0) /* free the unused clusters */ && !ntfs_compress_free(na,brl, written + roffs, na->compression_block_size + roffs, appending, update_from)) { done = TRUE; written = to_write; } } free(inbuf); } } if (!done) { /* * if the compression block is not full, or * if compression failed for whatever reason, * write uncompressed */ /* check we are not overflowing current allocation */ if ((wpos + rounded) > ((wrl->lcn + wrl->length) << vol->cluster_size_bits)) { ntfs_log_error("writing on unallocated clusters\n"); errno = EIO; } else { written = ntfs_pwrite(vol->dev, wpos, rounded, b); if (written == rounded) written = to_write; } } } if ((written >= 0) && !valid_compressed_run(na,wrl,TRUE,"end compressed write")) written = -1; return (written); } /* * Close a file written compressed. * This compresses the last partial compression block of the file. * Two empty runlist slots have to be reserved beforehand. * * Returns zero if closing is successful. */ int ntfs_compressed_close(ntfs_attr *na, runlist_element *wrl, s64 offs, VCN *update_from) { ntfs_volume *vol; runlist_element *brl; /* entry containing the beginning of block */ int compression_length; s64 written; s64 to_read; s64 roffs; s64 got; s64 start_vcn; char *inbuf; BOOL fail; BOOL done; if (na->unused_runs < 2) { ntfs_log_error("No unused runs for compressed close\n"); errno = EIO; return (-1); } if (*update_from < 0) { ntfs_log_error("Bad update vcn for compressed close\n"); errno = EIO; return (-1); } if (na->compression_block_size < NTFS_SB_SIZE) { ntfs_log_error("Unsupported compression block size %ld\n", (long)na->compression_block_size); errno = EOVERFLOW; return (-1); } if (wrl->vcn < *update_from) *update_from = wrl->vcn; vol = na->ni->vol; compression_length = na->compression_block_clusters; done = FALSE; /* * There generally is an uncompressed block at end of file, * read the full block and compress it */ inbuf = (char*)ntfs_malloc(na->compression_block_size); if (inbuf) { start_vcn = (wrl->vcn + (offs >> vol->cluster_size_bits)) & -compression_length; if (start_vcn < *update_from) *update_from = start_vcn; to_read = offs + ((wrl->vcn - start_vcn) << vol->cluster_size_bits); brl = wrl; fail = FALSE; while (brl->vcn && (brl->vcn > start_vcn)) { if (brl->lcn == (LCN)LCN_HOLE) { ntfs_log_error("jump back over a hole when closing\n"); fail = TRUE; errno = EIO; } brl--; } if (!fail) { /* roffs can be an offset from another uncomp block */ roffs = (start_vcn - brl->vcn) << vol->cluster_size_bits; if (to_read) { got = read_clusters(vol, brl, roffs, to_read, inbuf); if (got == to_read) { written = ntfs_comp_set(na, brl, roffs, to_read, inbuf); if ((written >= 0) /* free the unused clusters */ && !ntfs_compress_free(na,brl, written + roffs, na->compression_block_size + roffs, TRUE, update_from)) { done = TRUE; } else /* if compression failed, leave uncompressed */ if (written == -1) done = TRUE; } } else done = TRUE; } } if (done && !valid_compressed_run(na,wrl,TRUE,"end compressed close")) done = FALSE; if (inbuf) free(inbuf); return (!done); } ntfsprogs-plus-1.0.0/libntfs/debug.c000066400000000000000000000043161507404161300174160ustar00rootroot00000000000000/** * debug.c - Debugging output functions. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2004 Anton Altaparmakov * Copyright (c) 2004-2006 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_ERRNO_H #include #endif #include "types.h" #include "runlist.h" #include "debug.h" #include "logging.h" #ifdef DEBUG /** * ntfs_debug_runlist_dump - Dump a runlist. * @rl: * * Description... * * Returns: */ void ntfs_debug_runlist_dump(const runlist_element *rl) { int i = 0; const char *lcn_str[5] = { "LCN_HOLE ", "LCN_RL_NOT_MAPPED", "LCN_ENOENT ", "LCN_EINVAL ", "LCN_unknown " }; ntfs_log_debug("NTFS-fs DEBUG: Dumping runlist (values in hex):\n"); if (!rl) { ntfs_log_debug("Run list not present.\n"); return; } ntfs_log_debug("VCN LCN Run length\n"); do { LCN lcn = (rl + i)->lcn; if (lcn < (LCN)0) { int idx = -lcn - 1; if (idx > -LCN_EINVAL - 1) idx = 4; ntfs_log_debug("%-16lld %s %-16lld%s\n", (long long)rl[i].vcn, lcn_str[idx], (long long)rl[i].length, rl[i].length ? "" : " (runlist end)"); } else ntfs_log_debug("%-16lld %-16lld %-16lld%s\n", (long long)rl[i].vcn, (long long)rl[i].lcn, (long long)rl[i].length, rl[i].length ? "" : " (runlist end)"); } while (rl[i++].length); } #endif ntfsprogs-plus-1.0.0/libntfs/device.c000066400000000000000000000617461507404161300176010ustar00rootroot00000000000000/** * device.c - Low level device io functions. Originated from the Linux-NTFS project. * * Copyright (c) 2004-2013 Anton Altaparmakov * Copyright (c) 2004-2006 Szabolcs Szakacsits * Copyright (c) 2010 Jean-Pierre Andre * Copyright (c) 2008-2013 Tuxera Inc. * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_SYS_IOCTL_H #include #endif #ifdef HAVE_SYS_PARAM_H #include #endif #ifdef HAVE_SYS_MOUNT_H #include #endif #ifdef HAVE_SYS_DISK_H #include #endif #ifdef HAVE_LINUX_FD_H #include #endif #ifdef HAVE_LINUX_HDREG_H #include #endif #ifdef ENABLE_HD #include #endif #include "types.h" #include "mst.h" #include "debug.h" #include "device.h" #include "logging.h" #include "misc.h" #if defined(linux) && defined(_IO) && !defined(BLKGETSIZE) #define BLKGETSIZE _IO(0x12,96) /* Get device size in 512-byte blocks. */ #endif #if defined(linux) && defined(_IOR) && !defined(BLKGETSIZE64) #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* Get device size in bytes. */ #endif #if defined(linux) && !defined(HDIO_GETGEO) #define HDIO_GETGEO 0x0301 /* Get device geometry. */ #endif #if defined(linux) && defined(_IO) && !defined(BLKSSZGET) # define BLKSSZGET _IO(0x12,104) /* Get device sector size in bytes. */ #endif #if defined(linux) && defined(_IO) && !defined(BLKBSZSET) # define BLKBSZSET _IOW(0x12,113,size_t) /* Set device block size in bytes. */ #endif /** * ntfs_device_alloc - allocate an ntfs device structure and pre-initialize it * @name: name of the device (must be present) * @state: initial device state (usually zero) * @dops: ntfs device operations to use with the device (must be present) * @priv_data: pointer to private data (optional) * * Allocate an ntfs device structure and pre-initialize it with the user- * specified device operations @dops, device state @state, device name @name, * and optional private data @priv_data. * * Note, @name is copied and can hence be freed after this functions returns. * * On success return a pointer to the allocated ntfs device structure and on * error return NULL with errno set to the error code returned by ntfs_malloc(). */ struct ntfs_device *ntfs_device_alloc(const char *name, const long state, struct ntfs_device_operations *dops, void *priv_data) { struct ntfs_device *dev; if (!name) { errno = EINVAL; return NULL; } dev = ntfs_malloc(sizeof(struct ntfs_device)); if (dev) { if (!(dev->d_name = strdup(name))) { int eo = errno; free(dev); errno = eo; return NULL; } dev->d_ops = dops; dev->d_state = state; dev->d_private = priv_data; dev->d_heads = -1; dev->d_sectors_per_track = -1; } return dev; } /** * ntfs_device_free - free an ntfs device structure * @dev: ntfs device structure to free * * Free the ntfs device structure @dev. * * Return 0 on success or -1 on error with errno set to the error code. The * following error codes are defined: * EINVAL Invalid pointer @dev. * EBUSY Device is still open. Close it before freeing it! */ int ntfs_device_free(struct ntfs_device *dev) { if (!dev) { errno = EINVAL; return -1; } if (NDevOpen(dev)) { errno = EBUSY; return -1; } free(dev->d_name); free(dev); return 0; } /* * Sync the device * * returns zero if successful. */ int ntfs_device_sync(struct ntfs_device *dev) { int ret; struct ntfs_device_operations *dops; if (NDevDirty(dev)) { dops = dev->d_ops; ret = dops->sync(dev); } else ret = 0; return ret; } /** * ntfs_pread - positioned read from disk * @dev: device to read from * @pos: position in device to read from * @count: number of bytes to read * @b: output data buffer * * This function will read @count bytes from device @dev at position @pos into * the data buffer @b. * * On success, return the number of successfully read bytes. If this number is * lower than @count this means that we have either reached end of file or * encountered an error during the read so that the read is partial. 0 means * end of file or nothing to read (@count is 0). * * On error and nothing has been read, return -1 with errno set appropriately * to the return code of either seek, read, or set to EINVAL in case of * invalid arguments. */ s64 ntfs_pread(struct ntfs_device *dev, const s64 pos, s64 count, void *b) { s64 br, total; struct ntfs_device_operations *dops; ntfs_log_trace("pos %lld, count %lld\n",(long long)pos,(long long)count); if (!b || count < 0 || pos < 0) { errno = EINVAL; return -1; } if (!count) return 0; dops = dev->d_ops; for (total = 0; count; count -= br, total += br) { br = dops->pread(dev, (char*)b + total, count, pos + total); /* If everything ok, continue. */ if (br > 0) continue; /* If EOF or error return number of bytes read. */ if (!br || total) return total; /* Nothing read and error, return error status. */ return br; } /* Finally, return the number of bytes read. */ return total; } /** * ntfs_pwrite - positioned write to disk * @dev: device to write to * @pos: position in file descriptor to write to * @count: number of bytes to write * @b: data buffer to write to disk * * This function will write @count bytes from data buffer @b to the device @dev * at position @pos. * * On success, return the number of successfully written bytes. If this number * is lower than @count this means that the write has been interrupted in * flight or that an error was encountered during the write so that the write * is partial. 0 means nothing was written (also return 0 when @count is 0). * * On error and nothing has been written, return -1 with errno set * appropriately to the return code of either seek, write, or set * to EINVAL in case of invalid arguments. */ s64 ntfs_pwrite(struct ntfs_device *dev, const s64 pos, s64 count, const void *b) { s64 written, total, ret = -1; struct ntfs_device_operations *dops; ntfs_log_trace("pos %lld, count %lld\n",(long long)pos,(long long)count); if (!b || count < 0 || pos < 0) { errno = EINVAL; goto out; } if (!count) return 0; if (NDevReadOnly(dev)) { errno = EROFS; goto out; } dops = dev->d_ops; NDevSetDirty(dev); for (total = 0; count; count -= written, total += written) { written = dops->pwrite(dev, (const char*)b + total, count, pos + total); /* If everything ok, continue. */ if (written > 0) continue; /* * If nothing written or error return number of bytes written. */ if (!written || total) break; /* Nothing written and error, return error status. */ total = written; break; } if (NDevSync(dev) && total && dops->sync(dev)) { total--; /* on sync error, return partially written */ } ret = total; out: return ret; } /** * ntfs_mst_pread - multi sector transfer (mst) positioned read * @dev: device to read from * @pos: position in file descriptor to read from * @count: number of blocks to read * @bksize: size of each block that needs mst deprotecting * @b: output data buffer * * Multi sector transfer (mst) positioned read. This function will read @count * blocks of size @bksize bytes each from device @dev at position @pos into the * the data buffer @b. * * On success, return the number of successfully read blocks. If this number is * lower than @count this means that we have reached end of file, that the read * was interrupted, or that an error was encountered during the read so that * the read is partial. 0 means end of file or nothing was read (also return 0 * when @count or @bksize are 0). * * On error and nothing was read, return -1 with errno set appropriately to the * return code of either seek, read, or set to EINVAL in case of invalid * arguments. * * NOTE: If an incomplete multi sector transfer has been detected the magic * will have been changed to magic_BAAD but no error will be returned. Thus it * is possible that we return count blocks as being read but that any number * (between zero and count!) of these blocks is actually subject to a multi * sector transfer error. This should be detected by the caller by checking for * the magic being "BAAD". */ s64 ntfs_mst_pread(struct ntfs_device *dev, const s64 pos, s64 count, const u32 bksize, void *b) { s64 br, i; if (bksize & (bksize - 1) || bksize % NTFS_BLOCK_SIZE) { errno = EINVAL; return -1; } /* Do the read. */ br = ntfs_pread(dev, pos, count * bksize, b); if (br < 0) return br; /* * Apply fixups to successfully read data, disregarding any errors * returned from the MST fixup function. This is because we want to * fixup everything possible and we rely on the fact that the "BAAD" * magic will be detected later on. */ count = br / bksize; for (i = 0; i < count; ++i) ntfs_mst_post_read_fixup((NTFS_RECORD*) ((u8*)b + i * bksize), bksize); /* Finally, return the number of complete blocks read. */ return count; } /** * ntfs_mst_pwrite - multi sector transfer (mst) positioned write * @dev: device to write to * @pos: position in file descriptor to write to * @count: number of blocks to write * @bksize: size of each block that needs mst protecting * @b: data buffer to write to disk * * Multi sector transfer (mst) positioned write. This function will write * @count blocks of size @bksize bytes each from data buffer @b to the device * @dev at position @pos. * * On success, return the number of successfully written blocks. If this number * is lower than @count this means that the write has been interrupted or that * an error was encountered during the write so that the write is partial. 0 * means nothing was written (also return 0 when @count or @bksize are 0). * * On error and nothing has been written, return -1 with errno set * appropriately to the return code of either seek, write, or set * to EINVAL in case of invalid arguments. * * NOTE: We mst protect the data, write it, then mst deprotect it using a quick * deprotect algorithm (no checking). This saves us from making a copy before * the write and at the same time causes the usn to be incremented in the * buffer. This conceptually fits in better with the idea that cached data is * always deprotected and protection is performed when the data is actually * going to hit the disk and the cache is immediately deprotected again * simulating an mst read on the written data. This way cache coherency is * achieved. */ s64 ntfs_mst_pwrite(struct ntfs_device *dev, const s64 pos, s64 count, const u32 bksize, void *b) { s64 written, i; if (count < 0 || bksize % NTFS_BLOCK_SIZE) { errno = EINVAL; return -1; } if (!count) return 0; /* Prepare data for writing. */ for (i = 0; i < count; ++i) { int err; err = ntfs_mst_pre_write_fixup((NTFS_RECORD*) ((u8*)b + i * bksize), bksize); if (err < 0) { /* Abort write at this position. */ if (!i) return err; count = i; break; } } /* Write the prepared data. */ written = ntfs_pwrite(dev, pos, count * bksize, b); /* Quickly deprotect the data again. */ for (i = 0; i < count; ++i) ntfs_mst_post_write_fixup((NTFS_RECORD*)((u8*)b + i * bksize)); if (written <= 0) return written; /* Finally, return the number of complete blocks written. */ return written / bksize; } /** * ntfs_cluster_read - read ntfs clusters * @vol: volume to read from * @lcn: starting logical cluster number * @count: number of clusters to read * @b: output data buffer * * Read @count ntfs clusters starting at logical cluster number @lcn from * volume @vol into buffer @b. Return number of clusters read or -1 on error, * with errno set to the error code. */ s64 ntfs_cluster_read(const ntfs_volume *vol, const s64 lcn, const s64 count, void *b) { s64 br; if (!vol || lcn < 0 || count < 0) { errno = EINVAL; return -1; } if (vol->nr_clusters < lcn + count) { errno = ESPIPE; ntfs_log_perror("Trying to read outside of volume " "(%lld < %lld)", (long long)vol->nr_clusters, (long long)lcn + count); return -1; } br = ntfs_pread(vol->dev, lcn << vol->cluster_size_bits, count << vol->cluster_size_bits, b); if (br < 0) { ntfs_log_perror("Error reading cluster(s)"); return br; } return br >> vol->cluster_size_bits; } /** * ntfs_cluster_write - write ntfs clusters * @vol: volume to write to * @lcn: starting logical cluster number * @count: number of clusters to write * @b: data buffer to write to disk * * Write @count ntfs clusters starting at logical cluster number @lcn from * buffer @b to volume @vol. Return the number of clusters written or -1 on * error, with errno set to the error code. */ s64 ntfs_cluster_write(const ntfs_volume *vol, const s64 lcn, const s64 count, const void *b) { s64 bw; if (!vol || lcn < 0 || count < 0) { errno = EINVAL; return -1; } if (vol->nr_clusters < lcn + count) { errno = ESPIPE; ntfs_log_perror("Trying to write outside of volume " "(%lld < %lld)", (long long)vol->nr_clusters, (long long)lcn + count); return -1; } if (!NVolReadOnly(vol)) bw = ntfs_pwrite(vol->dev, lcn << vol->cluster_size_bits, count << vol->cluster_size_bits, b); else bw = count << vol->cluster_size_bits; if (bw < 0) { ntfs_log_perror("Error writing cluster(s)"); return bw; } return bw >> vol->cluster_size_bits; } /** * ntfs_device_offset_valid - test if a device offset is valid * @dev: open device * @ofs: offset to test for validity * * Test if the offset @ofs is an existing location on the device described * by the open device structure @dev. * * Return 0 if it is valid and -1 if it is not valid. */ static int ntfs_device_offset_valid(struct ntfs_device *dev, s64 ofs) { char ch; if (dev->d_ops->seek(dev, ofs, SEEK_SET) >= 0 && dev->d_ops->read(dev, &ch, 1) == 1) return 0; return -1; } /** * ntfs_device_size_get - return the size of a device in blocks * @dev: open device * @block_size: block size in bytes in which to return the result * * Return the number of @block_size sized blocks in the device described by the * open device @dev. * * Adapted from e2fsutils-1.19, Copyright (C) 1995 Theodore Ts'o. * * On error return -1 with errno set to the error code. */ s64 ntfs_device_size_get(struct ntfs_device *dev, int block_size) { s64 high, low; if (!dev || block_size <= 0 || (block_size - 1) & block_size) { errno = EINVAL; return -1; } #ifdef BLKGETSIZE64 { u64 size; if (dev->d_ops->ioctl(dev, BLKGETSIZE64, &size) >= 0) { ntfs_log_debug("BLKGETSIZE64 nr bytes = %llu (0x%llx)\n", (unsigned long long)size, (unsigned long long)size); return (s64)size / block_size; } } #endif #ifdef BLKGETSIZE { unsigned long size; if (dev->d_ops->ioctl(dev, BLKGETSIZE, &size) >= 0) { ntfs_log_debug("BLKGETSIZE nr 512 byte blocks = %lu (0x%lx)\n", size, size); return (s64)size * 512 / block_size; } } #endif #ifdef FDGETPRM { struct floppy_struct this_floppy; if (dev->d_ops->ioctl(dev, FDGETPRM, &this_floppy) >= 0) { ntfs_log_debug("FDGETPRM nr 512 byte blocks = %lu (0x%lx)\n", (unsigned long)this_floppy.size, (unsigned long)this_floppy.size); return (s64)this_floppy.size * 512 / block_size; } } #endif #ifdef DIOCGMEDIASIZE { /* FreeBSD */ off_t size; if (dev->d_ops->ioctl(dev, DIOCGMEDIASIZE, &size) >= 0) { ntfs_log_debug("DIOCGMEDIASIZE nr bytes = %llu (0x%llx)\n", (unsigned long long)size, (unsigned long long)size); return (s64)size / block_size; } } #endif #ifdef DKIOCGETBLOCKCOUNT { /* Mac OS X */ uint64_t blocks; int sector_size; sector_size = ntfs_device_sector_size_get(dev); if (sector_size >= 0 && dev->d_ops->ioctl(dev, DKIOCGETBLOCKCOUNT, &blocks) >= 0) { ntfs_log_debug("DKIOCGETBLOCKCOUNT nr blocks = %llu (0x%llx)\n", (unsigned long long) blocks, (unsigned long long) blocks); return blocks * sector_size / block_size; } } #endif /* * We couldn't figure it out by using a specialized ioctl, * so do binary search to find the size of the device. */ low = 0LL; for (high = 1024LL; !ntfs_device_offset_valid(dev, high); high <<= 1) low = high; while (low < high - 1LL) { const s64 mid = (low + high) / 2; if (!ntfs_device_offset_valid(dev, mid)) low = mid; else high = mid; } dev->d_ops->seek(dev, 0LL, SEEK_SET); return (low + 1LL) / block_size; } /** * ntfs_device_partition_start_sector_get - get starting sector of a partition * @dev: open device * * On success, return the starting sector of the partition @dev in the parent * block device of @dev. On error return -1 with errno set to the error code. * * The following error codes are defined: * EINVAL Input parameter error * EOPNOTSUPP System does not support HDIO_GETGEO ioctl * ENOTTY @dev is a file or a device not supporting HDIO_GETGEO */ s64 ntfs_device_partition_start_sector_get(struct ntfs_device *dev) { if (!dev) { errno = EINVAL; return -1; } #ifdef HDIO_GETGEO { struct hd_geometry geo; if (!dev->d_ops->ioctl(dev, HDIO_GETGEO, &geo)) { ntfs_log_debug("HDIO_GETGEO start_sect = %lu (0x%lx)\n", geo.start, geo.start); return geo.start; } } #else errno = EOPNOTSUPP; #endif return -1; } static int ntfs_device_get_geo(struct ntfs_device *dev) { int err; if (!dev) { errno = EINVAL; return -1; } err = EOPNOTSUPP; #ifdef ENABLE_HD { hd_data_t *hddata; hd_t *hd, *devlist, *partlist = NULL; str_list_t *names; hd_res_t *res; const int d_name_len = strlen(dev->d_name) + 1; int done = 0; hddata = calloc(1, sizeof(*hddata)); if (!hddata) { err = ENOMEM; goto skip_hd; } /* List all "disk" class devices on the system. */ devlist = hd_list(hddata, hw_disk, 1, NULL); if (!devlist) { free(hddata); err = ENOMEM; goto skip_hd; } /* * Loop over each disk device looking for the device with the * same unix name as @dev. */ for (hd = devlist; hd; hd = hd->next) { if (hd->unix_dev_name && !strncmp(dev->d_name, hd->unix_dev_name, d_name_len)) goto got_hd; if (hd->unix_dev_name2 && !strncmp(dev->d_name, hd->unix_dev_name2, d_name_len)) goto got_hd; for (names = hd->unix_dev_names; names; names = names->next) { if (names->str && !strncmp(dev->d_name, names->str, d_name_len)) goto got_hd; } } /* * Device was not a whole disk device. Unless it is a file it * is likely to be a partition device. List all "partition" * class devices on the system. */ partlist = hd_list(hddata, hw_partition, 1, NULL); for (hd = partlist; hd; hd = hd->next) { if (hd->unix_dev_name && !strncmp(dev->d_name, hd->unix_dev_name, d_name_len)) goto got_part_hd; if (hd->unix_dev_name2 && !strncmp(dev->d_name, hd->unix_dev_name2, d_name_len)) goto got_part_hd; for (names = hd->unix_dev_names; names; names = names->next) { if (names->str && !strncmp(dev->d_name, names->str, d_name_len)) goto got_part_hd; } } /* Failed to find the device. Stop trying and clean up. */ goto end_hd; got_part_hd: /* Get the whole block device the partition device is on. */ hd = hd_get_device_by_idx(hddata, hd->attached_to); if (!hd) goto end_hd; got_hd: /* * @hd is now the whole block device either being formatted or * that the partition being formatted is on. * * Loop over each resource of the disk device looking for the * BIOS legacy geometry obtained from EDD which is what Windows * needs to boot. */ for (res = hd->res; res; res = res->next) { /* geotype 3 is BIOS legacy. */ if (res->any.type != res_disk_geo || res->disk_geo.geotype != 3) continue; dev->d_heads = res->disk_geo.heads; dev->d_sectors_per_track = res->disk_geo.sectors; done = 1; } end_hd: if (partlist) hd_free_hd_list(partlist); hd_free_hd_list(devlist); hd_free_hd_data(hddata); free(hddata); if (done) { ntfs_log_debug("EDD/BIOD legacy heads = %u, sectors " "per track = %u\n", dev->d_heads, dev->d_sectors_per_track); return 0; } } skip_hd: #endif #ifdef HDIO_GETGEO { struct hd_geometry geo; if (!dev->d_ops->ioctl(dev, HDIO_GETGEO, &geo)) { dev->d_heads = geo.heads; dev->d_sectors_per_track = geo.sectors; ntfs_log_debug("HDIO_GETGEO heads = %u, sectors per " "track = %u\n", dev->d_heads, dev->d_sectors_per_track); return 0; } err = errno; } #endif errno = err; return -1; } /** * ntfs_device_heads_get - get number of heads of device * @dev: open device * * On success, return the number of heads on the device @dev. On error return * -1 with errno set to the error code. * * The following error codes are defined: * EINVAL Input parameter error * EOPNOTSUPP System does not support HDIO_GETGEO ioctl * ENOTTY @dev is a file or a device not supporting HDIO_GETGEO * ENOMEM Not enough memory to complete the request */ int ntfs_device_heads_get(struct ntfs_device *dev) { if (!dev) { errno = EINVAL; return -1; } if (dev->d_heads == -1) { if (ntfs_device_get_geo(dev) == -1) return -1; if (dev->d_heads == -1) { errno = EINVAL; return -1; } } return dev->d_heads; } /** * ntfs_device_sectors_per_track_get - get number of sectors per track of device * @dev: open device * * On success, return the number of sectors per track on the device @dev. On * error return -1 with errno set to the error code. * * The following error codes are defined: * EINVAL Input parameter error * EOPNOTSUPP System does not support HDIO_GETGEO ioctl * ENOTTY @dev is a file or a device not supporting HDIO_GETGEO * ENOMEM Not enough memory to complete the request */ int ntfs_device_sectors_per_track_get(struct ntfs_device *dev) { if (!dev) { errno = EINVAL; return -1; } if (dev->d_sectors_per_track == -1) { if (ntfs_device_get_geo(dev) == -1) return -1; if (dev->d_sectors_per_track == -1) { errno = EINVAL; return -1; } } return dev->d_sectors_per_track; } /** * ntfs_device_sector_size_get - get sector size of a device * @dev: open device * * On success, return the sector size in bytes of the device @dev. * On error return -1 with errno set to the error code. * * The following error codes are defined: * EINVAL Input parameter error * EOPNOTSUPP System does not support BLKSSZGET ioctl * ENOTTY @dev is a file or a device not supporting BLKSSZGET */ int ntfs_device_sector_size_get(struct ntfs_device *dev) { if (!dev) { errno = EINVAL; return -1; } #ifdef BLKSSZGET { int sect_size = 0; if (!dev->d_ops->ioctl(dev, BLKSSZGET, §_size)) { ntfs_log_debug("BLKSSZGET sector size = %d bytes\n", sect_size); return sect_size; } } #elif defined(DIOCGSECTORSIZE) { /* FreeBSD */ size_t sect_size = 0; if (!dev->d_ops->ioctl(dev, DIOCGSECTORSIZE, §_size)) { ntfs_log_debug("DIOCGSECTORSIZE sector size = %d bytes\n", (int) sect_size); return sect_size; } } #elif defined(DKIOCGETBLOCKSIZE) { /* Mac OS X */ uint32_t sect_size = 0; if (!dev->d_ops->ioctl(dev, DKIOCGETBLOCKSIZE, §_size)) { ntfs_log_debug("DKIOCGETBLOCKSIZE sector size = %d bytes\n", (int) sect_size); return sect_size; } } #else errno = EOPNOTSUPP; #endif return -1; } /** * ntfs_device_block_size_set - set block size of a device * @dev: open device * @block_size: block size to set @dev to * * On success, return 0. * On error return -1 with errno set to the error code. * * The following error codes are defined: * EINVAL Input parameter error * EOPNOTSUPP System does not support BLKBSZSET ioctl * ENOTTY @dev is a file or a device not supporting BLKBSZSET */ int ntfs_device_block_size_set(struct ntfs_device *dev, int block_size __attribute__((unused))) { if (!dev) { errno = EINVAL; return -1; } #ifdef BLKBSZSET { size_t s_block_size = block_size; if (!dev->d_ops->ioctl(dev, BLKBSZSET, &s_block_size)) { ntfs_log_debug("Used BLKBSZSET to set block size to " "%d bytes.\n", block_size); return 0; } /* If not a block device, pretend it was successful. */ if (!NDevBlock(dev)) return 0; } #else /* If not a block device, pretend it was successful. */ if (!NDevBlock(dev)) return 0; errno = EOPNOTSUPP; #endif return -1; } ntfsprogs-plus-1.0.0/libntfs/dir.c000066400000000000000000002361731507404161300171160ustar00rootroot00000000000000/** * dir.c - Directory handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2005 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2004-2008 Szabolcs Szakacsits * Copyright (c) 2005-2007 Yura Pakhuchiy * Copyright (c) 2008-2021 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef MAJOR_IN_MKDEV #include #endif #ifdef MAJOR_IN_SYSMACROS #include #endif #include "param.h" #include "types.h" #include "debug.h" #include "attrib.h" #include "inode.h" #include "dir.h" #include "volume.h" #include "mft.h" #include "index.h" #include "ntfstime.h" #include "lcnalloc.h" #include "logging.h" #include "cache.h" #include "misc.h" #include "security.h" #include "reparse.h" #include "object_id.h" #include "xattrs.h" #include "ea.h" /* * The little endian Unicode strings "$I30", "$SII", "$SDH", "$O" * and "$Q" as global constants. */ ntfschar NTFS_INDEX_I30[5] = { const_cpu_to_le16('$'), const_cpu_to_le16('I'), const_cpu_to_le16('3'), const_cpu_to_le16('0'), const_cpu_to_le16('\0') }; ntfschar NTFS_INDEX_SII[5] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('I'), const_cpu_to_le16('I'), const_cpu_to_le16('\0') }; ntfschar NTFS_INDEX_SDH[5] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('D'), const_cpu_to_le16('H'), const_cpu_to_le16('\0') }; ntfschar NTFS_INDEX_O[3] = { const_cpu_to_le16('$'), const_cpu_to_le16('O'), const_cpu_to_le16('\0') }; ntfschar NTFS_INDEX_Q[3] = { const_cpu_to_le16('$'), const_cpu_to_le16('Q'), const_cpu_to_le16('\0') }; ntfschar NTFS_INDEX_R[3] = { const_cpu_to_le16('$'), const_cpu_to_le16('R'), const_cpu_to_le16('\0') }; #if CACHE_INODE_SIZE /* * Pathname hashing * * Based on first char and second char (which may be '\0') */ int ntfs_dir_inode_hash(const struct CACHED_GENERIC *cached) { const char *path; const unsigned char *name; path = (const char*)cached->variable; if (!path) { ntfs_log_error("Bad inode cache entry\n"); return (-1); } name = (const unsigned char*)strrchr(path,'/'); if (!name) name = (const unsigned char*)path; return (((name[0] << 1) + name[1] + strlen((const char*)name)) % (2*CACHE_INODE_SIZE)); } /* * Pathname comparing for entering/fetching from cache */ static int inode_cache_compare(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *wanted) { return (!cached->variable || strcmp(cached->variable, wanted->variable)); } /* * Pathname comparing for invalidating entries in cache * * A partial path is compared in order to invalidate all paths * related to a renamed directory * inode numbers are also checked, as deleting a long name may * imply deleting a short name and conversely * * Only use associated with a CACHE_NOHASH flag */ static int inode_cache_inv_compare(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *wanted) { int len; BOOL different; const struct CACHED_INODE *w; const struct CACHED_INODE *c; w = (const struct CACHED_INODE*)wanted; c = (const struct CACHED_INODE*)cached; if (w->pathname) { len = strlen(w->pathname); different = !cached->variable || ((w->inum != MREF(c->inum)) && (strncmp(c->pathname, w->pathname, len) || ((c->pathname[len] != '\0') && (c->pathname[len] != '/')))); } else different = !c->pathname || (w->inum != MREF(c->inum)); return (different); } #endif #if CACHE_LOOKUP_SIZE /* * File name comparing for entering/fetching from lookup cache */ static int lookup_cache_compare(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *wanted) { const struct CACHED_LOOKUP *c = (const struct CACHED_LOOKUP*) cached; const struct CACHED_LOOKUP *w = (const struct CACHED_LOOKUP*) wanted; return (!c->name || (c->parent != w->parent) || (c->namesize != w->namesize) || memcmp(c->name, w->name, c->namesize)); } /* * Inode number comparing for invalidating lookup cache * * All entries with designated inode number are invalidated * * Only use associated with a CACHE_NOHASH flag */ static int lookup_cache_inv_compare(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *wanted) { const struct CACHED_LOOKUP *c = (const struct CACHED_LOOKUP*) cached; const struct CACHED_LOOKUP *w = (const struct CACHED_LOOKUP*) wanted; return (!c->name || (c->parent != w->parent) || (MREF(c->inum) != MREF(w->inum))); } /* * Lookup hashing * * Based on first, second and and last char */ int ntfs_dir_lookup_hash(const struct CACHED_GENERIC *cached) { const unsigned char *name; int count; unsigned int val; name = (const unsigned char*)cached->variable; count = cached->varsize; if (!name || !count) { ntfs_log_error("Bad lookup cache entry\n"); return (-1); } val = (name[0] << 2) + (name[1] << 1) + name[count - 1] + count; return (val % (2*CACHE_LOOKUP_SIZE)); } #endif /* * main implementation part of ntfs_inode_lookup_by_name(). * If lookup is success, then return INDEX_ENTRY pointer which is * duplicated memory of found INDEX_ENTRY. * * NOTE: Caller should free returned ie memory after use it. */ INDEX_ENTRY * __ntfs_inode_lookup_by_name(ntfs_inode *dir_ni, const ntfschar *uname, const int uname_len) { VCN vcn; s64 br; ntfs_volume *vol = dir_ni->vol; ntfs_attr_search_ctx *ctx; INDEX_ROOT *ir; INDEX_ENTRY *ie; INDEX_ENTRY *dup_ie; INDEX_ALLOCATION *ia; IGNORE_CASE_BOOL case_sensitivity; u8 *index_end; ntfs_attr *ia_na; int eo, rc; u32 index_block_size; u8 index_vcn_size_bits; ntfs_log_trace("Entering\n"); if (!dir_ni || !dir_ni->mrec || !uname || uname_len <= 0) { errno = EINVAL; return NULL; } ctx = ntfs_attr_get_search_ctx(dir_ni, NULL); if (!ctx) return NULL; /* Find the index root attribute in the mft record. */ if (ntfs_attr_lookup(AT_INDEX_ROOT, NTFS_INDEX_I30, 4, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("Index root attribute missing in directory inode " "%lld", (unsigned long long)dir_ni->mft_no); goto put_err_out; } case_sensitivity = (NVolCaseSensitive(vol) ? CASE_SENSITIVE : IGNORE_CASE); /* Get to the index root value. */ ir = (INDEX_ROOT*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); index_block_size = le32_to_cpu(ir->index_block_size); if (index_block_size < NTFS_BLOCK_SIZE || index_block_size & (index_block_size - 1)) { ntfs_log_error("Index block size %u is invalid.\n", (unsigned)index_block_size); goto put_err_out; } /* Consistency check of ir done while fetching attribute */ index_end = (u8*)&ir->index + le32_to_cpu(ir->index.index_length); /* The first index entry. */ ie = (INDEX_ENTRY*)((u8*)&ir->index + le32_to_cpu(ir->index.entries_offset)); /* * Loop until we exceed valid memory (corruption case) or until we * reach the last entry. */ for (;; ie = (INDEX_ENTRY*)((u8*)ie + le16_to_cpu(ie->length))) { /* Bounds checks. */ if ((u8*)ie < (u8*)ctx->mrec || (u8*)ie + sizeof(INDEX_ENTRY_HEADER) > index_end || (u8*)ie + le16_to_cpu(ie->length) > index_end) { ntfs_log_error("Index root entry out of bounds in" " inode %lld\n", (unsigned long long)dir_ni->mft_no); goto put_err_out; } /* * The last entry cannot contain a name. It can however contain * a pointer to a child node in the B+tree so we just break out. */ if (ie->ie_flags & INDEX_ENTRY_END) break; /* The file name must not overflow from the entry */ rc = ntfs_index_entry_inconsistent(vol, ie, COLLATION_FILE_NAME, dir_ni->mft_no, NULL); if (rc < 0) { errno = EIO; goto put_err_out; } /* * Not a perfect match, need to do full blown collation so we * know which way in the B+tree we have to go. */ rc = ntfs_names_full_collate(uname, uname_len, (ntfschar*)&ie->key.file_name.file_name, ie->key.file_name.file_name_length, case_sensitivity, vol->upcase, vol->upcase_len); /* * If uname collates before the name of the current entry, there * is definitely no such name in this index but we might need to * descend into the B+tree so we just break out of the loop. */ if (rc == -1) break; /* The names are not equal, continue the search. */ if (rc) continue; /* * Perfect match, this will never happen as the * ntfs_are_names_equal() call will have gotten a match but we * still treat it correctly. */ dup_ie = ntfs_ie_dup(ie); ntfs_attr_put_search_ctx(ctx); return dup_ie; } /* * We have finished with this index without success. Check for the * presence of a child node and if not present return error code * ENOENT, unless we have got the mft reference of a matching name * cached in mref in which case return mref. */ if (!(ie->ie_flags & INDEX_ENTRY_NODE)) { ntfs_attr_put_search_ctx(ctx); ntfs_log_debug("Entry not found - between root entries.\n"); errno = ENOENT; return NULL; } /* Child node present, descend into it. */ /* Open the index allocation attribute. */ ia_na = ntfs_attr_open(dir_ni, AT_INDEX_ALLOCATION, NTFS_INDEX_I30, 4); if (!ia_na) { ntfs_log_perror("Failed to open index allocation (inode %lld)", (unsigned long long)dir_ni->mft_no); goto put_err_out; } /* Allocate a buffer for the current index block. */ ia = ntfs_malloc(index_block_size); if (!ia) { ntfs_attr_close(ia_na); goto put_err_out; } /* Determine the size of a vcn in the directory index. */ if (vol->cluster_size <= index_block_size) { index_vcn_size_bits = vol->cluster_size_bits; } else { index_vcn_size_bits = NTFS_BLOCK_SIZE_BITS; } /* Get the starting vcn of the index_block holding the child node. */ vcn = sle64_to_cpup((sle64*)((u8*)ie + le16_to_cpu(ie->length) - 8)); descend_into_child_node: /* Read the index block starting at vcn. */ br = ntfs_attr_mst_pread(ia_na, vcn << index_vcn_size_bits, 1, index_block_size, ia); if (br != 1) { if (br != -1) errno = EIO; ntfs_log_perror("Failed to read vcn 0x%llx from inode %lld", (unsigned long long)vcn, (unsigned long long)ia_na->ni->mft_no); goto close_err_out; } if (ntfs_index_block_inconsistent(vol, ia_na, (INDEX_BLOCK*)ia, index_block_size, ia_na->ni->mft_no, vcn)) { errno = EIO; goto close_err_out; } index_end = (u8*)&ia->index + le32_to_cpu(ia->index.index_length); /* The first index entry. */ ie = (INDEX_ENTRY*)((u8*)&ia->index + le32_to_cpu(ia->index.entries_offset)); /* * Iterate similar to above big loop but applied to index buffer, thus * loop until we exceed valid memory (corruption case) or until we * reach the last entry. */ for (;; ie = (INDEX_ENTRY*)((u8*)ie + le16_to_cpu(ie->length))) { /* Bounds check. */ if ((u8*)ie < (u8*)ia || (u8*)ie + sizeof(INDEX_ENTRY_HEADER) > index_end || (u8*)ie + le16_to_cpu(ie->length) > index_end) { ntfs_log_error("Index entry out of bounds in directory " "inode %lld.\n", (unsigned long long)dir_ni->mft_no); errno = EIO; goto close_err_out; } /* * The last entry cannot contain a name. It can however contain * a pointer to a child node in the B+tree so we just break out. */ if (ie->ie_flags & INDEX_ENTRY_END) break; /* The file name must not overflow from the entry */ rc = ntfs_index_entry_inconsistent(vol, ie, COLLATION_FILE_NAME, dir_ni->mft_no, NULL); if (rc < 0) { errno = EIO; goto close_err_out; } /* * Not a perfect match, need to do full blown collation so we * know which way in the B+tree we have to go. */ rc = ntfs_names_full_collate(uname, uname_len, (ntfschar*)&ie->key.file_name.file_name, ie->key.file_name.file_name_length, case_sensitivity, vol->upcase, vol->upcase_len); /* * If uname collates before the name of the current entry, there * is definitely no such name in this index but we might need to * descend into the B+tree so we just break out of the loop. */ if (rc == -1) break; /* The names are not equal, continue the search. */ if (rc) continue; dup_ie = ntfs_ie_dup(ie); free(ia); ntfs_attr_close(ia_na); ntfs_attr_put_search_ctx(ctx); return dup_ie; } /* * We have finished with this index buffer without success. Check for * the presence of a child node. */ if (ie->ie_flags & INDEX_ENTRY_NODE) { if ((ia->index.ih_flags & NODE_MASK) == LEAF_NODE) { ntfs_log_error("Index entry with child node found in a leaf " "node in directory inode %lld.\n", (unsigned long long)dir_ni->mft_no); errno = EIO; goto close_err_out; } /* Child node present, descend into it. */ vcn = sle64_to_cpup((sle64*)((u8*)ie + le16_to_cpu(ie->length) - 8)); if (vcn >= 0) goto descend_into_child_node; ntfs_log_error("Negative child node vcn in directory inode " "0x%llx.\n", (unsigned long long)dir_ni->mft_no); errno = EIO; goto close_err_out; } free(ia); ntfs_attr_close(ia_na); ntfs_attr_put_search_ctx(ctx); /* * No child node present, return error code ENOENT, unless we have got * the mft reference of a matching name cached in mref in which case * return mref. */ ntfs_log_debug("Entry not found.\n"); errno = ENOENT; return NULL; put_err_out: eo = EIO; ntfs_log_debug("Corrupt directory. Aborting lookup.\n"); eo_put_err_out: ntfs_attr_put_search_ctx(ctx); errno = eo; return NULL; close_err_out: eo = errno; free(ia); ntfs_attr_close(ia_na); goto eo_put_err_out; } /** * ntfs_inode_lookup_by_name - find an inode in a directory given its name * @dir_ni: ntfs inode of the directory in which to search for the name * @uname: Unicode name for which to search in the directory * @uname_len: length of the name @uname in Unicode characters * * Look for an inode with name @uname in the directory with inode @dir_ni. * ntfs_inode_lookup_by_name() walks the contents of the directory looking for * the Unicode name. If the name is found in the directory, the corresponding * inode number (>= 0) is returned as a mft reference in cpu format, i.e. it * is a 64-bit number containing the sequence number. * * On error, return -1 with errno set to the error code. If the inode is is not * found errno is ENOENT. * * Note, @uname_len does not include the (optional) terminating NULL character. * * Note, we look for a case sensitive match first but we also look for a case * insensitive match at the same time. If we find a case insensitive match, we * save that for the case that we don't find an exact match, where we return * the mft reference of the case insensitive match. * * If the volume is mounted with the case sensitive flag set, then we only * allow exact matches. */ u64 ntfs_inode_lookup_by_name(ntfs_inode *dir_ni, const ntfschar *uname, const int uname_len) { u64 mref = 0; INDEX_ENTRY *ie; ntfs_log_trace("Entering\n"); if (!dir_ni || !dir_ni->mrec || !uname || uname_len <= 0) { errno = EINVAL; return -1; } ie = __ntfs_inode_lookup_by_name(dir_ni, uname, uname_len); if (!ie) return -1; mref = le64_to_cpu(ie->indexed_file); free(ie); return mref; } /* * Lookup a file in a directory from its UTF-8 name * * The name is first fetched from cache if one is defined * * Returns the inode number * or -1 if not possible (errno tells why) */ u64 ntfs_inode_lookup_by_mbsname(ntfs_inode *dir_ni, const char *name) { int uname_len; ntfschar *uname = (ntfschar*)NULL; u64 inum; char *cached_name; const char *const_name; if (!NVolCaseSensitive(dir_ni->vol)) { cached_name = ntfs_uppercase_mbs(name, dir_ni->vol->upcase, dir_ni->vol->upcase_len); const_name = cached_name; } else { cached_name = (char*)NULL; const_name = name; } if (const_name) { #if CACHE_LOOKUP_SIZE /* * fetch inode from cache */ if (dir_ni->vol->lookup_cache) { struct CACHED_LOOKUP item; struct CACHED_LOOKUP *cached; item.name = const_name; item.namesize = strlen(const_name) + 1; item.parent = dir_ni->mft_no; cached = (struct CACHED_LOOKUP*)ntfs_fetch_cache( dir_ni->vol->lookup_cache, GENERIC(&item), lookup_cache_compare); if (cached) { inum = cached->inum; if (inum == (u64)-1) errno = ENOENT; } else { /* Generate unicode name. */ uname_len = ntfs_mbstoucs(name, &uname); if (uname_len >= 0) { inum = ntfs_inode_lookup_by_name(dir_ni, uname, uname_len); item.inum = inum; /* enter into cache, even if not found */ ntfs_enter_cache(dir_ni->vol->lookup_cache, GENERIC(&item), lookup_cache_compare); free(uname); } else inum = (s64)-1; } } else #endif { /* Generate unicode name. */ uname_len = ntfs_mbstoucs(cached_name, &uname); if (uname_len >= 0) { inum = ntfs_inode_lookup_by_name(dir_ni, uname, uname_len); free(uname); } else inum = (s64)-1; } if (cached_name) free(cached_name); } else inum = (s64)-1; return (inum); } /* * Update a cache lookup record when a name has been defined * * The UTF-8 name is required */ void ntfs_inode_update_mbsname(ntfs_inode *dir_ni, const char *name, u64 inum) { #if CACHE_LOOKUP_SIZE struct CACHED_LOOKUP item; struct CACHED_LOOKUP *cached; char *cached_name; if (dir_ni->vol->lookup_cache) { if (!NVolCaseSensitive(dir_ni->vol)) { cached_name = ntfs_uppercase_mbs(name, dir_ni->vol->upcase, dir_ni->vol->upcase_len); item.name = cached_name; } else { cached_name = (char*)NULL; item.name = name; } if (item.name) { item.namesize = strlen(item.name) + 1; item.parent = dir_ni->mft_no; item.inum = inum; cached = (struct CACHED_LOOKUP*)ntfs_enter_cache( dir_ni->vol->lookup_cache, GENERIC(&item), lookup_cache_compare); if (cached) cached->inum = inum; if (cached_name) free(cached_name); } } #endif } /** * ntfs_pathname_to_inode - Find the inode which represents the given pathname * @vol: An ntfs volume obtained from ntfs_mount * @parent: A directory inode to begin the search (may be NULL) * @pathname: Pathname to be located * * Take an ASCII pathname and find the inode that represents it. The function * splits the path and then descends the directory tree. If @parent is NULL, * then the root directory '.' will be used as the base for the search. * * Return: inode Success, the pathname was valid * NULL Error, the pathname was invalid, or some other error occurred */ ntfs_inode *ntfs_pathname_to_inode(ntfs_volume *vol, ntfs_inode *parent, const char *pathname) { u64 inum; int len, err = 0; char *p, *q; ntfs_inode *ni; ntfs_inode *result = NULL; ntfschar *unicode = NULL; char *ascii = NULL; #if CACHE_INODE_SIZE struct CACHED_INODE item; struct CACHED_INODE *cached; char *fullname; #endif if (!vol || !pathname) { errno = EINVAL; return NULL; } ntfs_log_trace("path: '%s'\n", pathname); ascii = strdup(pathname); if (!ascii) { ntfs_log_error("Out of memory.\n"); err = ENOMEM; goto out; } p = ascii; /* Remove leading /'s. */ while (p && *p && *p == PATH_SEP) p++; #if CACHE_INODE_SIZE fullname = p; if (p[0] && (p[strlen(p)-1] == PATH_SEP)) ntfs_log_error("Unnormalized path %s\n",ascii); #endif if (parent) { ni = parent; } else { #if CACHE_INODE_SIZE /* * fetch inode for full path from cache */ if (*fullname) { item.pathname = fullname; item.varsize = strlen(fullname) + 1; cached = (struct CACHED_INODE*)ntfs_fetch_cache( vol->xinode_cache, GENERIC(&item), inode_cache_compare); } else cached = (struct CACHED_INODE*)NULL; if (cached) { /* * return opened inode if found in cache */ inum = MREF(cached->inum); ni = ntfs_inode_open(vol, inum); if (!ni) { ntfs_log_debug("Cannot open inode %llu: %s.\n", (unsigned long long)inum, p); err = EIO; } result = ni; goto out; } #endif ni = ntfs_inode_open(vol, FILE_root); if (!ni) { ntfs_log_debug("Couldn't open the inode of the root " "directory.\n"); err = EIO; result = (ntfs_inode*)NULL; goto out; } } while (p && *p) { /* Find the end of the first token. */ q = strchr(p, PATH_SEP); if (q != NULL) { *q = '\0'; } #if CACHE_INODE_SIZE /* * fetch inode for partial path from cache */ cached = (struct CACHED_INODE*)NULL; if (!parent) { item.pathname = fullname; item.varsize = strlen(fullname) + 1; cached = (struct CACHED_INODE*)ntfs_fetch_cache( vol->xinode_cache, GENERIC(&item), inode_cache_compare); if (cached) { inum = cached->inum; } } /* * if not in cache, translate, search, then * insert into cache if found */ if (!cached) { len = ntfs_mbstoucs(p, &unicode); if (len < 0) { ntfs_log_perror("Could not convert filename to Unicode:" " '%s'", p); err = errno; goto close; } else if (len > NTFS_MAX_NAME_LEN) { err = ENAMETOOLONG; goto close; } inum = ntfs_inode_lookup_by_name(ni, unicode, len); if (!parent && (inum != (u64) -1)) { item.inum = inum; ntfs_enter_cache(vol->xinode_cache, GENERIC(&item), inode_cache_compare); } } #else len = ntfs_mbstoucs(p, &unicode); if (len < 0) { ntfs_log_perror("Could not convert filename to Unicode:" " '%s'", p); err = errno; goto close; } else if (len > NTFS_MAX_NAME_LEN) { err = ENAMETOOLONG; goto close; } inum = ntfs_inode_lookup_by_name(ni, unicode, len); #endif if (inum == (u64) -1) { ntfs_log_debug("Couldn't find name '%s' in pathname " "'%s'.\n", p, pathname); err = ENOENT; goto close; } if (ni != parent) if (ntfs_inode_close(ni)) { err = errno; goto out; } inum = MREF(inum); ni = ntfs_inode_open(vol, inum); if (!ni) { ntfs_log_debug("Cannot open inode %llu: %s.\n", (unsigned long long)inum, p); err = EIO; goto close; } free(unicode); unicode = NULL; if (q) *q++ = PATH_SEP; /* JPA */ p = q; while (p && *p && *p == PATH_SEP) p++; } result = ni; ni = NULL; close: if (ni && (ni != parent)) if (ntfs_inode_close(ni) && !err) err = errno; out: free(ascii); free(unicode); if (err) errno = err; return result; } /* * The little endian Unicode string ".." for ntfs_readdir(). */ static const ntfschar dotdot[3] = { const_cpu_to_le16('.'), const_cpu_to_le16('.'), const_cpu_to_le16('\0') }; /* * union index_union - * More helpers for ntfs_readdir(). */ typedef union { INDEX_ROOT *ir; INDEX_ALLOCATION *ia; } index_union __attribute__((__transparent_union__)); /** * enum INDEX_TYPE - * More helpers for ntfs_readdir(). */ typedef enum { INDEX_TYPE_ROOT, /* index root */ INDEX_TYPE_ALLOCATION, /* index allocation */ } INDEX_TYPE; /* * Decode Interix file types * * Non-Interix types are returned as plain files, because a * Windows user may force patterns very similar to Interix, * and most metadata files have such similar patters. */ u32 ntfs_interix_types(ntfs_inode *ni) { ntfs_attr *na; u32 dt_type; le64 magic; dt_type = NTFS_DT_UNKNOWN; na = ntfs_attr_open(ni, AT_DATA, NULL, 0); if (na) { /* * Unrecognized patterns (eg HID + SYST for metadata) * are plain files or directories */ if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) dt_type = NTFS_DT_DIR; else dt_type = NTFS_DT_REG; if (na->data_size <= 1) { if (!(ni->flags & FILE_ATTR_HIDDEN)) dt_type = (na->data_size ? NTFS_DT_SOCK : NTFS_DT_FIFO); } else { if ((na->data_size >= (s64)sizeof(magic)) && (ntfs_attr_pread(na, 0, sizeof(magic), &magic) == sizeof(magic))) { if (magic == INTX_SYMBOLIC_LINK) dt_type = NTFS_DT_LNK; else if (magic == INTX_BLOCK_DEVICE) dt_type = NTFS_DT_BLK; else if (magic == INTX_CHARACTER_DEVICE) dt_type = NTFS_DT_CHR; } } ntfs_attr_close(na); } return (dt_type); } /* * Decode file types * * Better only use for Interix types and junctions, * unneeded complexity when used for plain files or directories * * Error cases are logged and returned as unknown. */ static u32 ntfs_dir_entry_type(ntfs_inode *dir_ni, MFT_REF mref, FILE_ATTR_FLAGS attributes) { ntfs_inode *ni; u32 dt_type; dt_type = NTFS_DT_UNKNOWN; ni = ntfs_inode_open(dir_ni->vol, mref); if (ni) { if (attributes & FILE_ATTR_REPARSE_POINT) dt_type = (ntfs_possible_symlink(ni) ? NTFS_DT_LNK : NTFS_DT_REPARSE); else if ((attributes & FILE_ATTR_SYSTEM) && !(attributes & FILE_ATTR_I30_INDEX_PRESENT)) dt_type = ntfs_interix_types(ni); else dt_type = (attributes & FILE_ATTR_I30_INDEX_PRESENT ? NTFS_DT_DIR : NTFS_DT_REG); if (ntfs_inode_close(ni)) { /* anything special worth doing ? */ ntfs_log_error("Failed to close inode %lld\n", (long long)MREF(mref)); } } if (dt_type == NTFS_DT_UNKNOWN) ntfs_log_error("Could not decode the type of inode %lld\n", (long long)MREF(mref)); return (dt_type); } /** * ntfs_filldir - ntfs specific filldir method * @dir_ni: ntfs inode of current directory * @pos: current position in directory * @ivcn_bits: log(2) of index vcn size * @index_type: specifies whether @iu is an index root or an index allocation * @iu: index root or index block to which @ie belongs * @ie: current index entry * @dirent: context for filldir callback supplied by the caller * @filldir: filldir callback supplied by the caller * * Pass information specifying the current directory entry @ie to the @filldir * callback. */ static int ntfs_filldir(ntfs_inode *dir_ni, s64 *pos, u8 ivcn_bits, const INDEX_TYPE index_type, index_union iu, INDEX_ENTRY *ie, void *dirent, ntfs_filldir_t filldir) { FILE_NAME_ATTR *fn = &ie->key.file_name; unsigned dt_type; BOOL metadata; ntfschar *loname; int res; MFT_REF mref; ntfs_log_trace("Entering.\n"); /* Advance the position even if going to skip the entry. */ if (index_type == INDEX_TYPE_ALLOCATION) *pos = (u8*)ie - (u8*)iu.ia + (sle64_to_cpu( iu.ia->index_block_vcn) << ivcn_bits) + dir_ni->vol->mft_record_size; else /* if (index_type == INDEX_TYPE_ROOT) */ *pos = (u8*)ie - (u8*)iu.ir; mref = le64_to_cpu(ie->indexed_file); metadata = (MREF(mref) != FILE_root) && (MREF(mref) < FILE_first_user); /* Skip root directory self reference entry. */ if (MREF_LE(ie->indexed_file) == FILE_root) return 0; if ((ie->key.file_name.file_attributes & (FILE_ATTR_REPARSE_POINT | FILE_ATTR_SYSTEM)) && !metadata) dt_type = ntfs_dir_entry_type(dir_ni, mref, ie->key.file_name.file_attributes); else if (ie->key.file_name.file_attributes & FILE_ATTR_I30_INDEX_PRESENT) dt_type = NTFS_DT_DIR; else dt_type = NTFS_DT_REG; /* return metadata files and hidden files if requested */ if ((!metadata && (NVolShowHidFiles(dir_ni->vol) || !(fn->file_attributes & FILE_ATTR_HIDDEN))) || (NVolShowSysFiles(dir_ni->vol) && (NVolShowHidFiles(dir_ni->vol) || metadata))) { if (NVolCaseSensitive(dir_ni->vol)) { res = filldir(dirent, fn->file_name, fn->file_name_length, fn->file_name_type, *pos, mref, dt_type); } else { loname = (ntfschar*)ntfs_malloc(2*fn->file_name_length); if (loname) { memcpy(loname, fn->file_name, 2*fn->file_name_length); ntfs_name_locase(loname, fn->file_name_length, dir_ni->vol->locase, dir_ni->vol->upcase_len); res = filldir(dirent, loname, fn->file_name_length, fn->file_name_type, *pos, mref, dt_type); free(loname); } else res = -1; } } else res = 0; return (res); } /** * ntfs_mft_get_parent_ref - find mft reference of parent directory of an inode * @ni: ntfs inode whose parent directory to find * * Find the parent directory of the ntfs inode @ni. To do this, find the first * file name attribute in the mft record of @ni and return the parent mft * reference from that. * * Note this only makes sense for directories, since files can be hard linked * from multiple directories and there is no way for us to tell which one is * being looked for. * * Technically directories can have hard links, too, but we consider that as * illegal as Linux/UNIX do not support directory hard links. * * Return the mft reference of the parent directory on success or -1 on error * with errno set to the error code. */ static MFT_REF ntfs_mft_get_parent_ref(ntfs_inode *ni) { MFT_REF mref; ntfs_attr_search_ctx *ctx; FILE_NAME_ATTR *fn; int eo; ntfs_log_trace("Entering.\n"); if (!ni) { errno = EINVAL; return ERR_MREF(-1); } ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return ERR_MREF(-1); if (ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { ntfs_log_error("No file name found in inode %lld\n", (unsigned long long)ni->mft_no); goto err_out; } if (ctx->attr->non_resident) { ntfs_log_error("File name attribute must be resident (inode " "%lld)\n", (unsigned long long)ni->mft_no); goto io_err_out; } fn = (FILE_NAME_ATTR*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); mref = le64_to_cpu(fn->parent_directory); ntfs_attr_put_search_ctx(ctx); return mref; io_err_out: errno = EIO; err_out: eo = errno; ntfs_attr_put_search_ctx(ctx); errno = eo; return ERR_MREF(-1); } /** * ntfs_readdir - read the contents of an ntfs directory * @dir_ni: ntfs inode of current directory * @pos: current position in directory * @dirent: context for filldir callback supplied by the caller * @filldir: filldir callback supplied by the caller * * Parse the index root and the index blocks that are marked in use in the * index bitmap and hand each found directory entry to the @filldir callback * supplied by the caller. * * Return 0 on success or -1 on error with errno set to the error code. * * Note: Index blocks are parsed in ascending vcn order, from which follows * that the directory entries are not returned sorted. */ int ntfs_readdir(ntfs_inode *dir_ni, s64 *pos, void *dirent, ntfs_filldir_t filldir) { s64 i_size, br, ia_pos, bmp_pos, ia_start; ntfs_volume *vol; ntfs_attr *ia_na, *bmp_na = NULL; ntfs_attr_search_ctx *ctx = NULL; u8 *index_end, *bmp = NULL; INDEX_ROOT *ir; INDEX_ENTRY *ie; INDEX_ALLOCATION *ia = NULL; int rc, ir_pos, bmp_buf_size, bmp_buf_pos, eo; u32 index_block_size; u8 index_block_size_bits, index_vcn_size_bits; ntfs_log_trace("Entering.\n"); if (!dir_ni || !pos || !filldir) { errno = EINVAL; return -1; } if (!(dir_ni->mrec->flags & MFT_RECORD_IS_DIRECTORY)) { errno = ENOTDIR; return -1; } vol = dir_ni->vol; ntfs_log_trace("Entering for inode %lld, *pos 0x%llx.\n", (unsigned long long)dir_ni->mft_no, (long long)*pos); /* Open the index allocation attribute. */ ia_na = ntfs_attr_open(dir_ni, AT_INDEX_ALLOCATION, NTFS_INDEX_I30, 4); if (!ia_na) { if (errno != ENOENT) { ntfs_log_perror("Failed to open index allocation attribute. " "Directory inode %lld is corrupt or bug", (unsigned long long)dir_ni->mft_no); return -1; } i_size = 0; } else i_size = ia_na->data_size; rc = 0; /* Are we at end of dir yet? */ if (*pos >= i_size + vol->mft_record_size) goto done; /* Emulate . and .. for all directories. */ if (!*pos) { rc = filldir(dirent, dotdot, 1, FILE_NAME_POSIX, *pos, MK_MREF(dir_ni->mft_no, le16_to_cpu(dir_ni->mrec->sequence_number)), NTFS_DT_DIR); if (rc) goto err_out; ++*pos; } if (*pos == 1) { MFT_REF parent_mref; parent_mref = ntfs_mft_get_parent_ref(dir_ni); if (parent_mref == ERR_MREF(-1)) { ntfs_log_perror("Parent directory not found"); goto dir_err_out; } rc = filldir(dirent, dotdot, 2, FILE_NAME_POSIX, *pos, parent_mref, NTFS_DT_DIR); if (rc) goto err_out; ++*pos; } ctx = ntfs_attr_get_search_ctx(dir_ni, NULL); if (!ctx) goto err_out; /* Get the offset into the index root attribute. */ ir_pos = (int)*pos; /* Find the index root attribute in the mft record. */ if (ntfs_attr_lookup(AT_INDEX_ROOT, NTFS_INDEX_I30, 4, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("Index root attribute missing in directory inode " "%lld", (unsigned long long)dir_ni->mft_no); goto dir_err_out; } /* Get to the index root value. */ ir = (INDEX_ROOT*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); /* Determine the size of a vcn in the directory index. */ index_block_size = le32_to_cpu(ir->index_block_size); if (index_block_size < NTFS_BLOCK_SIZE || index_block_size & (index_block_size - 1)) { ntfs_log_error("Index block size %u is invalid.\n", (unsigned)index_block_size); goto dir_err_out; } index_block_size_bits = ffs(index_block_size) - 1; if (vol->cluster_size <= index_block_size) { index_vcn_size_bits = vol->cluster_size_bits; } else { index_vcn_size_bits = NTFS_BLOCK_SIZE_BITS; } /* Are we jumping straight into the index allocation attribute? */ if (*pos >= vol->mft_record_size) { ntfs_attr_put_search_ctx(ctx); ctx = NULL; goto skip_index_root; } index_end = (u8*)&ir->index + le32_to_cpu(ir->index.index_length); /* The first index entry. */ ie = (INDEX_ENTRY*)((u8*)&ir->index + le32_to_cpu(ir->index.entries_offset)); /* * Loop until we exceed valid memory (corruption case) or until we * reach the last entry or until filldir tells us it has had enough * or signals an error (both covered by the rc test). */ for (;; ie = (INDEX_ENTRY*)((u8*)ie + le16_to_cpu(ie->length))) { ntfs_log_debug("In index root, offset %d.\n", (int)((u8*)ie - (u8*)ir)); /* Bounds checks. */ if ((u8*)ie < (u8*)ctx->mrec || (u8*)ie + sizeof(INDEX_ENTRY_HEADER) > index_end || (u8*)ie + le16_to_cpu(ie->length) > index_end) { ntfs_log_error("Index root entry out of bounds in" " inode %lld\n", (unsigned long long)dir_ni->mft_no); goto dir_err_out; } /* The last entry cannot contain a name. */ if (ie->ie_flags & INDEX_ENTRY_END) break; if (!le16_to_cpu(ie->length)) goto dir_err_out; /* Skip index root entry if continuing previous readdir. */ if (ir_pos > (u8*)ie - (u8*)ir) continue; /* The file name must not overflow from the entry */ rc = ntfs_index_entry_inconsistent(vol, ie, COLLATION_FILE_NAME, dir_ni->mft_no, NULL); if (rc < 0) { errno = EIO; goto dir_err_out; } /* * Submit the directory entry to ntfs_filldir(), which will * invoke the filldir() callback as appropriate. */ rc = ntfs_filldir(dir_ni, pos, index_vcn_size_bits, INDEX_TYPE_ROOT, ir, ie, dirent, filldir); if (rc) { ntfs_attr_put_search_ctx(ctx); ctx = NULL; goto err_out; } } ntfs_attr_put_search_ctx(ctx); ctx = NULL; /* If there is no index allocation attribute we are finished. */ if (!ia_na) goto EOD; /* Advance *pos to the beginning of the index allocation. */ *pos = vol->mft_record_size; skip_index_root: if (!ia_na) goto done; /* Allocate a buffer for the current index block. */ ia = ntfs_malloc(index_block_size); if (!ia) goto err_out; bmp_na = ntfs_attr_open(dir_ni, AT_BITMAP, NTFS_INDEX_I30, 4); if (!bmp_na) { ntfs_log_perror("Failed to open index bitmap attribute"); goto dir_err_out; } /* Get the offset into the index allocation attribute. */ ia_pos = *pos - vol->mft_record_size; bmp_pos = ia_pos >> index_block_size_bits; if (bmp_pos >> 3 >= bmp_na->data_size) { ntfs_log_error("Current index position exceeds index bitmap " "size.\n"); goto dir_err_out; } bmp_buf_size = min(bmp_na->data_size - (bmp_pos >> 3), 4096); bmp = ntfs_malloc(bmp_buf_size); if (!bmp) goto err_out; br = ntfs_attr_pread(bmp_na, bmp_pos >> 3, bmp_buf_size, bmp); if (br != bmp_buf_size) { if (br != -1) errno = EIO; ntfs_log_perror("Failed to read from index bitmap attribute"); goto err_out; } bmp_buf_pos = 0; /* If the index block is not in use find the next one that is. */ while (!(bmp[bmp_buf_pos >> 3] & (1 << (bmp_buf_pos & 7)))) { find_next_index_buffer: bmp_pos++; bmp_buf_pos++; /* If we have reached the end of the bitmap, we are done. */ if (bmp_pos >> 3 >= bmp_na->data_size) goto EOD; ia_pos = bmp_pos << index_block_size_bits; if (bmp_buf_pos >> 3 < bmp_buf_size) continue; /* Read next chunk from the index bitmap. */ bmp_buf_pos = 0; if ((bmp_pos >> 3) + bmp_buf_size > bmp_na->data_size) bmp_buf_size = bmp_na->data_size - (bmp_pos >> 3); br = ntfs_attr_pread(bmp_na, bmp_pos >> 3, bmp_buf_size, bmp); if (br != bmp_buf_size) { if (br != -1) errno = EIO; ntfs_log_perror("Failed to read from index bitmap attribute"); goto err_out; } } ntfs_log_debug("Handling index block 0x%llx.\n", (long long)bmp_pos); /* Read the index block starting at bmp_pos. */ br = ntfs_attr_mst_pread(ia_na, bmp_pos << index_block_size_bits, 1, index_block_size, ia); if (br != 1) { if (br != -1) errno = EIO; ntfs_log_perror("Failed to read index block"); goto err_out; } ia_start = ia_pos & ~(s64)(index_block_size - 1); if (ntfs_index_block_inconsistent(vol, ia_na, (INDEX_BLOCK*)ia, index_block_size, ia_na->ni->mft_no, ia_start >> index_vcn_size_bits)) { goto dir_err_out; } index_end = (u8*)&ia->index + le32_to_cpu(ia->index.index_length); /* The first index entry. */ ie = (INDEX_ENTRY*)((u8*)&ia->index + le32_to_cpu(ia->index.entries_offset)); /* * Loop until we exceed valid memory (corruption case) or until we * reach the last entry or until ntfs_filldir tells us it has had * enough or signals an error (both covered by the rc test). */ for (;; ie = (INDEX_ENTRY*)((u8*)ie + le16_to_cpu(ie->length))) { ntfs_log_debug("In index allocation, offset 0x%llx.\n", (long long)ia_start + ((u8*)ie - (u8*)ia)); /* Bounds checks. */ if ((u8*)ie < (u8*)ia || (u8*)ie + sizeof(INDEX_ENTRY_HEADER) > index_end || (u8*)ie + le16_to_cpu(ie->length) > index_end) { ntfs_log_error("Index entry out of bounds in directory inode " "%lld.\n", (unsigned long long)dir_ni->mft_no); goto dir_err_out; } /* The last entry cannot contain a name. */ if (ie->ie_flags & INDEX_ENTRY_END) break; if (!le16_to_cpu(ie->length)) goto dir_err_out; /* Skip index entry if continuing previous readdir. */ if (ia_pos - ia_start > (u8*)ie - (u8*)ia) continue; /* The file name must not overflow from the entry */ rc = ntfs_index_entry_inconsistent(vol, ie, COLLATION_FILE_NAME, dir_ni->mft_no, NULL); if (rc < 0) { errno = EIO; goto dir_err_out; } /* * Submit the directory entry to ntfs_filldir(), which will * invoke the filldir() callback as appropriate. */ rc = ntfs_filldir(dir_ni, pos, index_vcn_size_bits, INDEX_TYPE_ALLOCATION, ia, ie, dirent, filldir); if (rc) goto err_out; } goto find_next_index_buffer; EOD: /* We are finished, set *pos to EOD. */ *pos = i_size + vol->mft_record_size; done: free(ia); free(bmp); if (bmp_na) ntfs_attr_close(bmp_na); if (ia_na) ntfs_attr_close(ia_na); ntfs_log_debug("EOD, *pos 0x%llx, returning 0.\n", (long long)*pos); return 0; dir_err_out: errno = EIO; err_out: eo = errno; ntfs_log_trace("failed.\n"); if (ctx) ntfs_attr_put_search_ctx(ctx); free(ia); free(bmp); if (bmp_na) ntfs_attr_close(bmp_na); if (ia_na) ntfs_attr_close(ia_na); errno = eo; return -1; } /** * __ntfs_create - create object on ntfs volume * @dir_ni: ntfs inode for directory in which create new object * @securid: id of inheritable security descriptor, 0 if none * @name: unicode name of new object * @name_len: length of the name in unicode characters * @type: type of the object to create * @dev: major and minor device numbers (obtained from makedev()) * @target: target in unicode (only for symlinks) * @target_len: length of target in unicode characters * * Internal, use ntfs_create{,_device,_symlink} wrappers instead. * * @type can be: * S_IFREG to create regular file * S_IFDIR to create directory * S_IFBLK to create block device * S_IFCHR to create character device * S_IFLNK to create symbolic link * S_IFIFO to create FIFO * S_IFSOCK to create socket * other values are invalid. * * @dev is used only if @type is S_IFBLK or S_IFCHR, in other cases its value * ignored. * * @target and @target_len are used only if @type is S_IFLNK, in other cases * their value ignored. * * Return opened ntfs inode that describes created object on success or NULL * on error with errno set to the error code. */ static ntfs_inode *__ntfs_create(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, mode_t type, dev_t dev, const ntfschar *target, int target_len) { ntfs_inode *ni; int rollback_data = 0, rollback_sd = 0; int rollback_dir = 0; FILE_NAME_ATTR *fn = NULL; STANDARD_INFORMATION *si = NULL; int err, fn_len, si_len; ntfs_volume_special_files special_files; ntfs_log_trace("Entering.\n"); /* Sanity checks. */ if (!dir_ni || !name || !name_len) { ntfs_log_error("Invalid arguments.\n"); errno = EINVAL; return NULL; } ni = ntfs_mft_record_alloc(dir_ni->vol, NULL); if (!ni) return NULL; #if CACHE_NIDATA_SIZE ntfs_inode_invalidate(dir_ni->vol, ni->mft_no); #endif special_files = dir_ni->vol->special_files; /* * Create STANDARD_INFORMATION attribute. * JPA Depending on available inherited security descriptor, * Write STANDARD_INFORMATION v1.2 (no inheritance) or v3 */ if (securid) si_len = sizeof(STANDARD_INFORMATION); else si_len = offsetof(STANDARD_INFORMATION, v1_end); si = ntfs_calloc(si_len); if (!si) { err = errno; goto err_out; } si->creation_time = ni->creation_time; si->last_data_change_time = ni->last_data_change_time; si->last_mft_change_time = ni->last_mft_change_time; si->last_access_time = ni->last_access_time; if (securid) { set_nino_flag(ni, v3_Extensions); ni->owner_id = si->owner_id = const_cpu_to_le32(0); ni->security_id = si->security_id = securid; ni->quota_charged = si->quota_charged = const_cpu_to_le64(0); ni->usn = si->usn = const_cpu_to_le64(0); } else clear_nino_flag(ni, v3_Extensions); if (!S_ISREG(type) && !S_ISDIR(type)) { switch (special_files) { case NTFS_FILES_WSL : if (!S_ISLNK(type)) { si->file_attributes = FILE_ATTRIBUTE_RECALL_ON_OPEN; ni->flags = FILE_ATTRIBUTE_RECALL_ON_OPEN; } break; default : si->file_attributes = FILE_ATTR_SYSTEM; ni->flags = FILE_ATTR_SYSTEM; break; } } ni->flags |= FILE_ATTR_ARCHIVE; if (NVolHideDotFiles(dir_ni->vol) && (name_len > 1) && (name[0] == const_cpu_to_le16('.')) && (name[1] != const_cpu_to_le16('.'))) ni->flags |= FILE_ATTR_HIDDEN; /* * Set compression flag according to parent directory * unless NTFS version < 3.0 or cluster size > 4K * or compression has been disabled */ if ((dir_ni->flags & FILE_ATTR_COMPRESSED) && (dir_ni->vol->major_ver >= 3) && NVolCompression(dir_ni->vol) && (dir_ni->vol->cluster_size <= MAX_COMPRESSION_CLUSTER_SIZE) && (S_ISREG(type) || S_ISDIR(type))) ni->flags |= FILE_ATTR_COMPRESSED; /* Add STANDARD_INFORMATION to inode. */ if (ntfs_attr_add(ni, AT_STANDARD_INFORMATION, AT_UNNAMED, 0, (u8*)si, si_len)) { err = errno; ntfs_log_error("Failed to add STANDARD_INFORMATION " "attribute.\n"); goto err_out; } if (!securid) { if (ntfs_sd_add_everyone(ni)) { err = errno; goto err_out; } rollback_sd = 1; } if (S_ISDIR(type)) { INDEX_ROOT *ir = NULL; INDEX_ENTRY *ie; int ir_len, index_len; /* Create INDEX_ROOT attribute. */ index_len = sizeof(INDEX_HEADER) + sizeof(INDEX_ENTRY_HEADER); ir_len = offsetof(INDEX_ROOT, index) + index_len; ir = ntfs_calloc(ir_len); if (!ir) { err = errno; goto err_out; } ir->type = AT_FILE_NAME; ir->collation_rule = COLLATION_FILE_NAME; ir->index_block_size = cpu_to_le32(ni->vol->indx_record_size); if (ni->vol->cluster_size <= ni->vol->indx_record_size) ir->clusters_per_index_block = ni->vol->indx_record_size >> ni->vol->cluster_size_bits; else ir->clusters_per_index_block = ni->vol->indx_record_size >> NTFS_BLOCK_SIZE_BITS; ir->index.entries_offset = const_cpu_to_le32(sizeof(INDEX_HEADER)); ir->index.index_length = cpu_to_le32(index_len); ir->index.allocated_size = cpu_to_le32(index_len); ie = (INDEX_ENTRY*)((u8*)ir + sizeof(INDEX_ROOT)); ie->length = const_cpu_to_le16(sizeof(INDEX_ENTRY_HEADER)); ie->key_length = const_cpu_to_le16(0); ie->ie_flags = INDEX_ENTRY_END; /* Add INDEX_ROOT attribute to inode. */ if (ntfs_attr_add(ni, AT_INDEX_ROOT, NTFS_INDEX_I30, 4, (u8*)ir, ir_len)) { err = errno; free(ir); ntfs_log_error("Failed to add INDEX_ROOT attribute.\n"); goto err_out; } free(ir); } else { INTX_FILE *data; int data_len; switch (type) { case S_IFBLK: case S_IFCHR: switch (special_files) { case NTFS_FILES_WSL : data_len = 0; data = (INTX_FILE*)NULL; break; default : data_len = offsetof(INTX_FILE, device_end); data = (INTX_FILE*)ntfs_malloc( data_len); if (!data) { err = errno; goto err_out; } data->major = cpu_to_le64(major(dev)); data->minor = cpu_to_le64(minor(dev)); if (type == S_IFBLK) data->magic = INTX_BLOCK_DEVICE; if (type == S_IFCHR) data->magic = INTX_CHARACTER_DEVICE; break; } break; case S_IFLNK: switch (special_files) { case NTFS_FILES_WSL : data_len = 0; data = (INTX_FILE*)NULL; break; default : data_len = sizeof(INTX_FILE_TYPES) + target_len * sizeof(ntfschar); data = (INTX_FILE*)ntfs_malloc( data_len); if (!data) { err = errno; goto err_out; } data->magic = INTX_SYMBOLIC_LINK; memcpy(data->target, target, target_len * sizeof(ntfschar)); break; } break; case S_IFSOCK: data = NULL; if (special_files == NTFS_FILES_WSL) data_len = 0; else data_len = 1; break; default: /* FIFO or regular file. */ data = NULL; data_len = 0; break; } /* Add DATA attribute to inode. */ if (ntfs_attr_add(ni, AT_DATA, AT_UNNAMED, 0, (u8*)data, data_len)) { err = errno; ntfs_log_error("Failed to add DATA attribute.\n"); free(data); goto err_out; } rollback_data = 1; free(data); } /* Create FILE_NAME attribute. */ fn_len = sizeof(FILE_NAME_ATTR) + name_len * sizeof(ntfschar); fn = ntfs_calloc(fn_len); if (!fn) { err = errno; goto err_out; } fn->parent_directory = MK_LE_MREF(dir_ni->mft_no, le16_to_cpu(dir_ni->mrec->sequence_number)); fn->file_name_length = name_len; fn->file_name_type = FILE_NAME_POSIX; if (S_ISDIR(type)) fn->file_attributes = FILE_ATTR_I30_INDEX_PRESENT; if (!S_ISREG(type) && !S_ISDIR(type)) { if (special_files == NTFS_FILES_INTERIX) fn->file_attributes = FILE_ATTR_SYSTEM; } else fn->file_attributes |= ni->flags & FILE_ATTR_COMPRESSED; fn->file_attributes |= FILE_ATTR_ARCHIVE; fn->file_attributes |= ni->flags & FILE_ATTR_HIDDEN; fn->creation_time = ni->creation_time; fn->last_data_change_time = ni->last_data_change_time; fn->last_mft_change_time = ni->last_mft_change_time; fn->last_access_time = ni->last_access_time; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) fn->data_size = fn->allocated_size = const_cpu_to_sle64(0); else { fn->data_size = cpu_to_sle64(ni->data_size); fn->allocated_size = cpu_to_sle64(ni->allocated_size); } memcpy(fn->file_name, name, name_len * sizeof(ntfschar)); /* Add FILE_NAME attribute to inode. */ if (ntfs_attr_add(ni, AT_FILE_NAME, AT_UNNAMED, 0, (u8*)fn, fn_len)) { err = errno; ntfs_log_error("Failed to add FILE_NAME attribute.\n"); goto err_out; } /* Add FILE_NAME attribute to index. */ if (ntfs_index_add_filename(dir_ni, fn, MK_MREF(ni->mft_no, le16_to_cpu(ni->mrec->sequence_number)))) { err = errno; ntfs_log_perror("Failed to add entry to the index"); goto err_out; } rollback_dir = 1; /* Set hard links count and directory flag. */ ni->mrec->link_count = const_cpu_to_le16(1); if (S_ISDIR(type)) ni->mrec->flags |= MFT_RECORD_IS_DIRECTORY; /* Add reparse data */ if (special_files == NTFS_FILES_WSL) { switch (type) { case S_IFLNK : err = ntfs_reparse_set_wsl_symlink(ni, target, target_len); break; case S_IFIFO : case S_IFSOCK : case S_IFCHR : case S_IFBLK : err = ntfs_reparse_set_wsl_not_symlink(ni, type); if (!err) { err = ntfs_ea_set_wsl_not_symlink(ni, type, dev); if (err) ntfs_remove_ntfs_reparse_data(ni); } break; default : err = 0; break; } if (err) { err = errno; goto err_out; } } ntfs_inode_mark_dirty(ni); /* Done! */ free(fn); free(si); ntfs_log_trace("Done.\n"); return ni; err_out: ntfs_log_trace("Failed.\n"); if (rollback_dir) ntfs_index_remove(dir_ni, ni, fn, fn_len); if (rollback_sd) ntfs_attr_remove(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0); if (rollback_data) ntfs_attr_remove(ni, AT_DATA, AT_UNNAMED, 0); /* * Free extent MFT records (should not exist any with current * ntfs_create implementation, but for any case if something will be * changed in the future). */ while (ni->nr_extents) if (ntfs_mft_record_free(ni->vol, *(ni->extent_nis))) { err = errno; ntfs_log_error("Failed to free extent MFT record. " "Leaving inconsistent metadata.\n"); } if (ntfs_mft_record_free(ni->vol, ni)) ntfs_log_error("Failed to free MFT record. " "Leaving inconsistent metadata. Run chkdsk.\n"); free(fn); free(si); errno = err; return NULL; } /** * Some wrappers around __ntfs_create() ... */ ntfs_inode *ntfs_create(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, mode_t type) { if (type != S_IFREG && type != S_IFDIR && type != S_IFIFO && type != S_IFSOCK) { ntfs_log_error("Invalid arguments.\n"); return NULL; } return __ntfs_create(dir_ni, securid, name, name_len, type, 0, NULL, 0); } ntfs_inode *ntfs_create_device(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, mode_t type, dev_t dev) { if (type != S_IFCHR && type != S_IFBLK) { ntfs_log_error("Invalid arguments.\n"); return NULL; } return __ntfs_create(dir_ni, securid, name, name_len, type, dev, NULL, 0); } ntfs_inode *ntfs_create_symlink(ntfs_inode *dir_ni, le32 securid, const ntfschar *name, u8 name_len, const ntfschar *target, int target_len) { if (!target || !target_len) { ntfs_log_error("%s: Invalid argument (%p, %d)\n", __FUNCTION__, target, target_len); return NULL; } return __ntfs_create(dir_ni, securid, name, name_len, S_IFLNK, 0, target, target_len); } int ntfs_check_empty_dir(ntfs_inode *ni) { ntfs_attr *na; int ret = 0; if (!(ni->mrec->flags & MFT_RECORD_IS_DIRECTORY)) return 0; na = ntfs_attr_open(ni, AT_INDEX_ROOT, NTFS_INDEX_I30, 4); if (!na) { errno = EIO; ntfs_log_perror("Failed to open directory"); return -1; } /* Non-empty directory? */ if ((na->data_size != sizeof(INDEX_ROOT) + sizeof(INDEX_ENTRY_HEADER))){ /* Both ENOTEMPTY and EEXIST are ok. We use the more common. */ errno = ENOTEMPTY; ntfs_log_debug("Directory is not empty\n"); ret = -1; } ntfs_attr_close(na); return ret; } static int ntfs_check_unlinkable_dir(ntfs_inode *ni, FILE_NAME_ATTR *fn) { int link_count = le16_to_cpu(ni->mrec->link_count); int ret; ret = ntfs_check_empty_dir(ni); if (!ret || errno != ENOTEMPTY) return ret; /* * Directory is non-empty, so we can unlink only if there is more than * one "real" hard link, i.e. links aren't different DOS and WIN32 names */ if ((link_count == 1) || (link_count == 2 && fn->file_name_type == FILE_NAME_DOS)) { errno = ENOTEMPTY; ntfs_log_debug("Non-empty directory without hard links\n"); goto no_hardlink; } ret = 0; no_hardlink: return ret; } /** * ntfs_delete - delete file or directory from ntfs volume * @ni: ntfs inode for object to delte * @dir_ni: ntfs inode for directory in which delete object * @name: unicode name of the object to delete * @name_len: length of the name in unicode characters * * @ni is always closed after the call to this function (even if it failed), * user does not need to call ntfs_inode_close himself. * * Return 0 on success or -1 on error with errno set to the error code. */ int ntfs_delete(ntfs_volume *vol, const char *pathname, ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, u8 name_len) { ntfs_attr_search_ctx *actx = NULL; FILE_NAME_ATTR *fn = NULL; BOOL looking_for_dos_name = FALSE, looking_for_win32_name = FALSE; BOOL case_sensitive_match = TRUE; int err = 0; #if CACHE_NIDATA_SIZE int i; #endif #if CACHE_INODE_SIZE struct CACHED_INODE item; const char *p; u64 inum = (u64)-1; int count; #endif #if CACHE_LOOKUP_SIZE struct CACHED_LOOKUP lkitem; #endif ntfs_log_trace("Entering.\n"); if (!ni || !dir_ni || !name || !name_len) { ntfs_log_error("Invalid arguments.\n"); errno = EINVAL; goto err_out; } if (ni->nr_extents == -1) ni = ni->base_ni; if (dir_ni->nr_extents == -1) dir_ni = dir_ni->base_ni; /* * Search for FILE_NAME attribute with such name. If it's in POSIX or * WIN32_AND_DOS namespace, then simply remove it from index and inode. * If filename in DOS or in WIN32 namespace, then remove DOS name first, * only then remove WIN32 name. */ actx = ntfs_attr_get_search_ctx(ni, NULL); if (!actx) goto err_out; search: while (!(err = ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, actx))) { #ifdef DEBUG char *s; #endif IGNORE_CASE_BOOL case_sensitive = IGNORE_CASE; fn = (FILE_NAME_ATTR*)((u8*)actx->attr + le16_to_cpu(actx->attr->value_offset)); #ifdef DEBUG s = ntfs_attr_name_get(fn->file_name, fn->file_name_length); ntfs_log_trace("name: '%s' type: %d dos: %d win32: %d " "case: %d\n", s, fn->file_name_type, looking_for_dos_name, looking_for_win32_name, case_sensitive_match); ntfs_attr_name_free(&s); #endif if (looking_for_dos_name) { if (fn->file_name_type == FILE_NAME_DOS) break; else continue; } if (looking_for_win32_name) { if (fn->file_name_type == FILE_NAME_WIN32) break; else continue; } /* Ignore hard links from other directories */ if (dir_ni->mft_no != MREF_LE(fn->parent_directory)) { ntfs_log_debug("MFT record numbers don't match " "(%llu != %llu)\n", (long long unsigned)dir_ni->mft_no, (long long unsigned)MREF_LE(fn->parent_directory)); continue; } if (case_sensitive_match || ((fn->file_name_type == FILE_NAME_POSIX) && NVolCaseSensitive(ni->vol))) case_sensitive = CASE_SENSITIVE; if (ntfs_names_are_equal(fn->file_name, fn->file_name_length, name, name_len, case_sensitive, ni->vol->upcase, ni->vol->upcase_len)){ if (fn->file_name_type == FILE_NAME_WIN32) { looking_for_dos_name = TRUE; ntfs_attr_reinit_search_ctx(actx); continue; } if (fn->file_name_type == FILE_NAME_DOS) looking_for_dos_name = TRUE; break; } } if (err) { /* * If case sensitive search failed, then try once again * ignoring case. */ if (errno == ENOENT && case_sensitive_match) { case_sensitive_match = FALSE; ntfs_attr_reinit_search_ctx(actx); goto search; } goto err_out; } if (ntfs_check_unlinkable_dir(ni, fn) < 0) goto err_out; if (ntfs_index_remove(dir_ni, ni, fn, le32_to_cpu(actx->attr->value_length))) goto err_out; /* * Keep the last name in place, this is useful for undeletion * (Windows also does so), however delete the name if it were * in an extent, to avoid leaving an attribute list. */ if ((ni->mrec->link_count == const_cpu_to_le16(1)) && !actx->base_ntfs_ino) { /* make sure to not loop to another search */ looking_for_dos_name = FALSE; } else { if (ntfs_attr_record_rm(actx)) goto err_out; } ni->mrec->link_count = cpu_to_le16(le16_to_cpu( ni->mrec->link_count) - 1); ntfs_inode_mark_dirty(ni); if (looking_for_dos_name) { looking_for_dos_name = FALSE; looking_for_win32_name = TRUE; ntfs_attr_reinit_search_ctx(actx); goto search; } /* TODO: Update object id, quota and securiry indexes if required. */ /* * If hard link count is not equal to zero then we are done. In other * case there are no reference to this inode left, so we should free all * non-resident attributes and mark all MFT record as not in use. */ #if CACHE_LOOKUP_SIZE /* invalidate entry in lookup cache */ lkitem.name = (const char*)NULL; lkitem.namesize = 0; lkitem.inum = ni->mft_no; lkitem.parent = dir_ni->mft_no; ntfs_invalidate_cache(vol->lookup_cache, GENERIC(&lkitem), lookup_cache_inv_compare, CACHE_NOHASH); #endif #if CACHE_INODE_SIZE inum = ni->mft_no; if (pathname) { /* invalide cache entry, even if there was an error */ /* Remove leading /'s. */ p = pathname; while (*p == PATH_SEP) p++; if (p[0] && (p[strlen(p)-1] == PATH_SEP)) ntfs_log_error("Unnormalized path %s\n",pathname); item.pathname = p; item.varsize = strlen(p); } else { item.pathname = (const char*)NULL; item.varsize = 0; } item.inum = inum; count = ntfs_invalidate_cache(vol->xinode_cache, GENERIC(&item), inode_cache_inv_compare, CACHE_NOHASH); if (pathname && !count) ntfs_log_error("Could not delete inode cache entry for %s\n", pathname); #endif if (ni->mrec->link_count) { ntfs_inode_update_times(ni, NTFS_UPDATE_CTIME); goto ok; } if (ntfs_delete_reparse_index(ni)) { /* * Failed to remove the reparse index : proceed anyway * This is not a critical error, the entry is useless * because of sequence_number, and stopping file deletion * would be much worse as the file is not referenced now. */ err = errno; } if (ntfs_delete_object_id_index(ni)) { /* * Failed to remove the object id index : proceed anyway * This is not a critical error. */ err = errno; } ntfs_attr_reinit_search_ctx(actx); while (!ntfs_attrs_walk(actx)) { if (actx->attr->non_resident) { runlist *rl; rl = ntfs_mapping_pairs_decompress(ni->vol, actx->attr, NULL); if (!rl) { err = errno; ntfs_log_error("Failed to decompress runlist. " "Leaving inconsistent metadata.\n"); continue; } if (ntfs_cluster_free_from_rl(ni->vol, rl)) { err = errno; ntfs_log_error("Failed to free clusters. " "Leaving inconsistent metadata.\n"); continue; } free(rl); } } if (errno != ENOENT) { err = errno; ntfs_log_error("Attribute enumeration failed. " "Probably leaving inconsistent metadata.\n"); } /* All extents should be attached after attribute walk. */ #if CACHE_NIDATA_SIZE /* * Disconnect extents before deleting them, so they are * not wrongly moved to cache through the chainings */ for (i=ni->nr_extents-1; i>=0; i--) { ni->extent_nis[i]->base_ni = (ntfs_inode*)NULL; ni->extent_nis[i]->nr_extents = 0; if (ntfs_mft_record_free(ni->vol, ni->extent_nis[i])) { err = errno; ntfs_log_error("Failed to free extent MFT record. " "Leaving inconsistent metadata.\n"); } } free(ni->extent_nis); ni->nr_extents = 0; ni->extent_nis = (ntfs_inode**)NULL; #else while (ni->nr_extents) if (ntfs_mft_record_free(ni->vol, *(ni->extent_nis))) { err = errno; ntfs_log_error("Failed to free extent MFT record. " "Leaving inconsistent metadata.\n"); } #endif debug_double_inode(ni->mft_no,0); if (ntfs_mft_record_free(ni->vol, ni)) { err = errno; ntfs_log_error("Failed to free base MFT record. " "Leaving inconsistent metadata.\n"); } ni = NULL; ok: ntfs_inode_update_times(dir_ni, NTFS_UPDATE_MCTIME); out: if (actx) ntfs_attr_put_search_ctx(actx); if (ntfs_inode_close(dir_ni) && !err) err = errno; if (ntfs_inode_close(ni) && !err) err = errno; if (err) { errno = err; ntfs_log_debug("Could not delete file: %s\n", strerror(errno)); return -1; } ntfs_log_trace("Done.\n"); return 0; err_out: err = errno; goto out; } /** * ntfs_link - create hard link for file or directory * @ni: ntfs inode for object to create hard link * @dir_ni: ntfs inode for directory in which new link should be placed * @name: unicode name of the new link * @name_len: length of the name in unicode characters * * NOTE: At present we allow creating hardlinks to directories, we use them * in a temporary state during rename. But it's defenitely bad idea to have * hard links to directories as a result of operation. * FIXME: Create internal __ntfs_link that allows hard links to a directories * and external ntfs_link that do not. Write ntfs_rename that uses __ntfs_link. * * Return 0 on success or -1 on error with errno set to the error code. */ static int ntfs_link_i(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, u8 name_len, FILE_NAME_TYPE_FLAGS nametype) { FILE_NAME_ATTR *fn = NULL; int fn_len, err; ntfs_log_trace("Entering.\n"); if (!ni || !dir_ni || !name || !name_len || ni->mft_no == dir_ni->mft_no) { err = EINVAL; ntfs_log_perror("ntfs_link wrong arguments"); goto err_out; } if (NVolHideDotFiles(dir_ni->vol)) { /* Set hidden flag according to the latest name */ if ((name_len > 1) && (name[0] == const_cpu_to_le16('.')) && (name[1] != const_cpu_to_le16('.'))) ni->flags |= FILE_ATTR_HIDDEN; else ni->flags &= ~FILE_ATTR_HIDDEN; } /* Create FILE_NAME attribute. */ fn_len = sizeof(FILE_NAME_ATTR) + name_len * sizeof(ntfschar); fn = ntfs_calloc(fn_len); if (!fn) { err = errno; goto err_out; } fn->parent_directory = MK_LE_MREF(dir_ni->mft_no, le16_to_cpu(dir_ni->mrec->sequence_number)); fn->file_name_length = name_len; fn->file_name_type = nametype; fn->file_attributes = ni->flags; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { fn->file_attributes |= FILE_ATTR_I30_INDEX_PRESENT; fn->data_size = fn->allocated_size = const_cpu_to_sle64(0); } else { fn->allocated_size = cpu_to_sle64(ni->allocated_size); fn->data_size = cpu_to_sle64(ni->data_size); } fn->creation_time = ni->creation_time; fn->last_data_change_time = ni->last_data_change_time; fn->last_mft_change_time = ni->last_mft_change_time; fn->last_access_time = ni->last_access_time; memcpy(fn->file_name, name, name_len * sizeof(ntfschar)); /* Add FILE_NAME attribute to index. */ if (ntfs_index_add_filename(dir_ni, fn, MK_MREF(ni->mft_no, le16_to_cpu(ni->mrec->sequence_number)))) { err = errno; ntfs_log_perror("Failed to add filename to the index"); goto err_out; } /* Add FILE_NAME attribute to inode. */ if (ntfs_attr_add(ni, AT_FILE_NAME, AT_UNNAMED, 0, (u8*)fn, fn_len)) { ntfs_log_error("Failed to add FILE_NAME attribute.\n"); err = errno; /* Try to remove just added attribute from index. */ if (ntfs_index_remove(dir_ni, ni, fn, fn_len)) goto rollback_failed; goto err_out; } /* Increment hard links count. */ ni->mrec->link_count = cpu_to_le16(le16_to_cpu( ni->mrec->link_count) + 1); /* Done! */ ntfs_inode_mark_dirty(ni); free(fn); ntfs_log_trace("Done.\n"); return 0; rollback_failed: ntfs_log_error("Rollback failed. Leaving inconsistent metadata.\n"); err_out: free(fn); errno = err; return -1; } int ntfs_link(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, u8 name_len) { return (ntfs_link_i(ni, dir_ni, name, name_len, FILE_NAME_POSIX)); } /* * Get a parent directory from an inode entry * * This is only used in situations where the path used to access * the current file is not known for sure. The result may be different * from the path when the file is linked in several parent directories. * * Currently this is only used for translating ".." in the target * of a Vista relative symbolic link */ ntfs_inode *ntfs_dir_parent_inode(ntfs_inode *ni) { ntfs_inode *dir_ni = (ntfs_inode*)NULL; u64 inum; FILE_NAME_ATTR *fn; ntfs_attr_search_ctx *ctx; if (ni->mft_no != FILE_root) { /* find the name in the attributes */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return ((ntfs_inode*)NULL); if (!ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* We know this will always be resident. */ fn = (FILE_NAME_ATTR*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); inum = le64_to_cpu(fn->parent_directory); if (inum != (u64)-1) { dir_ni = ntfs_inode_open(ni->vol, MREF(inum)); } } ntfs_attr_put_search_ctx(ctx); } return (dir_ni); } #define MAX_DOS_NAME_LENGTH 12 /* * Get a DOS name for a file in designated directory * * Not allowed if there are several non-dos names (EMLINK) * * Returns size if found * 0 if not found * -1 if there was an error (described by errno) */ static int get_dos_name(ntfs_inode *ni, u64 dnum, ntfschar *dosname) { size_t outsize = 0; int namecount = 0; FILE_NAME_ATTR *fn; ntfs_attr_search_ctx *ctx; /* find the name in the attributes */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; while (!ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* We know this will always be resident. */ fn = (FILE_NAME_ATTR*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); if (fn->file_name_type != FILE_NAME_DOS) namecount++; if ((fn->file_name_type & FILE_NAME_DOS) && (MREF_LE(fn->parent_directory) == dnum)) { /* * Found a DOS or WIN32+DOS name for the entry * copy name, after truncation for safety */ outsize = fn->file_name_length; /* TODO : reject if name is too long ? */ if (outsize > MAX_DOS_NAME_LENGTH) outsize = MAX_DOS_NAME_LENGTH; memcpy(dosname,fn->file_name,outsize*sizeof(ntfschar)); } } ntfs_attr_put_search_ctx(ctx); if ((outsize > 0) && (namecount > 1)) { outsize = -1; errno = EMLINK; /* this error implies there is a dos name */ } return (outsize); } /* * Get a long name for a file in designated directory * * Not allowed if there are several non-dos names (EMLINK) * * Returns size if found * 0 if not found * -1 if there was an error (described by errno) */ static int get_long_name(ntfs_inode *ni, u64 dnum, ntfschar *longname) { size_t outsize = 0; int namecount = 0; FILE_NAME_ATTR *fn; ntfs_attr_search_ctx *ctx; /* find the name in the attributes */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; /* first search for WIN32 or DOS+WIN32 names */ while (!ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* We know this will always be resident. */ fn = (FILE_NAME_ATTR*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); if (fn->file_name_type != FILE_NAME_DOS) namecount++; if ((fn->file_name_type & FILE_NAME_WIN32) && (MREF_LE(fn->parent_directory) == dnum)) { /* * Found a WIN32 or WIN32+DOS name for the entry * copy name */ outsize = fn->file_name_length; memcpy(longname,fn->file_name,outsize*sizeof(ntfschar)); } } if (namecount > 1) { ntfs_attr_put_search_ctx(ctx); errno = EMLINK; return -1; } /* if not found search for POSIX names */ if (!outsize) { ntfs_attr_reinit_search_ctx(ctx); while (!ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { /* We know this will always be resident. */ fn = (FILE_NAME_ATTR*)((u8*)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); if ((fn->file_name_type == FILE_NAME_POSIX) && (MREF_LE(fn->parent_directory) == dnum)) { /* * Found a POSIX name for the entry * copy name */ outsize = fn->file_name_length; memcpy(longname,fn->file_name,outsize*sizeof(ntfschar)); } } } ntfs_attr_put_search_ctx(ctx); return (outsize); } /* * Get the ntfs DOS name into an extended attribute */ int ntfs_get_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni, char *value, size_t size) { int outsize = 0; char *outname = (char*)NULL; u64 dnum; int doslen; ntfschar dosname[MAX_DOS_NAME_LENGTH]; dnum = dir_ni->mft_no; doslen = get_dos_name(ni, dnum, dosname); if (doslen > 0) { /* * Found a DOS name for the entry, make * uppercase and encode into the buffer * if there is enough space */ ntfs_name_upcase(dosname, doslen, ni->vol->upcase, ni->vol->upcase_len); outsize = ntfs_ucstombs(dosname, doslen, &outname, 0); if (outsize < 0) { ntfs_log_error("Cannot represent dosname in current locale.\n"); outsize = -errno; } else { if (value && (outsize <= (int)size)) memcpy(value, outname, outsize); else if (size && (outsize > (int)size)) outsize = -ERANGE; free(outname); } } else { if (doslen == 0) errno = ENODATA; outsize = -errno; } return (outsize); } /* * Change the name space of an existing file or directory * * Returns the old namespace if successful * -1 if an error occurred (described by errno) */ static int set_namespace(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *name, int len, FILE_NAME_TYPE_FLAGS nametype) { ntfs_attr_search_ctx *actx; ntfs_index_context *icx; FILE_NAME_ATTR *fnx; FILE_NAME_ATTR *fn = NULL; BOOL found; int lkup; int ret; ret = -1; actx = ntfs_attr_get_search_ctx(ni, NULL); if (actx) { found = FALSE; do { lkup = ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, actx); if (!lkup) { fn = (FILE_NAME_ATTR*)((u8*)actx->attr + le16_to_cpu(actx->attr->value_offset)); found = (MREF_LE(fn->parent_directory) == dir_ni->mft_no) && !memcmp(fn->file_name, name, len*sizeof(ntfschar)); } } while (!lkup && !found); if (found) { icx = ntfs_index_ctx_get(dir_ni, NTFS_INDEX_I30, 4); if (icx) { lkup = ntfs_index_lookup((char*)fn, len, icx); if (!lkup && icx->data && icx->data_len) { fnx = (FILE_NAME_ATTR*)icx->data; ret = fn->file_name_type; fn->file_name_type = nametype; fnx->file_name_type = nametype; ntfs_inode_mark_dirty(ni); ntfs_index_entry_mark_dirty(icx); } ntfs_index_ctx_put(icx); } } ntfs_attr_put_search_ctx(actx); } return (ret); } /* * Set a DOS name to a file and adjust name spaces * * If the new names are collapsible (same uppercased chars) : * * - the existing DOS name or DOS+Win32 name is made Posix * - if it was a real DOS name, the existing long name is made DOS+Win32 * and the existing DOS name is deleted * - finally the existing long name is made DOS+Win32 unless already done * * If the new names are not collapsible : * * - insert the short name as a DOS name * - delete the old long name or existing short name * - insert the new long name (as a Win32 or DOS+Win32 name) * * Deleting the old long name will not delete the file * provided the old name was in the Posix name space, * because the alternate name has been set before. * * The inodes of file and parent directory are always closed * * Returns 0 if successful * -1 if failed */ static int set_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni, const ntfschar *shortname, int shortlen, const ntfschar *longname, int longlen, const ntfschar *deletename, int deletelen, BOOL existed) { unsigned int linkcount; ntfs_volume *vol; BOOL collapsible; BOOL deleted; BOOL done; FILE_NAME_TYPE_FLAGS oldnametype; u64 dnum; u64 fnum; int res; res = -1; vol = ni->vol; dnum = dir_ni->mft_no; fnum = ni->mft_no; /* save initial link count */ linkcount = le16_to_cpu(ni->mrec->link_count); /* check whether the same name may be used as DOS and WIN32 */ collapsible = ntfs_collapsible_chars(ni->vol, shortname, shortlen, longname, longlen); if (collapsible) { deleted = FALSE; done = FALSE; if (existed) { oldnametype = set_namespace(ni, dir_ni, deletename, deletelen, FILE_NAME_POSIX); if (oldnametype == FILE_NAME_DOS) { if (set_namespace(ni, dir_ni, longname, longlen, FILE_NAME_WIN32_AND_DOS) >= 0) { if (!ntfs_delete(vol, (const char*)NULL, ni, dir_ni, deletename, deletelen)) res = 0; deleted = TRUE; } else done = TRUE; } } if (!deleted) { if (!done && (set_namespace(ni, dir_ni, longname, longlen, FILE_NAME_WIN32_AND_DOS) >= 0)) res = 0; ntfs_inode_update_times(ni, NTFS_UPDATE_CTIME); ntfs_inode_update_times(dir_ni, NTFS_UPDATE_MCTIME); if (ntfs_inode_close_in_dir(ni,dir_ni) && !res) res = -1; if (ntfs_inode_close(dir_ni) && !res) res = -1; } } else { if (!ntfs_link_i(ni, dir_ni, shortname, shortlen, FILE_NAME_DOS) /* make sure a new link was recorded */ && (le16_to_cpu(ni->mrec->link_count) > linkcount)) { /* delete the existing long name or short name */ // is it ok to not provide the path ? if (!ntfs_delete(vol, (char*)NULL, ni, dir_ni, deletename, deletelen)) { /* delete closes the inodes, so have to open again */ dir_ni = ntfs_inode_open(vol, dnum); if (dir_ni) { ni = ntfs_inode_open(vol, fnum); if (ni) { if (!ntfs_link_i(ni, dir_ni, longname, longlen, FILE_NAME_WIN32)) res = 0; if (ntfs_inode_close_in_dir(ni, dir_ni) && !res) res = -1; } if (ntfs_inode_close(dir_ni) && !res) res = -1; } } } else { ntfs_inode_close_in_dir(ni,dir_ni); ntfs_inode_close(dir_ni); } } return (res); } /* * Set the ntfs DOS name into an extended attribute * * The DOS name will be added as another file name attribute * using the existing file name information from the original * name or overwriting the DOS Name if one exists. * * The inode of the file is always closed */ int ntfs_set_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni, const char *value, size_t size, int flags) { int res = 0; int longlen = 0; int shortlen = 0; char newname[3*MAX_DOS_NAME_LENGTH + 1]; ntfschar oldname[MAX_DOS_NAME_LENGTH]; int oldlen; u64 dnum; BOOL closed = FALSE; ntfschar *shortname = NULL; ntfschar longname[NTFS_MAX_NAME_LEN]; /* copy the string to insert a null char, and truncate */ if (size > 3*MAX_DOS_NAME_LENGTH) size = 3*MAX_DOS_NAME_LENGTH; strncpy(newname, value, size); /* a long name may be truncated badly and be untranslatable */ newname[size] = 0; /* convert the string to the NTFS wide chars, and truncate */ shortlen = ntfs_mbstoucs(newname, &shortname); if (shortlen > MAX_DOS_NAME_LENGTH) shortlen = MAX_DOS_NAME_LENGTH; /* Make sure the short name has valid chars. * Note: the short name cannot end with dot or space, but the * corresponding long name can. */ if ((shortlen < 0) || ntfs_forbidden_names(ni->vol,shortname,shortlen,TRUE)) { ntfs_inode_close_in_dir(ni,dir_ni); ntfs_inode_close(dir_ni); res = -errno; return res; } dnum = dir_ni->mft_no; longlen = get_long_name(ni, dnum, longname); if (longlen > 0) { oldlen = get_dos_name(ni, dnum, oldname); if ((oldlen >= 0) && !ntfs_forbidden_names(ni->vol, longname, longlen, FALSE)) { if (oldlen > 0) { if (flags & XATTR_CREATE) { res = -1; errno = EEXIST; } else if ((shortlen == oldlen) && !memcmp(shortname,oldname, oldlen*sizeof(ntfschar))) /* already set, done */ res = 0; else { res = set_dos_name(ni, dir_ni, shortname, shortlen, longname, longlen, oldname, oldlen, TRUE); closed = TRUE; } } else { if (flags & XATTR_REPLACE) { res = -1; errno = ENODATA; } else { res = set_dos_name(ni, dir_ni, shortname, shortlen, longname, longlen, longname, longlen, FALSE); closed = TRUE; } } } else res = -1; } else { res = -1; if (!longlen) errno = ENOENT; } free(shortname); if (!closed) { ntfs_inode_close_in_dir(ni,dir_ni); ntfs_inode_close(dir_ni); } return (res ? -1 : 0); } /* * Delete the ntfs DOS name */ int ntfs_remove_ntfs_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni) { int res; int oldnametype; int longlen = 0; int shortlen; u64 dnum; ntfs_volume *vol; BOOL deleted = FALSE; ntfschar shortname[MAX_DOS_NAME_LENGTH]; ntfschar longname[NTFS_MAX_NAME_LEN]; res = -1; vol = ni->vol; dnum = dir_ni->mft_no; longlen = get_long_name(ni, dnum, longname); if (longlen > 0) { shortlen = get_dos_name(ni, dnum, shortname); if (shortlen >= 0) { /* migrate the long name as Posix */ oldnametype = set_namespace(ni,dir_ni,longname,longlen, FILE_NAME_POSIX); switch (oldnametype) { case FILE_NAME_WIN32_AND_DOS : /* name was Win32+DOS : done */ res = 0; break; case FILE_NAME_DOS : /* name was DOS, make it back to DOS */ set_namespace(ni,dir_ni,longname,longlen, FILE_NAME_DOS); errno = ENOENT; break; case FILE_NAME_WIN32 : /* name was Win32, make it Posix and delete */ if (set_namespace(ni,dir_ni,shortname,shortlen, FILE_NAME_POSIX) >= 0) { if (!ntfs_delete(vol, (const char*)NULL, ni, dir_ni, shortname, shortlen)) res = 0; deleted = TRUE; } else { /* * DOS name has been found, but cannot * migrate to Posix : something bad * has happened */ errno = EIO; ntfs_log_error("Could not change" " DOS name of inode %lld to Posix\n", (long long)ni->mft_no); } break; default : /* name was Posix or not found : error */ errno = ENOENT; break; } } } else { if (!longlen) errno = ENOENT; res = -1; } if (!deleted) { ntfs_inode_close_in_dir(ni,dir_ni); ntfs_inode_close(dir_ni); } return (res); } /* * Increment the count of subdirectories * (excluding entries with a short name) */ static int nlink_increment(void *nlink_ptr, const ntfschar *name __attribute__((unused)), const int len __attribute__((unused)), const int type, const s64 pos __attribute__((unused)), const MFT_REF mref __attribute__((unused)), const unsigned int dt_type) { if ((dt_type == NTFS_DT_DIR) && (type != FILE_NAME_DOS)) (*((int*)nlink_ptr))++; return (0); } /* * Compute the number of hard links according to Posix * For a directory count the subdirectories whose name is not * a short one, but count "." and ".." * Otherwise count the names, excluding the short ones. * * if there is an error, a null count is returned. */ int ntfs_dir_link_cnt(ntfs_inode *ni) { ntfs_attr_search_ctx *actx; FILE_NAME_ATTR *fn; s64 pos; int err = 0; int nlink = 0; if (!ni) { ntfs_log_error("Invalid argument.\n"); errno = EINVAL; goto err_out; } if (ni->nr_extents == -1) ni = ni->base_ni; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { /* * Directory : scan the directory and count * subdirectories whose name is not DOS-only. * The directory names are ignored, but "." and ".." * are taken into account. */ pos = 0; err = ntfs_readdir(ni, &pos, &nlink, nlink_increment); if (err) nlink = 0; } else { /* * Non-directory : search for FILE_NAME attributes, * and count those which are not DOS-only ones. */ actx = ntfs_attr_get_search_ctx(ni, NULL); if (!actx) goto err_out; while (!(err = ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, actx))) { fn = (FILE_NAME_ATTR*)((u8*)actx->attr + le16_to_cpu(actx->attr->value_offset)); if (fn->file_name_type != FILE_NAME_DOS) nlink++; } if (err && (errno != ENOENT)) nlink = 0; ntfs_attr_put_search_ctx(actx); } if (!nlink) ntfs_log_perror("Failed to compute nlink of inode %lld", (long long)ni->mft_no); err_out : return (nlink); } ntfsprogs-plus-1.0.0/libntfs/ea.c000066400000000000000000000306641507404161300167220ustar00rootroot00000000000000/** * ea.c - Processing of EA's * * This module is part of ntfs-3g library * * Copyright (c) 2014-2021 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef MAJOR_IN_MKDEV #include #endif #ifdef MAJOR_IN_SYSMACROS #include #endif #include "types.h" #include "param.h" #include "layout.h" #include "attrib.h" #include "index.h" #include "dir.h" #include "ea.h" #include "misc.h" #include "logging.h" #include "xattrs.h" static const char lxdev[] = "$LXDEV"; static const char lxmod[] = "$LXMOD"; /* * Create a needed attribute (EA or EA_INFORMATION) * * Returns 0 if successful, * -1 otherwise, with errno indicating why it failed. */ static int ntfs_need_ea(ntfs_inode *ni, ATTR_TYPES type, int size, int flags) { u8 dummy; int res; res = 0; if (!ntfs_attr_exist(ni,type, AT_UNNAMED,0)) { if (!(flags & XATTR_REPLACE)) { /* * no needed attribute : add one, * apparently, this does not feed the new value in * Note : NTFS version must be >= 3 */ if (ni->vol->major_ver >= 3) { res = ntfs_attr_add(ni, type, AT_UNNAMED,0,&dummy,(s64)size); if (!res) { NInoFileNameSetDirty(ni); } NInoSetDirty(ni); } else { errno = EOPNOTSUPP; res = -1; } } else { errno = ENODATA; res = -1; } } return (res); } /* * Restore the old EA_INFORMATION or delete the current one, * when EA cannot be updated. * * As this is used in the context of some other error, the caller * is responsible for returning the proper error, and errno is * left unchanged. * Only double errors are logged here. */ static void restore_ea_info(ntfs_attr *nai, const EA_INFORMATION *old_ea_info) { s64 written; int olderrno; olderrno = errno; if (old_ea_info) { written = ntfs_attr_pwrite(nai, 0, sizeof(EA_INFORMATION), old_ea_info); if ((size_t)written != sizeof(EA_INFORMATION)) { ntfs_log_error("Could not restore the EA_INFORMATION," " possible inconsistency in inode %lld\n", (long long)nai->ni->mft_no); } } else { if (ntfs_attr_rm(nai)) { ntfs_log_error("Could not delete the EA_INFORMATION," " possible inconsistency in inode %lld\n", (long long)nai->ni->mft_no); } } errno = olderrno; } /* * Update both EA and EA_INFORMATION */ static int ntfs_update_ea(ntfs_inode *ni, const char *value, size_t size, const EA_INFORMATION *ea_info, const EA_INFORMATION *old_ea_info) { ntfs_attr *na; ntfs_attr *nai; int res; res = 0; nai = ntfs_attr_open(ni, AT_EA_INFORMATION, AT_UNNAMED, 0); if (nai) { na = ntfs_attr_open(ni, AT_EA, AT_UNNAMED, 0); if (na) { /* * Set EA_INFORMATION first, it is easier to * restore the old value, if setting EA fails. */ if (ntfs_attr_pwrite(nai, 0, sizeof(EA_INFORMATION), ea_info) != (s64)sizeof(EA_INFORMATION)) { res = -errno; } else { if (((na->data_size > (s64)size) && ntfs_attr_truncate(na, size)) || (ntfs_attr_pwrite(na, 0, size, value) != (s64)size)) { res = -errno; if (old_ea_info) restore_ea_info(nai, old_ea_info); } } ntfs_attr_close(na); } ntfs_attr_close(nai); } else { res = -errno; } return (res); } /* * Return the existing EA * * The EA_INFORMATION is not examined and the consistency of the * existing EA is not checked. * * If successful, the full attribute is returned unchanged * and its size is returned. * If the designated buffer is too small, the needed size is * returned, and the buffer is left unchanged. * If there is an error, a negative value is returned and errno * is set according to the error. */ int ntfs_get_ntfs_ea(ntfs_inode *ni, char *value, size_t size) { s64 ea_size; void *ea_buf; int res = 0; if (ntfs_attr_exist(ni, AT_EA, AT_UNNAMED, 0)) { ea_buf = ntfs_attr_readall(ni, AT_EA, (ntfschar*)NULL, 0, &ea_size); if (ea_buf) { if (value && (ea_size <= (s64)size)) memcpy(value, ea_buf, ea_size); free(ea_buf); res = ea_size; } else { ntfs_log_error("Failed to read EA from inode %lld\n", (long long)ni->mft_no); errno = ENODATA; res = -errno; } } else { errno = ENODATA; res = -errno; } return (res); } /* * Set a new EA, and set EA_INFORMATION accordingly * * This is roughly the same as ZwSetEaFile() on Windows, however * the "offset to next" of the last EA should not be cleared. * * Consistency of the new EA is first checked. * * EA_INFORMATION is set first, and it is restored to its former * state if setting EA fails. * * Returns 0 if successful * a negative value if an error occurred. */ int ntfs_set_ntfs_ea(ntfs_inode *ni, const char *value, size_t size, int flags) { EA_INFORMATION ea_info; EA_INFORMATION *old_ea_info; s64 old_ea_size; int res; size_t offs; size_t nextoffs; BOOL ok; int ea_count; int ea_packed; const EA_ATTR *p_ea; res = -1; if (value && (size > 0)) { /* do consistency checks */ offs = 0; ok = TRUE; ea_count = 0; ea_packed = 0; nextoffs = 0; while (ok && (offs < size)) { p_ea = (const EA_ATTR*)&value[offs]; nextoffs = offs + le32_to_cpu(p_ea->next_entry_offset); /* null offset to next not allowed */ ok = (nextoffs > offs) && (nextoffs <= size) && !(nextoffs & 3) && p_ea->name_length /* zero sized value are allowed */ && ((offs + offsetof(EA_ATTR,name) + p_ea->name_length + 1 + le16_to_cpu(p_ea->value_length)) <= nextoffs) && ((offs + offsetof(EA_ATTR,name) + p_ea->name_length + 1 + le16_to_cpu(p_ea->value_length)) >= (nextoffs - 3)) && !p_ea->name[p_ea->name_length]; /* name not checked, as chkdsk accepts any chars */ if (ok) { if (p_ea->flags & NEED_EA) ea_count++; /* * Assume ea_packed includes : * 4 bytes for header (flags and lengths) * + name length + 1 * + value length */ ea_packed += 5 + p_ea->name_length + le16_to_cpu(p_ea->value_length); offs = nextoffs; } } /* * EA and REPARSE_POINT compatibility not checked any more, * required by Windows 10, but having both may lead to * problems with earlier versions. */ if (ok) { ea_info.ea_length = cpu_to_le16(ea_packed); ea_info.need_ea_count = cpu_to_le16(ea_count); ea_info.ea_query_length = cpu_to_le32(nextoffs); old_ea_size = 0; old_ea_info = NULL; /* Try to save the old EA_INFORMATION */ if (ntfs_attr_exist(ni, AT_EA_INFORMATION, AT_UNNAMED, 0)) { old_ea_info = ntfs_attr_readall(ni, AT_EA_INFORMATION, (ntfschar*)NULL, 0, &old_ea_size); } /* * no EA or EA_INFORMATION : add them */ if (!ntfs_need_ea(ni, AT_EA_INFORMATION, sizeof(EA_INFORMATION), flags) && !ntfs_need_ea(ni, AT_EA, 0, flags)) { res = ntfs_update_ea(ni, value, size, &ea_info, old_ea_info); } else { res = -errno; } if (old_ea_info) free(old_ea_info); } else { errno = EINVAL; res = -errno; } } else { errno = EINVAL; res = -errno; } return (res); } /* * Remove the EA (including EA_INFORMATION) * * EA_INFORMATION is removed first, and it is restored to its former * state if removing EA fails. * * Returns 0, or -1 if there is a problem */ int ntfs_remove_ntfs_ea(ntfs_inode *ni) { EA_INFORMATION *old_ea_info; s64 old_ea_size; int res; ntfs_attr *na; ntfs_attr *nai; res = 0; if (ni) { /* * open and delete the EA_INFORMATION and the EA */ nai = ntfs_attr_open(ni, AT_EA_INFORMATION, AT_UNNAMED, 0); if (nai) { na = ntfs_attr_open(ni, AT_EA, AT_UNNAMED, 0); if (na) { /* Try to save the old EA_INFORMATION */ old_ea_info = ntfs_attr_readall(ni, AT_EA_INFORMATION, (ntfschar*)NULL, 0, &old_ea_size); res = ntfs_attr_rm(na); NInoFileNameSetDirty(ni); if (!res) { res = ntfs_attr_rm(nai); if (res && old_ea_info) { /* * Failed to remove the EA, try to * restore the EA_INFORMATION */ restore_ea_info(nai, old_ea_info); } } else { ntfs_log_error("Failed to remove the" " EA_INFORMATION from inode %lld\n", (long long)ni->mft_no); } free(old_ea_info); ntfs_attr_close(na); } else { /* EA_INFORMATION present, but no EA */ res = ntfs_attr_rm(nai); NInoFileNameSetDirty(ni); } ntfs_attr_close(nai); } else { errno = ENODATA; res = -1; } NInoSetDirty(ni); } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } /* * Check for the presence of an EA "$LXDEV" (used by WSL) * and return its value as a device address * * Returns zero if successful * -1 if failed, with errno set */ int ntfs_ea_check_wsldev(ntfs_inode *ni, dev_t *rdevp) { const EA_ATTR *p_ea; int bufsize; char *buf; int lth; int res; int offset; int next; BOOL found; struct { le32 major; le32 minor; } device; res = -EOPNOTSUPP; bufsize = 256; /* expected to be enough */ buf = (char*)malloc(bufsize); if (!buf) { ntfs_log_error("Failed to allocate buffer for ea\n"); return -ENOMEM; } lth = ntfs_get_ntfs_ea(ni, buf, bufsize); /* retry if short buf */ if (lth > bufsize) { free(buf); bufsize = lth; buf = (char*)malloc(bufsize); if (buf) lth = ntfs_get_ntfs_ea(ni, buf, bufsize); } if ((lth > 0) && (lth <= bufsize)) { offset = 0; found = FALSE; do { p_ea = (const EA_ATTR*)&buf[offset]; next = le32_to_cpu(p_ea->next_entry_offset); found = ((next > (int)(sizeof(lxdev) + sizeof(device))) && (p_ea->name_length == (sizeof(lxdev) - 1)) && (p_ea->value_length == const_cpu_to_le16(sizeof(device))) && !memcmp(p_ea->name, lxdev, sizeof(lxdev))); if (!found) offset += next; } while (!found && (next > 0) && (offset < lth)); if (found) { /* beware of alignment */ memcpy(&device, &p_ea->name[p_ea->name_length + 1], sizeof(device)); *rdevp = makedev(le32_to_cpu(device.major), le32_to_cpu(device.minor)); res = 0; } } free(buf); return (res); } int ntfs_ea_set_wsl_not_symlink(ntfs_inode *ni, mode_t type, dev_t dev) { le32 mode; struct { le32 major; le32 minor; } device; struct EA_WSL { struct EA_LXMOD { /* always inserted */ EA_ATTR base; char name[sizeof(lxmod)]; char value[sizeof(mode)]; char stuff[3 & -(sizeof(lxmod) + sizeof(mode))]; } mod; struct EA_LXDEV { /* char or block devices only */ EA_ATTR base; char name[sizeof(lxdev)]; char value[sizeof(device)]; char stuff[3 & -(sizeof(lxdev) + sizeof(device))]; } dev; } attr; int len; int res; memset(&attr, 0, sizeof(attr)); mode = cpu_to_le32((u32)(type | 0644)); attr.mod.base.next_entry_offset = const_cpu_to_le32(sizeof(attr.mod)); attr.mod.base.flags = 0; attr.mod.base.name_length = sizeof(lxmod) - 1; attr.mod.base.value_length = const_cpu_to_le16(sizeof(mode)); memcpy(attr.mod.name, lxmod, sizeof(lxmod)); memcpy(attr.mod.value, &mode, sizeof(mode)); len = sizeof(attr.mod); if (S_ISCHR(type) || S_ISBLK(type)) { device.major = cpu_to_le32(major(dev)); device.minor = cpu_to_le32(minor(dev)); attr.dev.base.next_entry_offset = const_cpu_to_le32(sizeof(attr.dev)); attr.dev.base.flags = 0; attr.dev.base.name_length = sizeof(lxdev) - 1; attr.dev.base.value_length = const_cpu_to_le16(sizeof(device)); memcpy(attr.dev.name, lxdev, sizeof(lxdev)); memcpy(attr.dev.value, &device, sizeof(device)); len += sizeof(attr.dev); } res = ntfs_set_ntfs_ea(ni, (char*)&attr, len, 0); return (res); } ntfsprogs-plus-1.0.0/libntfs/efs.c000066400000000000000000000255011507404161300171040ustar00rootroot00000000000000/** * efs.c - Limited processing of encrypted files * * This module is part of ntfs-3g library * * Copyright (c) 2009 Martin Bene * Copyright (c) 2009-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_SYS_SYSMACROS_H #include #endif #include "types.h" #include "debug.h" #include "attrib.h" #include "inode.h" #include "dir.h" #include "efs.h" #include "index.h" #include "logging.h" #include "misc.h" #include "efs.h" #include "xattrs.h" static ntfschar logged_utility_stream_name[] = { const_cpu_to_le16('$'), const_cpu_to_le16('E'), const_cpu_to_le16('F'), const_cpu_to_le16('S'), const_cpu_to_le16(0) } ; /* * Get the ntfs EFS info into an extended attribute */ int ntfs_get_efs_info(ntfs_inode *ni, char *value, size_t size) { EFS_ATTR_HEADER *efs_info; s64 attr_size = 0; if (ni) { if (ni->flags & FILE_ATTR_ENCRYPTED) { efs_info = (EFS_ATTR_HEADER*)ntfs_attr_readall(ni, AT_LOGGED_UTILITY_STREAM,(ntfschar*)NULL, 0, &attr_size); if (efs_info && (le32_to_cpu(efs_info->length) == attr_size)) { if (attr_size <= (s64)size) { if (value) memcpy(value,efs_info,attr_size); else { errno = EFAULT; attr_size = 0; } } else if (size) { errno = ERANGE; attr_size = 0; } free (efs_info); } else { if (efs_info) { free(efs_info); ntfs_log_error("Bad efs_info for inode %lld\n", (long long)ni->mft_no); } else { ntfs_log_error("Could not get efsinfo" " for inode %lld\n", (long long)ni->mft_no); } errno = EIO; attr_size = 0; } } else { errno = ENODATA; ntfs_log_trace("Inode %lld is not encrypted\n", (long long)ni->mft_no); } } return (attr_size ? (int)attr_size : -errno); } /* * Fix all encrypted AT_DATA attributes of an inode * * The fix may require making an attribute non resident, which * requires more space in the MFT record, and may cause some * attribute to be expelled and the full record to be reorganized. * When this happens, the search for data attributes has to be * reinitialized. * * Returns zero if successful. * -1 if there is a problem. */ static int fixup_loop(ntfs_inode *ni) { ntfs_attr_search_ctx *ctx; ntfs_attr *na; ATTR_RECORD *a; BOOL restart; int cnt; int maxcnt; int res = 0; maxcnt = 0; do { restart = FALSE; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) { ntfs_log_error("Failed to get ctx for efs\n"); res = -1; } cnt = 0; while (!restart && !res && !ntfs_attr_lookup(AT_DATA, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { cnt++; a = ctx->attr; na = ntfs_attr_open(ctx->ntfs_ino, AT_DATA, (ntfschar*)((u8*)a + le16_to_cpu(a->name_offset)), a->name_length); if (!na) { ntfs_log_error("can't open DATA Attribute\n"); res = -1; } if (na && !(ctx->attr->flags & ATTR_IS_ENCRYPTED)) { if (!NAttrNonResident(na) && ntfs_attr_make_non_resident(na, ctx)) { /* * ntfs_attr_make_non_resident fails if there * is not enough space in the MFT record. * When this happens, force making non-resident * so that some other attribute is expelled. */ if (ntfs_attr_force_non_resident(na)) { res = -1; } else { /* make sure there is some progress */ if (cnt <= maxcnt) { errno = EIO; ntfs_log_error("Multiple failure" " making non resident\n"); res = -1; } else { ntfs_attr_put_search_ctx(ctx); ctx = (ntfs_attr_search_ctx*)NULL; restart = TRUE; maxcnt = cnt; } } } if (!restart && !res && ntfs_efs_fixup_attribute(ctx, na)) { ntfs_log_error("Error in efs fixup of AT_DATA Attribute\n"); res = -1; } } if (na) ntfs_attr_close(na); } } while (restart && !res); if (ctx) ntfs_attr_put_search_ctx(ctx); return (res); } /* * Set the efs data from an extended attribute * Warning : the new data is not checked * Returns 0, or -1 if there is a problem */ int ntfs_set_efs_info(ntfs_inode *ni, const char *value, size_t size, int flags) { int res; int written; ntfs_attr *na; const EFS_ATTR_HEADER *info_header; res = 0; if (ni && value && size) { if (ni->flags & (FILE_ATTR_ENCRYPTED | FILE_ATTR_COMPRESSED)) { if (ni->flags & FILE_ATTR_ENCRYPTED) { ntfs_log_trace("Inode %lld already encrypted\n", (long long)ni->mft_no); errno = EEXIST; } else { /* * Possible problem : if encrypted file was * restored in a compressed directory, it was * restored as compressed. * TODO : decompress first. */ ntfs_log_error("Inode %lld cannot be encrypted and compressed\n", (long long)ni->mft_no); errno = EIO; } return -1; } info_header = (const EFS_ATTR_HEADER*)value; /* make sure we get a likely efsinfo */ if (le32_to_cpu(info_header->length) != size) { errno = EINVAL; return (-1); } if (!ntfs_attr_exist(ni,AT_LOGGED_UTILITY_STREAM, (ntfschar*)NULL,0)) { if (!(flags & XATTR_REPLACE)) { /* * no logged_utility_stream attribute : add one, * apparently, this does not feed the new value in */ res = ntfs_attr_add(ni,AT_LOGGED_UTILITY_STREAM, logged_utility_stream_name,4, (u8*)NULL,(s64)size); } else { errno = ENODATA; res = -1; } } else { errno = EEXIST; res = -1; } if (!res) { /* * open and update the existing efs data */ na = ntfs_attr_open(ni, AT_LOGGED_UTILITY_STREAM, logged_utility_stream_name, 4); if (na) { /* resize attribute */ res = ntfs_attr_truncate(na, (s64)size); /* overwrite value if any */ if (!res && value) { written = (int)ntfs_attr_pwrite(na, (s64)0, (s64)size, value); if (written != (s64)size) { ntfs_log_error("Failed to " "update efs data\n"); errno = EIO; res = -1; } } ntfs_attr_close(na); } else res = -1; } if (!res) { /* Don't handle AT_DATA Attribute(s) if inode is a directory */ if (!(ni->mrec->flags & MFT_RECORD_IS_DIRECTORY)) { /* iterate over AT_DATA attributes */ /* set encrypted flag, truncate attribute to match padding bytes */ if (fixup_loop(ni)) return -1; } ni->flags |= FILE_ATTR_ENCRYPTED; NInoSetDirty(ni); NInoFileNameSetDirty(ni); } } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } /* * Fixup raw encrypted AT_DATA Attribute * read padding length from last two bytes * truncate attribute, make non-resident, * set data size to match padding length * set ATTR_IS_ENCRYPTED flag on attribute * * Return 0 if successful * -1 if failed (errno tells why) */ int ntfs_efs_fixup_attribute(ntfs_attr_search_ctx *ctx, ntfs_attr *na) { s64 newsize; s64 oldsize; le16 appended_bytes; u16 padding_length; ntfs_inode *ni; BOOL close_ctx = FALSE; if (!na) { ntfs_log_error("no na specified for efs_fixup_attribute\n"); goto err_out; } if (!ctx) { ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (!ctx) { ntfs_log_error("Failed to get ctx for efs\n"); goto err_out; } close_ctx = TRUE; if (ntfs_attr_lookup(AT_DATA, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_error("attr lookup for AT_DATA attribute failed in efs fixup\n"); goto err_out; } } else { if (!NAttrNonResident(na)) { ntfs_log_error("Cannot make non resident" " when a context has been allocated\n"); goto err_out; } } /* no extra bytes are added to void attributes */ oldsize = na->data_size; if (oldsize) { /* make sure size is valid for a raw encrypted stream */ if ((oldsize & 511) != 2) { ntfs_log_error("Bad raw encrypted stream\n"); goto err_out; } /* read padding length from last two bytes of attribute */ if (ntfs_attr_pread(na, oldsize - 2, 2, &appended_bytes) != 2) { ntfs_log_error("Error reading padding length\n"); goto err_out; } padding_length = le16_to_cpu(appended_bytes); if (padding_length > 511 || padding_length > na->data_size-2) { errno = EINVAL; ntfs_log_error("invalid padding length %d for data_size %lld\n", padding_length, (long long)oldsize); goto err_out; } newsize = oldsize - padding_length - 2; /* * truncate attribute to possibly free clusters allocated * for the last two bytes, but do not truncate to new size * to avoid losing useful data */ if (ntfs_attr_truncate(na, oldsize - 2)) { ntfs_log_error("Error truncating attribute\n"); goto err_out; } } else newsize = 0; /* * Encrypted AT_DATA Attributes MUST be non-resident * This has to be done after the attribute is resized, as * resizing down to zero may cause the attribute to be made * resident. */ if (!NAttrNonResident(na) && ntfs_attr_make_non_resident(na, ctx)) { if (!close_ctx || ntfs_attr_force_non_resident(na)) { ntfs_log_error("Error making DATA attribute non-resident\n"); goto err_out; } else { /* * must reinitialize context after forcing * non-resident. We need a context for updating * the state, and at this point, we are sure * the context is not used elsewhere. */ ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(AT_DATA, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_error("attr lookup for AT_DATA attribute failed in efs fixup\n"); goto err_out; } } } ni = na->ni; if (!na->name_len) { ni->data_size = newsize; ni->allocated_size = na->allocated_size; } NInoSetDirty(ni); NInoFileNameSetDirty(ni); ctx->attr->data_size = cpu_to_sle64(newsize); if (sle64_to_cpu(ctx->attr->initialized_size) > newsize) ctx->attr->initialized_size = ctx->attr->data_size; ctx->attr->flags |= ATTR_IS_ENCRYPTED; if (close_ctx) ntfs_attr_put_search_ctx(ctx); return (0); err_out: if (close_ctx && ctx) ntfs_attr_put_search_ctx(ctx); return (-1); } ntfsprogs-plus-1.0.0/libntfs/fsck.c000066400000000000000000000336631507404161300172650ustar00rootroot00000000000000/* SPDX-License-Identifier : GPL-2.0 */ /* fsck.c : common functions for fsck. * Manages MFT bitmap, cluster bitmap, fsck mount */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #ifdef HAVE_LOCALE_H #include #endif #if defined(__sun) && defined (__SVR4) #include #endif #include "fsck.h" #include "debug.h" #include "logging.h" #include "misc.h" #include "bitmap.h" #include "lcnalloc.h" #include "runlist.h" #include "problem.h" u8 zero_bm[NTFS_BUF_SIZE]; /* * function to set fsck mft bitmap value * * vol : ntfs_volume structure * mft_no : mft number to set on mft bitmap * value : 1 if set, 0 if clear */ int ntfs_fsck_set_mftbmp_value(ntfs_volume *vol, u64 mft_no, int value) { u32 bm_i = FB_ROUND_DOWN(mft_no >> NTFSCK_BYTE_TO_BITS); s64 bm_pos = (s64)bm_i << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS); s64 mft_diff = mft_no - bm_pos; if (bm_i >= vol->max_fmb_cnt) { ntfs_log_error("bm_i(%u) exceeded max_fmb_cnt(%"PRIu64")\n", bm_i, vol->max_fmb_cnt); return -EINVAL; } if (!vol->fsck_mft_bitmap[bm_i]) { vol->fsck_mft_bitmap[bm_i] = (u8 *)ntfs_calloc(NTFS_BUF_SIZE); if (!vol->fsck_mft_bitmap[bm_i]) return -ENOMEM; } ntfs_bit_set(vol->fsck_mft_bitmap[bm_i], mft_diff, value); return 0; } /* get fsck mft bitmap */ char ntfs_fsck_mftbmp_get(ntfs_volume *vol, const u64 mft_no) { u32 bm_i = FB_ROUND_DOWN(mft_no >> NTFSCK_BYTE_TO_BITS); s64 bm_pos = (s64)bm_i << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS); if (bm_i >= vol->max_fmb_cnt || !vol->fsck_mft_bitmap[bm_i]) return 0; return ntfs_bit_get(vol->fsck_mft_bitmap[bm_i], mft_no - bm_pos); } /* clear fsck mft bitmap */ int ntfs_fsck_mftbmp_clear(ntfs_volume *vol, u64 mft_no) { return ntfs_fsck_set_mftbmp_value(vol, mft_no, 0); } /* set fsck mft bitmap */ int ntfs_fsck_mftbmp_set(ntfs_volume *vol, u64 mft_no) { return ntfs_fsck_set_mftbmp_value(vol, mft_no, 1); } u8 *ntfs_fsck_find_mftbmp_block(ntfs_volume *vol, s64 pos) { u32 bm_i = FB_ROUND_DOWN(pos); /* mftbmp does not need to consider un-allocated mft bitmap, * cause mft bitmap can be expaned more than initialized_size * of mft_na */ if (bm_i >= vol->max_fmb_cnt || !vol->fsck_mft_bitmap[bm_i]) { memset(zero_bm, 0, NTFS_BUF_SIZE); return zero_bm; } return vol->fsck_mft_bitmap[bm_i]; } void ntfs_fsck_set_bitmap_range(u8 *bm, s64 pos, s64 length, u8 bit) { while (length--) ntfs_bit_set(bm, pos++, bit); } u8 *ntfs_fsck_find_lcnbmp_block(ntfs_volume *vol, s64 pos) { u32 bm_i = FB_ROUND_DOWN(pos); u32 last_idx = FB_ROUND_DOWN((vol->nr_clusters - 1) >> NTFSCK_BYTE_TO_BITS); if (bm_i >= vol->max_flb_cnt || !vol->fsck_lcn_bitmap[bm_i]) { memset(zero_bm, 0, NTFS_BUF_SIZE); /* consider last unused bitmap */ if (bm_i == last_idx) ntfs_fsck_fill_unused_lcnbmp(vol, last_idx, zero_bm); return zero_bm; } /* consider last unused bitmap */ if (bm_i == last_idx) ntfs_fsck_fill_unused_lcnbmp(vol, last_idx, vol->fsck_lcn_bitmap[bm_i]); return vol->fsck_lcn_bitmap[bm_i]; } /* * condition: orig_lcn <= dup_lcn < orig_lcn + orig_len, orig_len > 0 */ int ntfs_fsck_repair_cluster_dup(ntfs_attr *na, runlist *dup_rl) { ntfs_volume *vol; runlist *rl; runlist *alloc_rl; runlist *punch_rl; int rl_size, alloc_size, punch_size; int i, j; if (!na || !na->ni || !dup_rl) return -EINVAL; vol = na->ni->vol; rl = na->rl; for (i = 0; dup_rl[i].length; i++) { ntfs_log_debug("### Start dup_rl[%d]\n", i); /* calculate original cluster runlist size */ for (rl_size = 0; rl[rl_size].length; rl_size++) ; rl_size++; alloc_rl = ntfs_cluster_alloc(vol, dup_rl[i].vcn, dup_rl[i].length, dup_rl[i].lcn + dup_rl[i].length, DATA_ZONE); if (!alloc_rl) { ntfs_log_error("Can' allocated new cluster\n"); return -ENOMEM; } ntfs_log_debug("alloc_rl : allocated new rl\n"); ntfs_debug_runlist_dump(alloc_rl); for (j = 0; alloc_rl[j].length; j++) ; alloc_size = j + 1; rl = ntfs_rl_punch_hole(rl, rl_size, dup_rl[i].vcn, dup_rl[i].length, &punch_rl); ntfs_log_debug("punch_rl: extracted duplication rl\n"); ntfs_debug_runlist_dump(punch_rl); for (j = 0; punch_rl[j].length; j++) ; punch_size = j + 1; ntfs_log_debug("rl: punched original rl\n"); ntfs_debug_runlist_dump(rl); alloc_rl = ntfs_copy_rl_clusters(vol, alloc_rl, alloc_size, punch_rl, punch_size); ntfs_free(punch_rl); punch_rl = NULL; rl = ntfs_runlists_merge(rl, alloc_rl); ntfs_log_debug("merged rl : merged with allocated rl\n"); ntfs_debug_runlist_dump(rl); ntfs_log_debug("### Done dup_rl[%d]\n", i); } na->rl = rl; NAttrSetRunlistDirty(na); return STATUS_OK; } /* * ntfs_fsck_make_dup_runlist: make duplicated runlist, it return runlists * which have duplicated cluster information. * if return NULL, there's no duplicated cluster. */ runlist *ntfs_fsck_make_dup_runlist(runlist *orig_dup_rl, runlist *new_dup_rl) { runlist *dup_rl; int orig_size; int i; ntfs_log_debug("make dup runlist orig_dup_rl dump\n"); if (!orig_dup_rl) { /* * 4K aligned allocation for preventing small fragmentation * index '1' is for runlist end mark */ orig_dup_rl = ntfs_calloc((2 + 0xfff) & ~0xfff); orig_dup_rl[0].lcn = new_dup_rl->lcn; orig_dup_rl[0].vcn = new_dup_rl->vcn; orig_dup_rl[0].length = new_dup_rl->length; orig_dup_rl[1].lcn = LCN_ENOENT; orig_dup_rl[1].vcn = new_dup_rl->vcn + new_dup_rl->length; orig_dup_rl[1].length = 0; ntfs_log_debug("make new orig_dup_rl %p\n", orig_dup_rl); ntfs_debug_runlist_dump(orig_dup_rl); return orig_dup_rl; } for (i = 0; orig_dup_rl[i].length; i++) ; orig_size = i + 1; ntfs_log_debug("orig_dup_rl\n"); ntfs_debug_runlist_dump(orig_dup_rl); dup_rl = ntfs_rl_replace(orig_dup_rl, orig_size, new_dup_rl, 1, orig_size - 1); ntfs_log_debug("appended dup_rl\n"); ntfs_debug_runlist_dump(dup_rl); return dup_rl; } void ntfs_fsck_fill_unused_lcnbmp(ntfs_volume *vol, s64 last_idx, u8 *last_bm) { s64 start_pos; s64 last_bit; s64 last_bit_offset; s64 last_byte_offset; start_pos = last_idx * NTFS_BUF_SIZE; last_bit_offset = vol->nr_clusters - (start_pos << 3); last_byte_offset = last_bit_offset >> 3; /* fill all unused lcnbmp bytes by 1 (bytes over the maximum cluster number) */ if ((last_byte_offset + 1) < NTFS_BUF_SIZE) memset(last_bm + last_byte_offset + 1, 0xff, NTFS_BUF_SIZE - (last_byte_offset + 1)); /* fill all unused lcnbmp bit by 1 (bits over the maximu cluster number) */ last_bit = last_bit_offset - (last_byte_offset << 3); last_bm[last_byte_offset] |= (0xff << last_bit); ntfs_log_trace("last idx %llu, last_bit_offset %llu, last_byte_offset %llu, " "last_bit %llu\n", last_idx, last_bit_offset, last_byte_offset, last_bit); } /* * for a entry of runlists (lcn, length), set/clear lcn bitmap * ^^^ ^^^^^^ * fsck_lcn_bitmap * 0-th s_idx e_idx * |------| |----------------------| |----------------------| * | | ... | | ... | | * | | | |<-- rel_len -->| |<-- rel_len ->| | * |------| |------|---------------| |---------------|------| * | |<---- remain_len (initially length) ----->| * | | | ^^^^^^ * | lcn | last_lcn = lcn + length - 1 * | ^^^ | * | rel_slcn in s_idx idx_slcn = rel_slcn in e_idx * idx_slcn */ int ntfs_fsck_set_lcnbmp_range(ntfs_volume *vol, s64 lcn, s64 length, u8 bit) { /* calculate last lcn (bit) */ s64 last_lcn = lcn + length - 1; /* start index of fsck_lcn_bitmap */ s64 s_idx = FB_ROUND_DOWN(lcn >> NTFSCK_BYTE_TO_BITS); /* end index of fsck_lcn_bitmap */ s64 e_idx = FB_ROUND_DOWN(last_lcn >> NTFSCK_BYTE_TO_BITS); s64 idx_slcn; /* real start lcn of fsck_lcn_bitmap[idx] (bit) */ s64 rel_slcn = lcn; /* relative start lcn in fsck_lcn_bitmap[idx] (bit) */ s64 remain_length = 0; s64 rel_length; /* relative length in fsck_lcn_bitmap[idx] (bit) */ s64 idx; u8 *buf; int i; if (length <= 0) return -EINVAL; remain_length = length; for (idx = s_idx; idx <= e_idx; idx++) { if (!vol->fsck_lcn_bitmap[idx]) { vol->fsck_lcn_bitmap[idx] = (u8 *)ntfs_calloc(NTFS_BUF_SIZE); if (!vol->fsck_lcn_bitmap[idx]) return -ENOMEM; } buf = vol->fsck_lcn_bitmap[idx]; idx_slcn = idx << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS); if (rel_slcn) rel_slcn -= idx_slcn; rel_length = (1 << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS)) - rel_slcn; if (remain_length < rel_length) rel_length = remain_length; for (i = 0; i < rel_length; i++) { if (ntfs_bit_get_and_set(buf, rel_slcn + i, bit)) { if (bit) ntfs_log_error("Cluster Duplication %"PRIu64" - do not fix\n", (idx_slcn + rel_slcn) + i); } } remain_length -= rel_length; if (remain_length <= 0) break; rel_slcn = 0; } return 0; } /* * Check cluster bitmap duplication and set bitmap * If found cluster duplication, it makes runlist about duplication * return it. * If duplication is not found, return NULL * * it will check for rl[rl_idx] (rl[rl_idx].lcn, rl[rl_idx].length), */ runlist *ntfs_fsck_check_and_set_lcnbmp(ntfs_volume *vol, ntfs_attr *na, int rl_idx, u8 bit, runlist *dup_rl) { /* * last_lcn : calclate last lcn (bit)i * rel_slcn : relative start lcn in fsck_lcn_bitmap[idx] (bit) * idx_slcn : start(first) lcn of fsck_lcn_bitmap[idx] (bit) */ LCN lcn, last_lcn, rel_slcn, idx_slcn; VCN vcn, checked_vcn; /* relative length in fsck_lcn_bitmap[idx] (bit) */ s64 length, remain_length, rel_length; runlist tmp_rl[2] = {0, }; runlist *rl; s64 s_idx; /* start index of fsck_lcn_bitmap */ s64 e_idx; /* end index of fsck_lcn_bitmap */ s64 idx; u8 *buf; int i; if (!na || !na->rl || rl_idx < 0) return NULL; rl = na->rl; lcn = rl[rl_idx].lcn; vcn = rl[rl_idx].vcn; length = rl[rl_idx].length; if (length <= 0) return NULL; rel_slcn = lcn; last_lcn = lcn + length - 1; s_idx = FB_ROUND_DOWN(lcn >> NTFSCK_BYTE_TO_BITS); e_idx = FB_ROUND_DOWN(last_lcn >> NTFSCK_BYTE_TO_BITS); remain_length = length; tmp_rl[0].lcn = -1; checked_vcn = 0; for (idx = s_idx; idx <= e_idx; idx++) { if (!vol->fsck_lcn_bitmap[idx]) { vol->fsck_lcn_bitmap[idx] = (u8 *)ntfs_calloc(NTFS_BUF_SIZE); if (!vol->fsck_lcn_bitmap[idx]) { ntfs_log_error("Can't allocate lcn_bitmap buffer\n"); return dup_rl; } } buf = vol->fsck_lcn_bitmap[idx]; /* calculate first lcn of fsck_lcn_bitmap[idx] */ idx_slcn = idx << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS); if (rel_slcn) rel_slcn -= idx_slcn; rel_length = (1 << (NTFS_BUF_SIZE_BITS + NTFSCK_BYTE_TO_BITS)) - rel_slcn; if (remain_length < rel_length) rel_length = remain_length; for (i = 0; i < rel_length; i++) { if (!ntfs_bit_get_and_set(buf, rel_slcn + i, bit)) continue; if (!bit) continue; /* duplicated */ ntfs_log_error("Cluster Duplication %"PRIu64"\n", (idx_slcn + rel_slcn) + i); #ifdef TRUNCATE_DATA /* handle duplicated cluster of AT_DATA */ if (na->type == AT_DATA) { /* TODO: truncate data after duplicated cluster */ continue; } #endif /* handle duplicated cluster of all attribute except AT_DATA */ if (tmp_rl[0].lcn == -1) { /* found first duplicated cluster */ tmp_rl[0].lcn = idx_slcn + rel_slcn + i; tmp_rl[0].vcn = vcn + checked_vcn + i; tmp_rl[0].length = 1; } else if (tmp_rl[0].lcn + tmp_rl[0].length == (idx_slcn + rel_slcn + i)) { /* found contiguous duplicated cluster */ tmp_rl[0].length++; } else { /* found non-contiguous duplicated cluster */ dup_rl = ntfs_fsck_make_dup_runlist(dup_rl, tmp_rl); /* set this duplicated cluster information */ tmp_rl[0].lcn = idx_slcn + rel_slcn + i; tmp_rl[0].vcn = vcn + checked_vcn + i; tmp_rl[0].length = 1; } } remain_length -= rel_length; checked_vcn += rel_length; if (remain_length <= 0) break; rel_slcn = 0; } if (tmp_rl[0].lcn >= 0) { dup_rl = ntfs_fsck_make_dup_runlist(dup_rl, tmp_rl); ntfs_log_debug("Previous check lcn(%"PRIu64") vcn (%"PRIu64") length(%"PRIu64")\n", rl_idx ? rl[rl_idx-1].lcn:0, rl_idx ? rl[rl_idx-1].vcn:0, rl_idx?rl[rl_idx-1].length:0); ntfs_log_debug("Check lcn(%"PRIu64") vcn (%"PRIu64") length(%"PRIu64")\n", lcn, vcn, length); } return dup_rl; } ntfs_volume *ntfs_fsck_mount(const char *path __attribute__((unused)), ntfs_mount_flags flags __attribute__((unused))) { ntfs_volume *vol; vol = ntfs_mount(path, flags); if (!vol) return NULL; /* Initialize fsck lcn bitmap buffer array */ vol->max_flb_cnt = FB_ROUND_DOWN((vol->nr_clusters - 1) >> NTFSCK_BYTE_TO_BITS) + 1; vol->fsck_lcn_bitmap = (u8 **)ntfs_calloc(sizeof(u8 *) * vol->max_flb_cnt); if (!vol->fsck_lcn_bitmap) { ntfs_umount(vol, FALSE); return NULL; } /* Initialize fsck mft bitmap buffer array */ vol->max_fmb_cnt = FB_ROUND_DOWN((vol->mft_na->initialized_size >> vol->mft_record_size_bits) >> NTFSCK_BYTE_TO_BITS) + 1; vol->fsck_mft_bitmap = (u8 **)ntfs_calloc(sizeof(u8 *) * vol->max_fmb_cnt); if (!vol->fsck_mft_bitmap) { free(vol->fsck_lcn_bitmap); ntfs_umount(vol, FALSE); return NULL; } vol->option_flags = flags; vol->lost_found = 0; return vol; } void ntfs_fsck_umount(ntfs_volume *vol) { int bm_i; for (bm_i = 0; bm_i < vol->max_flb_cnt; bm_i++) if (vol->fsck_lcn_bitmap[bm_i]) free(vol->fsck_lcn_bitmap[bm_i]); free(vol->fsck_lcn_bitmap); for (bm_i = 0; bm_i < vol->max_fmb_cnt; bm_i++) if (vol->fsck_mft_bitmap[bm_i]) free(vol->fsck_mft_bitmap[bm_i]); free(vol->fsck_mft_bitmap); ntfs_umount(vol, FALSE); } ntfsprogs-plus-1.0.0/libntfs/index.c000066400000000000000000001643141507404161300174440ustar00rootroot00000000000000/** * index.c - NTFS index handling. Originated from the Linux-NTFS project. * * Copyright (c) 2004-2005 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2005-2006 Yura Pakhuchiy * Copyright (c) 2005-2008 Szabolcs Szakacsits * Copyright (c) 2007-2021 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "attrib.h" #include "debug.h" #include "index.h" #include "collate.h" #include "mst.h" #include "dir.h" #include "logging.h" #include "bitmap.h" #include "reparse.h" #include "misc.h" #include "problem.h" /** * ntfs_index_entry_mark_dirty - mark an index entry dirty * @ictx: ntfs index context describing the index entry * * Mark the index entry described by the index entry context @ictx dirty. * * If the index entry is in the index root attribute, simply mark the inode * containing the index root attribute dirty. This ensures the mftrecord, and * hence the index root attribute, will be written out to disk later. * * If the index entry is in an index block belonging to the index allocation * attribute, set ib_dirty to TRUE, thus index block will be updated during * ntfs_index_ctx_put. */ void ntfs_index_entry_mark_dirty(ntfs_index_context *ictx) { if (ictx->is_in_root) ntfs_inode_mark_dirty(ictx->actx->ntfs_ino); else ictx->ib_dirty = TRUE; } s64 ntfs_ib_vcn_to_pos(ntfs_index_context *icx, VCN vcn) { return vcn << icx->vcn_size_bits; } static VCN ntfs_ib_pos_to_vcn(ntfs_index_context *icx, s64 pos) { return pos >> icx->vcn_size_bits; } int ntfs_ib_write(ntfs_index_context *icx, INDEX_BLOCK *ib) { s64 ret, vcn = sle64_to_cpu(ib->index_block_vcn); ntfs_log_trace("vcn: %lld\n", (long long)vcn); ret = ntfs_attr_mst_pwrite(icx->ia_na, ntfs_ib_vcn_to_pos(icx, vcn), 1, icx->block_size, ib); if (ret != 1) { ntfs_log_perror("Failed to write index block %lld, inode %llu", (long long)vcn, (unsigned long long)icx->ni->mft_no); return STATUS_ERROR; } return STATUS_OK; } static int ntfs_icx_ib_write(ntfs_index_context *icx) { if (ntfs_ib_write(icx, icx->ib)) return STATUS_ERROR; icx->ib_dirty = FALSE; return STATUS_OK; } /** * ntfs_index_ctx_get - allocate and initialize a new index context * @ni: ntfs inode with which to initialize the context * @name: name of the which context describes * @name_len: length of the index name * * Allocate a new index context, initialize it with @ni and return it. * Return NULL if allocation failed. */ ntfs_index_context *ntfs_index_ctx_get(ntfs_inode *ni, ntfschar *name, u32 name_len) { ntfs_index_context *icx; ntfs_log_trace("Entering\n"); if (!ni) { errno = EINVAL; return NULL; } if (ni->nr_extents == -1) ni = ni->base_ni; icx = ntfs_calloc(sizeof(ntfs_index_context)); if (icx) *icx = (ntfs_index_context) { .ni = ni, .name = name, .name_len = name_len, }; return icx; } static void ntfs_index_ctx_free(ntfs_index_context *icx) { ntfs_log_trace("Entering\n"); if (!icx->bad_index && !icx->entry) { if (icx->actx) ntfs_attr_put_search_ctx(icx->actx); if (icx->ib) free(icx->ib); if (icx->ia_na) ntfs_attr_close(icx->ia_na); return; } if (icx->actx) ntfs_attr_put_search_ctx(icx->actx); if (!icx->is_in_root) { if (icx->ib_dirty) { /* FIXME: Error handling!!! */ ntfs_ib_write(icx, icx->ib); } free(icx->ib); } ntfs_attr_close(icx->ia_na); } /** * ntfs_index_ctx_put - release an index context * @icx: index context to free * * Release the index context @icx, releasing all associated resources. */ void ntfs_index_ctx_put(ntfs_index_context *icx) { ntfs_index_ctx_free(icx); free(icx); } /** * ntfs_index_ctx_reinit - reinitialize an index context * @icx: index context to reinitialize * * Reinitialize the index context @icx so it can be used for ntfs_index_lookup. */ void ntfs_index_ctx_reinit(ntfs_index_context *icx) { ntfs_log_trace("Entering\n"); ntfs_index_ctx_free(icx); *icx = (ntfs_index_context) { .ni = icx->ni, .name = icx->name, .name_len = icx->name_len, }; } static leVCN *ntfs_ie_get_vcn_addr(INDEX_ENTRY *ie) { return (leVCN *)((u8 *)ie + le16_to_cpu(ie->length) - sizeof(leVCN)); } /** * Get the subnode vcn to which the index entry refers. */ VCN ntfs_ie_get_vcn(INDEX_ENTRY *ie) { return sle64_to_cpup(ntfs_ie_get_vcn_addr(ie)); } static INDEX_ENTRY *ntfs_ie_get_first(INDEX_HEADER *ih) { return (INDEX_ENTRY *)((u8 *)ih + le32_to_cpu(ih->entries_offset)); } static INDEX_ENTRY *ntfs_ie_get_next(INDEX_ENTRY *ie) { return (INDEX_ENTRY *)((char *)ie + le16_to_cpu(ie->length)); } static u8 *ntfs_ie_get_end(INDEX_HEADER *ih) { /* FIXME: check if it isn't overflowing the index block size */ return (u8 *)ih + le32_to_cpu(ih->index_length); } static int ntfs_ie_end(INDEX_ENTRY *ie) { return ie->ie_flags & INDEX_ENTRY_END || !ie->length; } /** * Find the last entry in the index block */ static INDEX_ENTRY *ntfs_ie_get_last(INDEX_ENTRY *ie, char *ies_end) { ntfs_log_trace("Entering\n"); while ((char *)ie < ies_end && !ntfs_ie_end(ie)) ie = ntfs_ie_get_next(ie); return ie; } static INDEX_ENTRY *ntfs_ie_get_by_pos(INDEX_HEADER *ih, int pos) { INDEX_ENTRY *ie; ntfs_log_trace("pos: %d\n", pos); ie = ntfs_ie_get_first(ih); while (pos-- > 0) ie = ntfs_ie_get_next(ie); return ie; } static INDEX_ENTRY *ntfs_ie_prev(INDEX_HEADER *ih, INDEX_ENTRY *ie) { INDEX_ENTRY *ie_prev = NULL; INDEX_ENTRY *tmp; ntfs_log_trace("Entering\n"); tmp = ntfs_ie_get_first(ih); while (tmp != ie) { ie_prev = tmp; tmp = ntfs_ie_get_next(tmp); } return ie_prev; } char *ntfs_ie_filename_get(INDEX_ENTRY *ie) { FILE_NAME_ATTR *fn; fn = (FILE_NAME_ATTR *)&ie->key; return ntfs_attr_name_get(fn->file_name, fn->file_name_length); } void ntfs_ie_filename_dump(INDEX_ENTRY *ie) { char *s; s = ntfs_ie_filename_get(ie); ntfs_log_debug("'%s' ", s); ntfs_attr_name_free(&s); } void ntfs_ih_filename_dump(INDEX_HEADER *ih) { INDEX_ENTRY *ie; ntfs_log_trace("Entering\n"); ie = ntfs_ie_get_first(ih); while (!ntfs_ie_end(ie)) { ntfs_ie_filename_dump(ie); ie = ntfs_ie_get_next(ie); } } static int ntfs_ih_numof_entries(INDEX_HEADER *ih) { int n; INDEX_ENTRY *ie; u8 *end; ntfs_log_trace("Entering\n"); end = ntfs_ie_get_end(ih); ie = ntfs_ie_get_first(ih); for (n = 0; !ntfs_ie_end(ie) && (u8 *)ie < end; n++) ie = ntfs_ie_get_next(ie); return n; } static int ntfs_ih_one_entry(INDEX_HEADER *ih) { return (ntfs_ih_numof_entries(ih) == 1); } static int ntfs_ih_zero_entry(INDEX_HEADER *ih) { return (ntfs_ih_numof_entries(ih) == 0); } static void ntfs_ie_delete(INDEX_HEADER *ih, INDEX_ENTRY *ie) { u32 new_size; ntfs_log_trace("Entering\n"); new_size = le32_to_cpu(ih->index_length) - le16_to_cpu(ie->length); ih->index_length = cpu_to_le32(new_size); memmove(ie, (u8 *)ie + le16_to_cpu(ie->length), new_size - ((u8 *)ie - (u8 *)ih)); } static void ntfs_ie_set_vcn(INDEX_ENTRY *ie, VCN vcn) { *ntfs_ie_get_vcn_addr(ie) = cpu_to_sle64(vcn); } /** * Insert @ie index entry at @pos entry. Used @ih values should be ok already. */ static void ntfs_ie_insert(INDEX_HEADER *ih, INDEX_ENTRY *ie, INDEX_ENTRY *pos) { int ie_size = le16_to_cpu(ie->length); ntfs_log_trace("Entering\n"); ih->index_length = cpu_to_le32(le32_to_cpu(ih->index_length) + ie_size); memmove((u8 *)pos + ie_size, pos, le32_to_cpu(ih->index_length) - ((u8 *)pos - (u8 *)ih) - ie_size); memcpy(pos, ie, ie_size); } INDEX_ENTRY *ntfs_ie_dup(INDEX_ENTRY *ie) { INDEX_ENTRY *dup; ntfs_log_trace("Entering\n"); dup = ntfs_malloc(le16_to_cpu(ie->length)); if (dup) memcpy(dup, ie, le16_to_cpu(ie->length)); return dup; } static INDEX_ENTRY *ntfs_ie_dup_novcn(INDEX_ENTRY *ie) { INDEX_ENTRY *dup; int size = le16_to_cpu(ie->length); ntfs_log_trace("Entering\n"); if (ie->ie_flags & INDEX_ENTRY_NODE) size -= sizeof(VCN); dup = ntfs_malloc(size); if (dup) { memcpy(dup, ie, size); dup->ie_flags &= ~INDEX_ENTRY_NODE; dup->length = cpu_to_le16(size); } return dup; } INDEX_ROOT *ntfs_ir_lookup(ntfs_inode *ni, ntfschar *name, u32 name_len, ntfs_attr_search_ctx **ctx) { ATTR_RECORD *a; INDEX_ROOT *ir = NULL; ntfs_log_trace("Entering\n"); *ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!*ctx) return NULL; if (ntfs_attr_lookup(AT_INDEX_ROOT, name, name_len, CASE_SENSITIVE, 0, NULL, 0, *ctx)) { ntfs_log_perror("Failed to lookup $INDEX_ROOT"); goto err_out; } a = (*ctx)->attr; if (a->non_resident) { errno = EINVAL; ntfs_log_perror("Non-resident $INDEX_ROOT detected"); goto err_out; } ir = (INDEX_ROOT *)((char *)a + le16_to_cpu(a->value_offset)); err_out: if (!ir) { ntfs_attr_put_search_ctx(*ctx); *ctx = NULL; } return ir; } INDEX_ROOT *ntfs_ir_lookup2(ntfs_inode *ni, ntfschar *name, u32 len) { ntfs_attr_search_ctx *ctx; INDEX_ROOT *ir; ir = ntfs_ir_lookup(ni, name, len, &ctx); if (ir) ntfs_attr_put_search_ctx(ctx); return ir; } /* * Check the consistency of an index block * * Make sure the index block does not overflow from the index record. * The size of block is assumed to have been checked to be what is * defined in the index root. * * Returns 0 if no error was found * -1 otherwise (with errno unchanged) * * |<--->| offsetof(INDEX_BLOCK, index) * | |<--->| sizeof(INDEX_HEADER) * | | | * | | | seq index entries unused * |=====|=====|=====|===========================|==============| * | | | | | * | |<--------->| entries_offset | | * | |<---------------- index_length ------->| | * | |<--------------------- allocated_size --------------->| * |<--------------------------- block_size ------------------->| * * size(INDEX_HEADER) <= ent_offset < ind_length <= alloc_size < bk_size */ int ntfs_index_block_inconsistent(ntfs_volume *vol, ntfs_attr *ia_na, INDEX_BLOCK *ib, u32 block_size, u64 inum, VCN vcn) { INDEX_HEADER *ih = &ib->index; u32 ib_size = (unsigned)le32_to_cpu(ih->allocated_size) + offsetof(INDEX_BLOCK, index); BOOL fixed = FALSE; problem_context_t pctx = {0, }; ntfs_init_problem_ctx(&pctx, ia_na->ni, ia_na, NULL, NULL, NULL, NULL, NULL); pctx.vcn = vcn; if (!ntfs_is_indx_record(ib->magic)) { ntfs_print_problem(vol, PR_IA_MAGIC_CORRUPTED, &pctx); fixed = TRUE; } if (sle64_to_cpu(ib->index_block_vcn) != vcn) { ntfs_log_error("%sCorrupt index block: VCN (%lld) is different " "from expected VCN (%lld) in inode %llu\n", fixed == TRUE ? "\n" : "", (long long)sle64_to_cpu(ib->index_block_vcn), (long long)vcn, (unsigned long long)inum); return -1; } if (ib_size != block_size) { ntfs_log_error("%sCorrupt index block : VCN (%lld) of inode %llu " "has a size (%u) differing from the index " "specified size (%u)\n", fixed == TRUE ? "\n" : "", (long long)vcn, (unsigned long long)inum, ib_size, (unsigned int)block_size); return -1; } if (le32_to_cpu(ih->entries_offset) < sizeof(INDEX_HEADER)) { ntfs_log_error("%sInvalid index entry offset in inode %lld\n", fixed == TRUE ? "\n" : "", (unsigned long long)inum); return -1; } if (le32_to_cpu(ih->index_length) <= le32_to_cpu(ih->entries_offset)) { ntfs_log_error("%sNo space for index entries in inode %lld\n", fixed == TRUE ? "\n" : "", (unsigned long long)inum); return -1; } if ((le32_to_cpu(ih->index_length) > le32_to_cpu(ih->allocated_size)) || (le32_to_cpu(ih->index_length) > block_size)) { ntfs_log_error("%sindex length of %lld is too big\n", fixed == TRUE ? "\n" : "", (unsigned long long)inum); return -1; } if (le32_to_cpu(ih->allocated_size) < le32_to_cpu(ih->index_length)) { ntfs_log_error("%sIndex entries overflow in inode %lld\n", fixed == TRUE ? "\n" : "", (unsigned long long)inum); return -1; } if (fixed && ntfs_ask_repair(vol)) { u8 vcn_size_bits; ib->magic = magic_INDX; if (vol->cluster_size <= block_size) vcn_size_bits = vol->cluster_size_bits; else vcn_size_bits = NTFS_BLOCK_SIZE_BITS; if (ntfs_attr_mst_pwrite(ia_na, vcn << vcn_size_bits, 1, block_size, (u8 *)ib) != 1) return -1; } return (0); } static ntfs_attr *ntfs_ia_open(ntfs_index_context *icx, ntfs_inode *ni) { ntfs_attr *na; na = ntfs_attr_open(ni, AT_INDEX_ALLOCATION, icx->name, icx->name_len); if (!na) { ntfs_log_perror("Failed to open index allocation of inode " "%llu", (unsigned long long)ni->mft_no); return NULL; } return na; } /* * Check the consistency of an index entry * * Make sure data and key do not overflow from entry. * As a side effect, an entry with zero length is rejected. * This entry must be a full one (no INDEX_ENTRY_END flag), and its * length must have been checked beforehand to not overflow from the * index record. * * Returns 0 if no error was found * -1 otherwise (with errno unchanged) */ int ntfs_index_entry_inconsistent(ntfs_volume *vol, INDEX_ENTRY *ie, COLLATION_RULES collation_rule, u64 inum, ntfs_index_context *ictx) { int ret = 0; problem_context_t pctx = {0, }; if (!ie) return 0; if (ictx) { pctx.ictx = ictx; pctx.ni = ictx->ni; } pctx.inum = inum; if (ie->length == 0 && ie->key_length == 0) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_IE_ZERO_LENGTH, &pctx)) { ie->length = cpu_to_le16(sizeof(INDEX_ENTRY_HEADER)); ie->ie_flags = INDEX_ENTRY_END; ret = 1; fsck_err_fixed(); } else return -1; } if (ie->length == cpu_to_le16(sizeof(INDEX_ENTRY_HEADER)) && !ie->ie_flags) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_IE_END_FLAG_CORRUPTED, &pctx)) { ie->ie_flags = INDEX_ENTRY_END; ret = 1; fsck_err_fixed(); } else return -1; } if (ie->ie_flags & INDEX_ENTRY_NODE && ictx) { VCN vcn = ntfs_ie_get_vcn(ie); s64 data_size = (vcn + 1) << ictx->vcn_size_bits; if (!ictx->ia_na) { ictx->ia_na = ntfs_ia_open(ictx, ictx->ni); if (!ictx->ia_na) return 0; } if (data_size > ictx->ia_na->data_size) { ntfs_log_error("VCN(%llu) in INDEX NODE exceed data_size of ia attr\n", (unsigned long long)vcn); return -1; } } if (ie->ie_flags & INDEX_ENTRY_NODE) { if (((le16_to_cpu(ie->key_length) + offsetof(INDEX_ENTRY, key) + 7) & ~7) != (le16_to_cpu(ie->length) - 8)) { /* TODO: need to fix it */ ntfs_log_error("there is no vcn space in index node\n"); return -1; } } if (((le16_to_cpu(ie->key_length) + offsetof(INDEX_ENTRY, key) + 7) & ~7) == (le16_to_cpu(ie->length) - 8)) { if (!(ie->ie_flags & INDEX_ENTRY_NODE)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_IE_FLAG_SUB_NODE_CORRUPTED, &pctx)) { ie->ie_flags |= INDEX_ENTRY_NODE; fsck_err_fixed(); ret = 1; } else return -1; } } if (ie->ie_flags & INDEX_ENTRY_END) return 0; if (ie->key_length && ((le16_to_cpu(ie->key_length) + offsetof(INDEX_ENTRY, key)) > le16_to_cpu(ie->length))) { ntfs_log_error("Overflow from index entry in inode %lld", (long long)inum); ret = -1; } else { if (collation_rule == COLLATION_FILE_NAME) { if ((offsetof(INDEX_ENTRY, key.file_name.file_name) + ie->key.file_name.file_name_length * sizeof(ntfschar)) > le16_to_cpu(ie->length)) { ntfs_log_error("File name overflow from index" " entry in inode %lld", (long long)inum); ret = -1; } } else { if (ie->data_length && ((le16_to_cpu(ie->data_offset) + le16_to_cpu(ie->data_length)) > le16_to_cpu(ie->length))) { ntfs_log_error("Data overflow from index" " entry in inode %lld", (long long)inum); ret = -1; } } } return (ret); } /** * Find a key in the index block. * * Return values: * STATUS_OK with errno set to ESUCCESS if we know for sure that the * entry exists and @ie_out points to this entry. * STATUS_NOT_FOUND with errno set to ENOENT if we know for sure the * entry doesn't exist and @ie_out is the insertion point. * STATUS_KEEP_SEARCHING if we can't answer the above question and * @vcn will contain the node index block. * STATUS_ERROR with errno set if on unexpected error during lookup. */ static int ntfs_ie_lookup(const void *key, const int key_len, ntfs_index_context *icx, INDEX_HEADER *ih, VCN *vcn, INDEX_ENTRY **ie_out) { INDEX_ENTRY *ie; u8 *index_end; int rc, item = 0; ntfs_log_trace("Entering\n"); index_end = ntfs_ie_get_end(ih); /* * Loop until we exceed valid memory (corruption case) or until we * reach the last entry. */ for (ie = ntfs_ie_get_first(ih); ; ie = ntfs_ie_get_next(ie)) { /* Bounds checks. */ if ((u8 *)ie + sizeof(INDEX_ENTRY_HEADER) > index_end || (u8 *)ie + le16_to_cpu(ie->length) > index_end) { errno = ERANGE; ntfs_log_error("Index entry out of bounds in inode " "%llu.\n", (unsigned long long)icx->ni->mft_no); return STATUS_ERROR; } /* Make sure key and data do not overflow from entry */ rc = ntfs_index_entry_inconsistent(icx->ni->vol, ie, icx->ir->collation_rule, icx->ni->mft_no, icx); if (rc < 0) { errno = EIO; return STATUS_ERROR; } /* * The last entry cannot contain a key. It can however contain * a pointer to a child node in the B+tree so we just break out. */ if (ntfs_ie_end(ie)) break; /* * Not a perfect match, need to do full blown collation so we * know which way in the B+tree we have to go. */ if (!icx->collate) { ntfs_log_error("Collation function not defined\n"); errno = EOPNOTSUPP; return STATUS_ERROR; } rc = icx->collate(icx->ni->vol, key, key_len, &ie->key, le16_to_cpu(ie->key_length)); if (rc == NTFS_COLLATION_ERROR) { ntfs_log_error("Collation error. Perhaps a filename " "contains invalid characters?\n"); errno = ERANGE; return STATUS_ERROR; } /* * If @key collates before the key of the current entry, there * is definitely no such key in this index but we might need to * descend into the B+tree so we just break out of the loop. */ if (rc == -1) break; if (!rc) { *ie_out = ie; errno = 0; icx->parent_pos[icx->pindex] = item; return STATUS_OK; } item++; } /* * We have finished with this index block without success. Check for the * presence of a child node and if not present return with errno ENOENT, * otherwise we will keep searching in another index block. */ if (!(ie->ie_flags & INDEX_ENTRY_NODE)) { ntfs_log_debug("Index entry wasn't found.\n"); *ie_out = ie; errno = ENOENT; return STATUS_NOT_FOUND; } /* Get the starting vcn of the index_block holding the child node. */ *vcn = ntfs_ie_get_vcn(ie); if (*vcn < 0) { errno = EINVAL; ntfs_log_perror("Negative vcn in inode %llu", (unsigned long long)icx->ni->mft_no); return STATUS_ERROR; } ntfs_log_trace("Parent entry number %d\n", item); icx->parent_pos[icx->pindex] = item; return STATUS_KEEP_SEARCHING; } int ntfs_ib_read(ntfs_index_context *icx, VCN vcn, INDEX_BLOCK *dst) { s64 pos, ret; ntfs_log_trace("vcn: %lld\n", (long long)vcn); pos = ntfs_ib_vcn_to_pos(icx, vcn); ret = ntfs_attr_mst_pread(icx->ia_na, pos, 1, icx->block_size, (u8 *)dst); if (ret != 1) { if (ret == -1) ntfs_log_perror("Failed to read index block"); else ntfs_log_error("Failed(%lld) to read full index block at " "%lld\n", (long long)ret, (long long)pos); return -1; } if (ntfs_index_block_inconsistent(icx->ni->vol, icx->ia_na, (INDEX_BLOCK*)dst, icx->block_size, icx->ia_na->ni->mft_no, vcn)) { errno = EIO; return -1; } return 0; } static int ntfs_icx_parent_inc(ntfs_index_context *icx) { icx->pindex++; if (icx->pindex >= MAX_PARENT_VCN) { errno = EOPNOTSUPP; ntfs_log_perror("Index is over %d level deep", MAX_PARENT_VCN); return STATUS_ERROR; } return STATUS_OK; } static int ntfs_icx_parent_dec(ntfs_index_context *icx) { icx->pindex--; if (icx->pindex < 0) { errno = EINVAL; ntfs_log_perror("Corrupt index pointer (%d)", icx->pindex); return STATUS_ERROR; } return STATUS_OK; } /** * ntfs_index_lookup - find a key in an index and return its index entry * @key: [IN] key for which to search in the index * @key_len: [IN] length of @key in bytes * @icx: [IN/OUT] context describing the index and the returned entry * * Before calling ntfs_index_lookup(), @icx must have been obtained from a * call to ntfs_index_ctx_get(). * * Look for the @key in the index specified by the index lookup context @icx. * ntfs_index_lookup() walks the contents of the index looking for the @key. * * If the @key is found in the index, 0 is returned and @icx is setup to * describe the index entry containing the matching @key. @icx->entry is the * index entry and @icx->data and @icx->data_len are the index entry data and * its length in bytes, respectively. * * If the @key is not found in the index, -1 is returned, errno = ENOENT and * @icx is setup to describe the index entry whose key collates immediately * after the search @key, i.e. this is the position in the index at which * an index entry with a key of @key would need to be inserted. * * If an error occurs return -1, set errno to error code and @icx is left * untouched. * * When finished with the entry and its data, call ntfs_index_ctx_put() to free * the context and other associated resources. * * If the index entry was modified, call ntfs_index_entry_mark_dirty() before * the call to ntfs_index_ctx_put() to ensure that the changes are written * to disk. */ int ntfs_index_lookup(const void *key, const int key_len, ntfs_index_context *icx) { VCN old_vcn, vcn; ntfs_inode *ni = icx->ni; INDEX_ROOT *ir; INDEX_ENTRY *ie; INDEX_BLOCK *ib = NULL; int ret, err = 0; ntfs_log_trace("Entering\n"); if (!key || key_len <= 0) { errno = EINVAL; ntfs_log_perror("key: %p key_len: %d", key, key_len); return -1; } ir = ntfs_ir_lookup(ni, icx->name, icx->name_len, &icx->actx); if (!ir) { if (errno == ENOENT) errno = EIO; return -1; } icx->block_size = le32_to_cpu(ir->index_block_size); if (icx->block_size < NTFS_BLOCK_SIZE) { errno = EINVAL; ntfs_log_perror("Index block size (%d) is smaller than the " "sector size (%d)", icx->block_size, NTFS_BLOCK_SIZE); goto err_out; } if (ni->vol->cluster_size <= icx->block_size) icx->vcn_size_bits = ni->vol->cluster_size_bits; else icx->vcn_size_bits = NTFS_BLOCK_SIZE_BITS; /* get the appropriate collation function */ icx->ir = ir; icx->collate = ntfs_get_collate_function(ir->collation_rule); if (!icx->collate) { err = errno = EOPNOTSUPP; ntfs_log_perror("Unknown collation rule 0x%x", (unsigned)le32_to_cpu(ir->collation_rule)); goto err_out; } old_vcn = VCN_INDEX_ROOT_PARENT; ret = ntfs_ie_lookup(key, key_len, icx, &ir->index, &vcn, &ie); if (ret == STATUS_ERROR) { err = errno; goto err_lookup; } icx->ir = ir; if (ret != STATUS_KEEP_SEARCHING) { /* STATUS_OK or STATUS_NOT_FOUND */ err = errno; icx->is_in_root = TRUE; icx->parent_vcn[icx->pindex] = old_vcn; goto done; } /* Child node present, descend into it. */ if (icx->ia_na) ntfs_attr_close(icx->ia_na); icx->ia_na = ntfs_ia_open(icx, ni); if (!icx->ia_na) goto err_out; ib = ntfs_malloc(icx->block_size); if (!ib) { err = errno; goto err_out; } descend_into_child_node: icx->parent_vcn[icx->pindex] = old_vcn; if (ntfs_icx_parent_inc(icx)) { err = errno; goto err_out; } old_vcn = vcn; ntfs_log_debug("Descend into node with VCN %lld\n", (long long)vcn); if (ntfs_ib_read(icx, vcn, ib)) goto err_out; ret = ntfs_ie_lookup(key, key_len, icx, &ib->index, &vcn, &ie); if (ret != STATUS_KEEP_SEARCHING) { err = errno; if (ret == STATUS_ERROR) goto err_out; /* STATUS_OK or STATUS_NOT_FOUND */ icx->is_in_root = FALSE; icx->ib = ib; icx->parent_vcn[icx->pindex] = vcn; goto done; } if ((ib->index.ih_flags & NODE_MASK) == LEAF_NODE) { ntfs_log_error("Index entry with child node found in a leaf " "node in inode 0x%llx.\n", (unsigned long long)ni->mft_no); goto err_out; } goto descend_into_child_node; err_out: icx->bad_index = TRUE; /* Force icx->* to be freed */ err_lookup: if (icx->actx) { ntfs_attr_put_search_ctx(icx->actx); icx->actx = NULL; } free(ib); if (!err) err = EIO; errno = err; return -1; done: icx->entry = ie; icx->data = (u8 *)ie + offsetof(INDEX_ENTRY, key); icx->data_len = le16_to_cpu(ie->key_length); ntfs_log_trace("Done.\n"); if (err) { errno = err; return -1; } return 0; } static INDEX_BLOCK *ntfs_ib_alloc(VCN ib_vcn, u32 ib_size, INDEX_HEADER_FLAGS node_type) { INDEX_BLOCK *ib; int ih_size = sizeof(INDEX_HEADER); ntfs_log_trace("ib_vcn: %lld ib_size: %u\n", (long long)ib_vcn, ib_size); ib = ntfs_calloc(ib_size); if (!ib) return NULL; ib->magic = magic_INDX; ib->usa_ofs = const_cpu_to_le16(sizeof(INDEX_BLOCK)); ib->usa_count = cpu_to_le16(ib_size / NTFS_BLOCK_SIZE + 1); /* Set USN to 1 */ *(le16 *)((char *)ib + le16_to_cpu(ib->usa_ofs)) = const_cpu_to_le16(1); ib->lsn = const_cpu_to_sle64(0); ib->index_block_vcn = cpu_to_sle64(ib_vcn); ib->index.entries_offset = cpu_to_le32((ih_size + le16_to_cpu(ib->usa_count) * 2 + 7) & ~7); ib->index.index_length = const_cpu_to_le32(0); ib->index.allocated_size = cpu_to_le32(ib_size - (sizeof(INDEX_BLOCK) - ih_size)); ib->index.ih_flags = node_type; return ib; } /** * Find the median by going through all the entries */ static INDEX_ENTRY *ntfs_ie_get_median(INDEX_HEADER *ih) { INDEX_ENTRY *ie, *ie_start; u8 *ie_end; int i = 0, median; ntfs_log_trace("Entering\n"); ie = ie_start = ntfs_ie_get_first(ih); ie_end = (u8 *)ntfs_ie_get_end(ih); while ((u8 *)ie < ie_end && !ntfs_ie_end(ie)) { ie = ntfs_ie_get_next(ie); i++; } /* * NOTE: this could be also the entry at the half of the index block. */ median = i / 2 - 1; ntfs_log_trace("Entries: %d median: %d\n", i, median); for (i = 0, ie = ie_start; i <= median; i++) ie = ntfs_ie_get_next(ie); return ie; } static s64 ntfs_ibm_vcn_to_pos(ntfs_index_context *icx, VCN vcn) { return ntfs_ib_vcn_to_pos(icx, vcn) / icx->block_size; } static s64 ntfs_ibm_pos_to_vcn(ntfs_index_context *icx, s64 pos) { return ntfs_ib_pos_to_vcn(icx, pos * icx->block_size); } static int ntfs_ibm_add(ntfs_index_context *icx) { u8 bmp[8]; ntfs_log_trace("Entering\n"); if (ntfs_attr_exist(icx->ni, AT_BITMAP, icx->name, icx->name_len)) return STATUS_OK; /* * AT_BITMAP must be at least 8 bytes. */ memset(bmp, 0, sizeof(bmp)); if (ntfs_attr_add(icx->ni, AT_BITMAP, icx->name, icx->name_len, bmp, sizeof(bmp))) { ntfs_log_perror("Failed to add AT_BITMAP"); return STATUS_ERROR; } /* only for fsck : allocate fsck_ibm */ if (NVolIsOnFsck(icx->ni->vol) && !icx->ni->fsck_ibm) { icx->ni->fsck_ibm = ntfs_calloc(sizeof(bmp)); if (!icx->ni->fsck_ibm) { ntfs_log_perror("Failed to create fsck_ibm of inode(%"PRIu64"", icx->ni->mft_no); return STATUS_ERROR; } icx->ni->fsck_ibm_size = sizeof(bmp); } return STATUS_OK; } int ntfs_ibm_modify(ntfs_index_context *icx, VCN vcn, int set) { u8 byte; /* ib index for vcn */ s64 pos = ntfs_ibm_vcn_to_pos(icx, vcn); /* byte position in bitmap for ib index of vcn */ u32 bpos = pos / BITS_PER_BYTE; /* bit position in byte for ib index of vcn */ u32 bit = 1 << (pos % BITS_PER_BYTE); ntfs_attr *na; int ret = STATUS_ERROR; ntfs_log_trace("%s vcn: %lld\n", set ? "set" : "clear", (long long)vcn); na = ntfs_attr_open(icx->ni, AT_BITMAP, icx->name, icx->name_len); if (!na) { ntfs_log_perror("Failed to open $BITMAP attribute"); return -1; } if (set) { if (na->data_size < bpos + 1) { if (ntfs_attr_truncate(na, (na->data_size + 8) & ~7)) { ntfs_log_perror("Failed to truncate AT_BITMAP"); goto err_na; } /* check only for fsck */ if (NVolIsOnFsck(icx->ni->vol) && icx->ni->fsck_ibm) { icx->ni->fsck_ibm = ntfs_realloc(icx->ni->fsck_ibm, (na->data_size + 8) & ~7); if (!icx->ni->fsck_ibm) { ntfs_log_perror("Failed to realloc fsck_ibm"); goto err_na; } icx->ni->fsck_ibm_size = (na->data_size + 8) & ~7; } } } if (ntfs_attr_pread(na, bpos, 1, &byte) != 1) { ntfs_log_perror("Failed to read $BITMAP"); goto err_na; } /* check only for fsck */ if (NVolIsOnFsck(icx->ni->vol) && icx->ni->fsck_ibm) { if (set) ntfs_bit_set(icx->ni->fsck_ibm, vcn, 1); else ntfs_bit_set(icx->ni->fsck_ibm, vcn, 0); } if (set) byte |= bit; else byte &= ~bit; if (ntfs_attr_pwrite(na, bpos, 1, &byte) != 1) { ntfs_log_perror("Failed to write $Bitmap"); goto err_na; } ret = STATUS_OK; err_na: ntfs_attr_close(na); return ret; } static int ntfs_ibm_set(ntfs_index_context *icx, VCN vcn) { return ntfs_ibm_modify(icx, vcn, 1); } static int ntfs_ibm_clear(ntfs_index_context *icx, VCN vcn) { return ntfs_ibm_modify(icx, vcn, 0); } static VCN ntfs_ibm_get_free(ntfs_index_context *icx) { u8 *bm; int bit; s64 vcn, byte, size; ntfs_log_trace("Entering\n"); bm = ntfs_attr_readall(icx->ni, AT_BITMAP, icx->name, icx->name_len, &size); if (!bm) return (VCN)-1; for (byte = 0; byte < size; byte++) { if (bm[byte] == 255) continue; for (bit = 0; bit < 8; bit++) { if (!(bm[byte] & (1 << bit))) { vcn = ntfs_ibm_pos_to_vcn(icx, byte * 8 + bit); goto out; } } } vcn = ntfs_ibm_pos_to_vcn(icx, size * 8); out: ntfs_log_trace("allocated vcn: %lld\n", (long long)vcn); if (ntfs_ibm_set(icx, vcn)) vcn = (VCN)-1; free(bm); return vcn; } static INDEX_BLOCK *ntfs_ir_to_ib(INDEX_ROOT *ir, VCN ib_vcn) { INDEX_BLOCK *ib; INDEX_ENTRY *ie_last; char *ies_start, *ies_end; int i; ntfs_log_trace("Entering\n"); ib = ntfs_ib_alloc(ib_vcn, le32_to_cpu(ir->index_block_size), LEAF_NODE); if (!ib) return NULL; ies_start = (char *)ntfs_ie_get_first(&ir->index); ies_end = (char *)ntfs_ie_get_end(&ir->index); ie_last = ntfs_ie_get_last((INDEX_ENTRY *)ies_start, ies_end); /* * Copy all entries, including the termination entry * as well, which can never have any data. */ i = (char *)ie_last - ies_start + le16_to_cpu(ie_last->length); memcpy(ntfs_ie_get_first(&ib->index), ies_start, i); ib->index.ih_flags = ir->index.ih_flags; ib->index.index_length = cpu_to_le32(i + le32_to_cpu(ib->index.entries_offset)); return ib; } static void ntfs_ir_nill(INDEX_ROOT *ir) { INDEX_ENTRY *ie_last; char *ies_start, *ies_end; ntfs_log_trace("Entering\n"); /* * TODO: This function could be much simpler. */ ies_start = (char *)ntfs_ie_get_first(&ir->index); ies_end = (char *)ntfs_ie_get_end(&ir->index); ie_last = ntfs_ie_get_last((INDEX_ENTRY *)ies_start, ies_end); /* * Move the index root termination entry forward */ if ((char *)ie_last > ies_start) { memmove(ies_start, (char *)ie_last, le16_to_cpu(ie_last->length)); ie_last = (INDEX_ENTRY *)ies_start; } } static int ntfs_ib_copy_tail(ntfs_index_context *icx, INDEX_BLOCK *src, INDEX_ENTRY *median, VCN new_vcn) { u8 *ies_end; INDEX_ENTRY *ie_head; /* first entry after the median */ int tail_size, ret; INDEX_BLOCK *dst; ntfs_log_trace("Entering\n"); dst = ntfs_ib_alloc(new_vcn, icx->block_size, src->index.ih_flags & NODE_MASK); if (!dst) return STATUS_ERROR; ie_head = ntfs_ie_get_next(median); ies_end = (u8 *)ntfs_ie_get_end(&src->index); tail_size = ies_end - (u8 *)ie_head; memcpy(ntfs_ie_get_first(&dst->index), ie_head, tail_size); dst->index.index_length = cpu_to_le32(tail_size + le32_to_cpu(dst->index.entries_offset)); ret = ntfs_ib_write(icx, dst); free(dst); return ret; } static int ntfs_ib_cut_tail(ntfs_index_context *icx, INDEX_BLOCK *ib, INDEX_ENTRY *ie) { char *ies_start, *ies_end; INDEX_ENTRY *ie_last; ntfs_log_trace("Entering\n"); ies_start = (char *)ntfs_ie_get_first(&ib->index); ies_end = (char *)ntfs_ie_get_end(&ib->index); ie_last = ntfs_ie_get_last((INDEX_ENTRY *)ies_start, ies_end); if (ie_last->ie_flags & INDEX_ENTRY_NODE) ntfs_ie_set_vcn(ie_last, ntfs_ie_get_vcn(ie)); memcpy(ie, ie_last, le16_to_cpu(ie_last->length)); ib->index.index_length = cpu_to_le32(((char *)ie - ies_start) + le16_to_cpu(ie->length) + le32_to_cpu(ib->index.entries_offset)); if (ntfs_ib_write(icx, ib)) return STATUS_ERROR; return STATUS_OK; } static int ntfs_ia_add(ntfs_index_context *icx) { ntfs_log_trace("Entering\n"); if (ntfs_ibm_add(icx)) return -1; if (!ntfs_attr_exist(icx->ni, AT_INDEX_ALLOCATION, icx->name, icx->name_len)) { if (ntfs_attr_add(icx->ni, AT_INDEX_ALLOCATION, icx->name, icx->name_len, NULL, 0)) { ntfs_log_perror("Failed to add AT_INDEX_ALLOCATION"); return -1; } } icx->ia_na = ntfs_ia_open(icx, icx->ni); if (!icx->ia_na) return -1; return 0; } static int ntfs_ir_reparent(ntfs_index_context *icx) { ntfs_attr_search_ctx *ctx = NULL; INDEX_ROOT *ir; INDEX_ENTRY *ie; INDEX_BLOCK *ib = NULL; VCN new_ib_vcn; int ix_root_size; int ret = STATUS_ERROR; ntfs_log_trace("Entering\n"); ir = ntfs_ir_lookup2(icx->ni, icx->name, icx->name_len); if (!ir) goto out; if ((ir->index.ih_flags & NODE_MASK) == SMALL_INDEX) if (ntfs_ia_add(icx)) goto out; new_ib_vcn = ntfs_ibm_get_free(icx); if (new_ib_vcn == -1) goto out; ir = ntfs_ir_lookup2(icx->ni, icx->name, icx->name_len); if (!ir) goto clear_bmp; ib = ntfs_ir_to_ib(ir, new_ib_vcn); if (ib == NULL) { ntfs_log_perror("Failed to move index root to index block"); goto clear_bmp; } if (ntfs_ib_write(icx, ib)) goto clear_bmp; retry : ir = ntfs_ir_lookup(icx->ni, icx->name, icx->name_len, &ctx); if (!ir) goto clear_bmp; ntfs_ir_nill(ir); ie = ntfs_ie_get_first(&ir->index); ie->ie_flags |= INDEX_ENTRY_NODE; ie->length = const_cpu_to_le16(sizeof(INDEX_ENTRY_HEADER) + sizeof(VCN)); ir->index.ih_flags = LARGE_INDEX; ir->index.index_length = cpu_to_le32(le32_to_cpu(ir->index.entries_offset) + le16_to_cpu(ie->length)); ir->index.allocated_size = ir->index.index_length; ix_root_size = sizeof(INDEX_ROOT) - sizeof(INDEX_HEADER) + le32_to_cpu(ir->index.allocated_size); if (ntfs_resident_attr_value_resize(ctx->mrec, ctx->attr, ix_root_size)) { /* * When there is no space to build a non-resident * index, we may have to move the root to an extent */ if ((errno == ENOSPC) && (ctx->al_entry || !ntfs_inode_add_attrlist(icx->ni))) { ntfs_attr_put_search_ctx(ctx); ctx = (ntfs_attr_search_ctx*)NULL; ir = ntfs_ir_lookup(icx->ni, icx->name, icx->name_len, &ctx); if (ir && !ntfs_attr_record_move_away(ctx, ix_root_size - le32_to_cpu(ctx->attr->value_length))) { ntfs_attr_put_search_ctx(ctx); ctx = (ntfs_attr_search_ctx*)NULL; goto retry; } } /* FIXME: revert index root */ goto clear_bmp; } /* * FIXME: do it earlier if we have enough space in IR (should always), * so in error case we wouldn't lose the IB. */ ntfs_ie_set_vcn(ie, new_ib_vcn); ret = STATUS_OK; err_out: free(ib); ntfs_attr_put_search_ctx(ctx); out: return ret; clear_bmp: ntfs_ibm_clear(icx, new_ib_vcn); goto err_out; } /** * ntfs_ir_truncate - Truncate index root attribute * * Returns STATUS_OK, STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT or STATUS_ERROR. */ static int ntfs_ir_truncate(ntfs_index_context *icx, int data_size) { ntfs_attr *na; int ret; ntfs_log_trace("Entering\n"); na = ntfs_attr_open(icx->ni, AT_INDEX_ROOT, icx->name, icx->name_len); if (!na) { ntfs_log_perror("Failed to open INDEX_ROOT"); return STATUS_ERROR; } /* * INDEX_ROOT must be resident and its entries can be moved to * INDEX_BLOCK, so ENOSPC isn't a real error. */ ret = ntfs_attr_truncate(na, data_size + offsetof(INDEX_ROOT, index)); if (ret == STATUS_OK) { icx->ir = ntfs_ir_lookup2(icx->ni, icx->name, icx->name_len); if (!icx->ir) return STATUS_ERROR; icx->ir->index.allocated_size = cpu_to_le32(data_size); } else if (ret == STATUS_ERROR) ntfs_log_perror("Failed to truncate INDEX_ROOT"); ntfs_attr_close(na); return ret; } /** * ntfs_ir_make_space - Make more space for the index root attribute * * On success return STATUS_OK or STATUS_KEEP_SEARCHING. * On error return STATUS_ERROR. */ static int ntfs_ir_make_space(ntfs_index_context *icx, int data_size) { int ret; ntfs_log_trace("Entering\n"); ret = ntfs_ir_truncate(icx, data_size); if (ret == STATUS_RESIDENT_ATTRIBUTE_FILLED_MFT) { ret = ntfs_ir_reparent(icx); if (ret == STATUS_OK) ret = STATUS_KEEP_SEARCHING; else ntfs_log_perror("Failed to nodify INDEX_ROOT"); } return ret; } /* * NOTE: 'ie' must be a copy of a real index entry. */ static int ntfs_ie_add_vcn(INDEX_ENTRY **ie) { INDEX_ENTRY *p, *old = *ie; old->length = cpu_to_le16(le16_to_cpu(old->length) + sizeof(VCN)); p = realloc(old, le16_to_cpu(old->length)); if (!p) return STATUS_ERROR; p->ie_flags |= INDEX_ENTRY_NODE; *ie = p; return STATUS_OK; } static int ntfs_ih_insert(INDEX_HEADER *ih, INDEX_ENTRY *orig_ie, VCN new_vcn, int pos) { INDEX_ENTRY *ie_node, *ie; int ret = STATUS_ERROR; VCN old_vcn; ntfs_log_trace("Entering\n"); ie = ntfs_ie_dup(orig_ie); if (!ie) return STATUS_ERROR; if (!(ie->ie_flags & INDEX_ENTRY_NODE)) if (ntfs_ie_add_vcn(&ie)) goto out; ie_node = ntfs_ie_get_by_pos(ih, pos); old_vcn = ntfs_ie_get_vcn(ie_node); ntfs_ie_set_vcn(ie_node, new_vcn); ntfs_ie_insert(ih, ie, ie_node); ntfs_ie_set_vcn(ie_node, old_vcn); ret = STATUS_OK; out: free(ie); return ret; } static VCN ntfs_icx_parent_vcn(ntfs_index_context *icx) { return icx->parent_vcn[icx->pindex]; } static VCN ntfs_icx_parent_pos(ntfs_index_context *icx) { return icx->parent_pos[icx->pindex]; } int ntfsck_update_index_entry(ntfs_index_context *ictx) { ntfs_log_verbose("Update index entry to disk\n"); if (ntfs_icx_parent_vcn(ictx) == VCN_INDEX_ROOT_PARENT) ntfs_inode_mark_dirty(ictx->actx->ntfs_ino); else if (ntfs_ib_write(ictx, ictx->ib)) return -1; return 0; } static int ntfs_ir_insert_median(ntfs_index_context *icx, INDEX_ENTRY *median, VCN new_vcn) { u32 new_size; int ret; ntfs_log_trace("Entering\n"); icx->ir = ntfs_ir_lookup2(icx->ni, icx->name, icx->name_len); if (!icx->ir) return STATUS_ERROR; new_size = le32_to_cpu(icx->ir->index.index_length) + le16_to_cpu(median->length); if (!(median->ie_flags & INDEX_ENTRY_NODE)) new_size += sizeof(VCN); ret = ntfs_ir_make_space(icx, new_size); if (ret != STATUS_OK) return ret; icx->ir = ntfs_ir_lookup2(icx->ni, icx->name, icx->name_len); if (!icx->ir) return STATUS_ERROR; return ntfs_ih_insert(&icx->ir->index, median, new_vcn, ntfs_icx_parent_pos(icx)); } static int ntfs_ib_split(ntfs_index_context *icx, INDEX_BLOCK *ib); /** * On success return STATUS_OK or STATUS_KEEP_SEARCHING. * On error return STATUS_ERROR. */ static int ntfs_ib_insert(ntfs_index_context *icx, INDEX_ENTRY *ie, VCN new_vcn) { INDEX_BLOCK *ib; u32 idx_size, allocated_size; int err = STATUS_ERROR; VCN old_vcn; ntfs_log_trace("Entering\n"); ib = ntfs_malloc(icx->block_size); if (!ib) return -1; old_vcn = ntfs_icx_parent_vcn(icx); if (ntfs_ib_read(icx, old_vcn, ib)) goto err_out; idx_size = le32_to_cpu(ib->index.index_length); allocated_size = le32_to_cpu(ib->index.allocated_size); /* FIXME: sizeof(VCN) should be included only if ie has no VCN */ if (idx_size + le16_to_cpu(ie->length) + sizeof(VCN) > allocated_size) { err = ntfs_ib_split(icx, ib); if (err == STATUS_OK) err = STATUS_KEEP_SEARCHING; goto err_out; } if (ntfs_ih_insert(&ib->index, ie, new_vcn, ntfs_icx_parent_pos(icx))) goto err_out; if (ntfs_ib_write(icx, ib)) goto err_out; err = STATUS_OK; err_out: free(ib); return err; } /** * ntfs_ib_split - Split an index block * * On success return STATUS_OK or STATUS_KEEP_SEARCHING. * On error return is STATUS_ERROR. */ static int ntfs_ib_split(ntfs_index_context *icx, INDEX_BLOCK *ib) { INDEX_ENTRY *median; VCN new_vcn; int ret; ntfs_log_trace("Entering\n"); if (ntfs_icx_parent_dec(icx)) return STATUS_ERROR; median = ntfs_ie_get_median(&ib->index); new_vcn = ntfs_ibm_get_free(icx); if (new_vcn == -1) return STATUS_ERROR; if (ntfs_ib_copy_tail(icx, ib, median, new_vcn)) { ntfs_ibm_clear(icx, new_vcn); return STATUS_ERROR; } if (ntfs_icx_parent_vcn(icx) == VCN_INDEX_ROOT_PARENT) ret = ntfs_ir_insert_median(icx, median, new_vcn); else ret = ntfs_ib_insert(icx, median, new_vcn); if (ret != STATUS_OK) { ntfs_ibm_clear(icx, new_vcn); return ret; } ret = ntfs_ib_cut_tail(icx, ib, median); return ret; } /* JPA static */ int ntfs_ie_add(ntfs_index_context *icx, INDEX_ENTRY *ie) { INDEX_HEADER *ih; int allocated_size, new_size; int ret = STATUS_ERROR; #ifdef DEBUG /* removed by JPA to make function usable for security indexes char *fn; fn = ntfs_ie_filename_get(ie); ntfs_log_trace("file: '%s'\n", fn); ntfs_attr_name_free(&fn); */ #endif while (1) { if (!ntfs_index_lookup(&ie->key, le16_to_cpu(ie->key_length), icx)) { errno = EEXIST; ntfs_log_perror("Index already have such entry"); goto err_out; } if (errno != ENOENT) { ntfs_log_perror("Failed to find place for new entry"); goto err_out; } if (icx->is_in_root) ih = &icx->ir->index; else ih = &icx->ib->index; allocated_size = le32_to_cpu(ih->allocated_size); new_size = le32_to_cpu(ih->index_length) + le16_to_cpu(ie->length); if (new_size <= allocated_size) break; ntfs_log_trace("index block sizes: allocated: %d needed: %d\n", allocated_size, new_size); if (icx->is_in_root) { if (ntfs_ir_make_space(icx, new_size) == STATUS_ERROR) goto err_out; } else { if (ntfs_ib_split(icx, icx->ib) == STATUS_ERROR) goto err_out; } ntfs_inode_mark_dirty(icx->actx->ntfs_ino); ntfs_index_ctx_reinit(icx); } ntfs_ie_insert(ih, ie, icx->entry); ntfs_index_entry_mark_dirty(icx); ret = STATUS_OK; err_out: ntfs_log_trace("%s\n", ret ? "Failed" : "Done"); return ret; } /** * ntfs_index_add_filename - add filename to directory index * @ni: ntfs inode describing directory to which index add filename * @fn: FILE_NAME attribute to add * @mref: reference of the inode which @fn describes * * Return 0 on success or -1 on error with errno set to the error code. */ int ntfs_index_add_filename(ntfs_inode *ni, FILE_NAME_ATTR *fn, MFT_REF mref) { INDEX_ENTRY *ie; ntfs_index_context *icx; int fn_size, ie_size, err, ret = -1; ntfs_log_trace("Entering\n"); if (!ni || !fn) { ntfs_log_error("Invalid arguments.\n"); errno = EINVAL; return -1; } fn_size = (fn->file_name_length * sizeof(ntfschar)) + sizeof(FILE_NAME_ATTR); ie_size = (sizeof(INDEX_ENTRY_HEADER) + fn_size + 7) & ~7; ie = ntfs_calloc(ie_size); if (!ie) return -1; ie->indexed_file = cpu_to_le64(mref); ie->length = cpu_to_le16(ie_size); ie->key_length = cpu_to_le16(fn_size); memcpy(&ie->key, fn, fn_size); icx = ntfs_index_ctx_get(ni, NTFS_INDEX_I30, 4); if (!icx) goto out; ret = ntfs_ie_add(icx, ie); err = errno; ntfs_index_ctx_put(icx); errno = err; out: free(ie); return ret; } static int ntfs_ih_takeout(ntfs_index_context *icx, INDEX_HEADER *ih, INDEX_ENTRY *ie, INDEX_BLOCK *ib) { INDEX_ENTRY *ie_roam = NULL; INDEX_ENTRY *ie_dup = NULL; int freed_space; BOOL full; int ret = STATUS_ERROR; ntfs_index_context *icx_add_ie; ntfs_log_trace("Entering\n"); full = ih->index_length == ih->allocated_size; ie_roam = ntfs_ie_dup_novcn(ie); if (!ie_roam) return STATUS_ERROR; ntfs_ie_delete(ih, ie); if (ntfs_icx_parent_vcn(icx) == VCN_INDEX_ROOT_PARENT) { /* * Recover the space which may have been freed * while deleting an entry from root index */ freed_space = le32_to_cpu(ih->allocated_size) - le32_to_cpu(ih->index_length); if (full && (freed_space > 0) && !(freed_space & 7)) { ntfs_ir_truncate(icx, le32_to_cpu(ih->index_length)); /* do nothing if truncation fails */ } ntfs_inode_mark_dirty(icx->actx->ntfs_ino); } else if (ntfs_ib_write(icx, ib)) goto out; ie_dup = ntfs_ie_dup(icx->entry); if (!ie_dup) { ret = STATUS_ERROR; goto out; } icx_add_ie = ntfs_index_ctx_get(icx->ni, NTFS_INDEX_I30, 4); if (!icx_add_ie) goto out; ret = ntfs_ie_add(icx_add_ie, ie_roam); ntfs_index_ctx_put(icx_add_ie); if (ret) goto out; if (le16_to_cpu(ie_dup->key_length) > 0) { ntfs_index_ctx_reinit(icx); ntfs_index_lookup(&ie_dup->key, le16_to_cpu(ie_dup->key_length), icx); } out: free(ie_roam); if (ie_dup) free(ie_dup); return ret; } /** * Used if an empty index block to be deleted has END entry as the parent * in the INDEX_ROOT which is the only one there. */ static void ntfs_ir_leafify(ntfs_index_context *icx, INDEX_HEADER *ih) { INDEX_ENTRY *ie; ntfs_log_trace("Entering\n"); ie = ntfs_ie_get_first(ih); ie->ie_flags &= ~INDEX_ENTRY_NODE; ie->length = cpu_to_le16(le16_to_cpu(ie->length) - sizeof(VCN)); ih->index_length = cpu_to_le32(le32_to_cpu(ih->index_length) - sizeof(VCN)); ih->ih_flags &= ~LARGE_INDEX; /* Not fatal error */ ntfs_ir_truncate(icx, le32_to_cpu(ih->index_length)); /* update icx->entry */ icx->entry = ie; } /** * Used if an empty index block to be deleted has END entry as the parent * in the INDEX_ROOT which is not the only one there. */ static int ntfs_ih_reparent_end(ntfs_index_context *icx, INDEX_HEADER *ih, INDEX_BLOCK *ib) { INDEX_ENTRY *ie, *ie_prev; ntfs_log_trace("Entering\n"); ie = ntfs_ie_get_by_pos(ih, ntfs_icx_parent_pos(icx)); ie_prev = ntfs_ie_prev(ih, ie); ntfs_ie_set_vcn(ie, ntfs_ie_get_vcn(ie_prev)); return ntfs_ih_takeout(icx, ih, ie_prev, ib); } static int ntfs_index_rm_leaf(ntfs_index_context *icx) { INDEX_BLOCK *ib = NULL; INDEX_HEADER *parent_ih; INDEX_ENTRY *ie; int ret = STATUS_ERROR; ntfs_log_trace("pindex: %d\n", icx->pindex); if (ntfs_icx_parent_dec(icx)) return STATUS_ERROR; if (ntfs_ibm_clear(icx, icx->parent_vcn[icx->pindex + 1])) return STATUS_ERROR; if (ntfs_icx_parent_vcn(icx) == VCN_INDEX_ROOT_PARENT) parent_ih = &icx->ir->index; else { ib = ntfs_malloc(icx->block_size); if (!ib) return STATUS_ERROR; if (ntfs_ib_read(icx, ntfs_icx_parent_vcn(icx), ib)) goto out; parent_ih = &ib->index; } ie = ntfs_ie_get_by_pos(parent_ih, ntfs_icx_parent_pos(icx)); while (ntfs_ie_get_vcn(ie) != icx->parent_vcn[icx->pindex + 1]) { icx->parent_pos[icx->pindex]++; ie = ntfs_ie_get_by_pos(parent_ih, ntfs_icx_parent_pos(icx)); } if (!ntfs_ie_end(ie)) { ret = ntfs_ih_takeout(icx, parent_ih, ie, ib); goto out; } if (ntfs_ih_zero_entry(parent_ih)) { if (ntfs_icx_parent_vcn(icx) == VCN_INDEX_ROOT_PARENT) { ntfs_ir_leafify(icx, parent_ih); goto ok; } ret = ntfs_index_rm_leaf(icx); goto out; } if (ntfs_ih_reparent_end(icx, parent_ih, ib)) goto out; ok: ret = STATUS_OK; out: free(ib); return ret; } static int ntfs_index_rm_node(ntfs_index_context *icx) { int entry_pos, pindex; VCN vcn; INDEX_BLOCK *ib = NULL; INDEX_ENTRY *ie_succ, *ie, *entry = icx->entry; INDEX_HEADER *ih; u32 new_size; int delta, ret = STATUS_ERROR; ntfs_log_trace("Entering\n"); if (!icx->ia_na) { icx->ia_na = ntfs_ia_open(icx, icx->ni); if (!icx->ia_na) return STATUS_ERROR; } ib = ntfs_malloc(icx->block_size); if (!ib) return STATUS_ERROR; ie_succ = ntfs_ie_get_next(icx->entry); entry_pos = icx->parent_pos[icx->pindex]; pindex = icx->pindex; descend: vcn = ntfs_ie_get_vcn(ie_succ); if (ntfs_ib_read(icx, vcn, ib)) goto out; ie_succ = ntfs_ie_get_first(&ib->index); if (ntfs_icx_parent_inc(icx)) goto out; icx->parent_vcn[icx->pindex] = vcn; icx->parent_pos[icx->pindex] = 0; if ((ib->index.ih_flags & NODE_MASK) == INDEX_NODE) goto descend; if (ntfs_ih_zero_entry(&ib->index)) { errno = EIO; ntfs_log_perror("Empty index block"); goto out; } ie = ntfs_ie_dup(ie_succ); if (!ie) goto out; if (ntfs_ie_add_vcn(&ie)) goto out2; ntfs_ie_set_vcn(ie, ntfs_ie_get_vcn(icx->entry)); if (icx->is_in_root) ih = &icx->ir->index; else ih = &icx->ib->index; delta = le16_to_cpu(ie->length) - le16_to_cpu(icx->entry->length); new_size = le32_to_cpu(ih->index_length) + delta; if (delta > 0) { if (icx->is_in_root) { ret = ntfs_ir_make_space(icx, new_size); if (ret != STATUS_OK) goto out2; ih = &icx->ir->index; entry = ntfs_ie_get_by_pos(ih, entry_pos); } else if (new_size > le32_to_cpu(ih->allocated_size)) { icx->pindex = pindex; ret = ntfs_ib_split(icx, icx->ib); if (ret == STATUS_OK) ret = STATUS_KEEP_SEARCHING; goto out2; } } ntfs_ie_delete(ih, entry); ntfs_ie_insert(ih, ie, entry); if (icx->is_in_root) { if (ntfs_ir_truncate(icx, new_size)) goto out2; } else if (ntfs_icx_ib_write(icx)) goto out2; ntfs_ie_delete(&ib->index, ie_succ); if (ntfs_ih_zero_entry(&ib->index)) { if (ntfs_index_rm_leaf(icx)) goto out2; } else if (ntfs_ib_write(icx, ib)) goto out2; ret = STATUS_OK; out2: free(ie); out: icx->pindex = pindex; free(ib); return ret; } /** * ntfs_index_rm - remove entry from the index * @icx: index context describing entry to delete * * Delete entry described by @icx from the index. Index context is always * reinitialized after use of this function, so it can be used for index * lookup once again. * * Return 0 on success or -1 on error with errno set to the error code. */ /*static JPA*/ int ntfs_index_rm(ntfs_index_context *icx) { INDEX_HEADER *ih; int err, ret = STATUS_OK; u8 *ie_start, *ie_end; ntfs_log_trace("Entering\n"); if (!icx || (!icx->ib && !icx->ir) || ntfs_ie_end(icx->entry)) { ntfs_log_error("Invalid arguments.\n"); errno = EINVAL; goto err_out; } if (icx->is_in_root) ih = &icx->ir->index; else ih = &icx->ib->index; if ((le32_to_cpu(ih->index_length) > le32_to_cpu(ih->allocated_size)) || (le32_to_cpu(ih->index_length) > icx->block_size)) { ntfs_log_error("%s Index entry(0x%p)'s length is too big.\n", icx->is_in_root ? "Index root" : "Index block", (u8 *)icx->entry); errno = EINVAL; goto sweep_entries; } ie_start = (u8 *)ih + le32_to_cpu(ih->entries_offset); ie_end = (u8 *)ih + le32_to_cpu(ih->index_length); if (ie_start > (u8 *)icx->entry || ie_end < ((u8 *)icx->entry + icx->entry->length) || icx->entry->length > le32_to_cpu(ih->allocated_size) || icx->entry->length > icx->block_size) { ntfs_log_error("Index entry(%p) is out of range from %s\n", (u8 *)icx->entry, icx->is_in_root ? "index root" : "index block"); errno = EINVAL; goto sweep_entries; } if (icx->entry->ie_flags & INDEX_ENTRY_NODE) { ret = ntfs_index_rm_node(icx); } else if (icx->is_in_root || !ntfs_ih_one_entry(ih)) { ntfs_ie_delete(ih, icx->entry); if (icx->is_in_root) { err = ntfs_ir_truncate(icx, le32_to_cpu(ih->index_length)); if (err != STATUS_OK) goto err_out; } else if (ntfs_icx_ib_write(icx)) goto err_out; } else { if (ntfs_index_rm_leaf(icx)) goto err_out; } out: return ret; sweep_entries: err_out: ret = STATUS_ERROR; goto out; } int ntfs_index_remove(ntfs_inode *dir_ni, ntfs_inode *ni __attribute__((unused)), const void *key, const int keylen) { int ret = STATUS_ERROR; ntfs_index_context *icx; icx = ntfs_index_ctx_get(dir_ni, NTFS_INDEX_I30, 4); if (!icx) return -1; while (1) { if (ntfs_index_lookup(key, keylen, icx)) goto err_out; ret = ntfs_index_rm(icx); if (ret == STATUS_ERROR) goto err_out; else if (ret == STATUS_OK) break; ntfs_inode_mark_dirty(icx->actx->ntfs_ino); ntfs_index_ctx_reinit(icx); } ntfs_inode_mark_dirty(icx->actx->ntfs_ino); out: ntfs_index_ctx_put(icx); return ret; err_out: ret = STATUS_ERROR; ntfs_log_perror("Delete failed"); goto out; } /** * ntfs_index_root_get - read the index root of an attribute * @ni: open ntfs inode in which the ntfs attribute resides * @attr: attribute for which we want its index root * * This function will read the related index root an ntfs attribute. * * On success a buffer is allocated with the content of the index root * and which needs to be freed when it's not needed anymore. * * On error NULL is returned with errno set to the error code. */ INDEX_ROOT *ntfs_index_root_get(ntfs_inode *ni, ATTR_RECORD *attr) { ntfs_attr_search_ctx *ctx; ntfschar *name; INDEX_ROOT *root = NULL; name = (ntfschar *)((u8 *)attr + le16_to_cpu(attr->name_offset)); if (!ntfs_ir_lookup(ni, name, attr->name_length, &ctx)) return NULL; root = ntfs_malloc(sizeof(INDEX_ROOT)); if (!root) goto out; *root = *((INDEX_ROOT *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset))); out: ntfs_attr_put_search_ctx(ctx); return root; } /* * Walk down the index tree (leaf bound) * until there are no subnode in the first index entry * returns the entry at the bottom left in subnode */ INDEX_ENTRY *ntfs_index_walk_down(INDEX_ENTRY *ie, ntfs_index_context *ictx) { INDEX_ENTRY *entry; s64 vcn; entry = ie; do { vcn = ntfs_ie_get_vcn(entry); if (ictx->is_in_root) { /* down from level zero */ ictx->ib = (INDEX_BLOCK*)ntfs_malloc(ictx->block_size); ictx->pindex = 1; ictx->is_in_root = FALSE; } else { /* down from non-zero level */ ictx->pindex++; } ictx->parent_pos[ictx->pindex] = 0; ictx->parent_vcn[ictx->pindex] = vcn; if (!ntfs_ib_read(ictx, vcn, ictx->ib)) { int ret; ictx->entry = ntfs_ie_get_first(&ictx->ib->index); entry = ictx->entry; ret = ntfs_index_entry_inconsistent(ictx->ni->vol, entry, ictx->ir->collation_rule, ictx->ni->mft_no, ictx); if (ret > 0) { ret = ntfsck_update_index_entry(ictx); if (ret) { fsck_err_failed(); entry = NULL; } } else if (ret < 0) { /* TODO: ret < 0, inconsistent entry remove */ entry = NULL; } } else entry = NULL; } while (entry && (entry->ie_flags & INDEX_ENTRY_NODE)); return (entry); } /* * Walk up the index tree (root bound) * until there is a valid data entry in parent * returns the parent entry or NULL if no more parent */ INDEX_ENTRY *ntfs_index_walk_up(INDEX_ENTRY *ie, ntfs_index_context *ictx) { INDEX_ENTRY *entry; s64 vcn; entry = ie; if (ictx->pindex > 0) { do { ictx->pindex--; if (!ictx->pindex) { /* we have reached the root */ free(ictx->ib); ictx->ib = (INDEX_BLOCK*)NULL; ictx->is_in_root = TRUE; /* a new search context is to be allocated */ if (ictx->actx) free(ictx->actx); ictx->ir = ntfs_ir_lookup(ictx->ni, ictx->name, ictx->name_len, &ictx->actx); if (ictx->ir) entry = ntfs_ie_get_by_pos( &ictx->ir->index, ictx->parent_pos[ictx->pindex]); else entry = (INDEX_ENTRY*)NULL; } else { /* up into non-root node */ vcn = ictx->parent_vcn[ictx->pindex]; if (!ntfs_ib_read(ictx,vcn,ictx->ib)) { entry = ntfs_ie_get_by_pos( &ictx->ib->index, ictx->parent_pos[ictx->pindex]); } else entry = (INDEX_ENTRY*)NULL; } ictx->entry = entry; } while (entry && (ictx->pindex > 0) && (entry->ie_flags & INDEX_ENTRY_END)); } else entry = (INDEX_ENTRY*)NULL; return (entry); } /* * Get next entry in an index according to collating sequence. * Must be initialized through a ntfs_index_lookup() * * Returns next entry or NULL if none * * Sample layout : * * +---+---+---+---+---+---+---+---+ n ptrs to subnodes * | | | 10| 25| 33| | | | n-1 keys in between * +---+---+---+---+---+---+---+---+ no key in last entry * | A | A * | | | +-------------------------------+ * +--------------------------+ | +-----+ | * | +--+ | | * V | V | * +---+---+---+---+---+---+---+---+ | +---+---+---+---+---+---+---+---+ * | 11| 12| 13| 14| 15| 16| 17| | | | 26| 27| 28| 29| 30| 31| 32| | * +---+---+---+---+---+---+---+---+ | +---+---+---+---+---+---+---+---+ * | | * +-----------------------+ | * | | * +---+---+---+---+---+---+---+---+ * | 18| 19| 20| 21| 22| 23| 24| | * +---+---+---+---+---+---+---+---+ */ INDEX_ENTRY *ntfs_index_next(INDEX_ENTRY *ie, ntfs_index_context *ictx) { ntfs_volume *vol = ictx->ni->vol; COLLATION_RULES cr = ictx->ir->collation_rule; INDEX_ENTRY *next; int ret; le16 flags; /* * lookup() may have returned an invalid node * when searching for a partial key * if this happens, walk up */ if (ie->ie_flags & INDEX_ENTRY_END) next = ntfs_index_walk_up(ie, ictx); else { /* * get next entry in same node * there is always one after any entry with data */ next = (INDEX_ENTRY*)((char*)ie + le16_to_cpu(ie->length)); ++ictx->parent_pos[ictx->pindex]; ret = ntfs_index_entry_inconsistent(vol, next, cr, ictx->ni->mft_no, ictx); if (ret > 0) { ret = ntfsck_update_index_entry(ictx); if (ret) { fsck_err_failed(); return NULL; } } else if (ret < 0) return NULL; flags = next->ie_flags; /* walk down if it has a subnode */ if (flags & INDEX_ENTRY_NODE) { next = ntfs_index_walk_down(next,ictx); } else { /* walk up it has no subnode, nor data */ if (flags & INDEX_ENTRY_END) { next = ntfs_index_walk_up(next, ictx); } } } /* return NULL if stuck at end of a block */ if (next && (next->ie_flags & INDEX_ENTRY_END)) next = (INDEX_ENTRY*)NULL; else { ret = ntfs_index_entry_inconsistent(vol, next, cr, ictx->ni->mft_no, ictx); if (ret > 0) { ret = ntfsck_update_index_entry(ictx); if (ret) { fsck_err_failed(); next = (INDEX_ENTRY*)NULL; } } else if (ret < 0) next = (INDEX_ENTRY *)NULL; } return (next); } ntfsprogs-plus-1.0.0/libntfs/inode.c000066400000000000000000001313241507404161300174260ustar00rootroot00000000000000/** * inode.c - Inode handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2005 Anton Altaparmakov * Copyright (c) 2002-2008 Szabolcs Szakacsits * Copyright (c) 2004-2007 Yura Pakhuchiy * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2009-2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "param.h" #include "compat.h" #include "types.h" #include "volume.h" #include "cache.h" #include "inode.h" #include "attrib.h" #include "debug.h" #include "mft.h" #include "attrlist.h" #include "runlist.h" #include "lcnalloc.h" #include "index.h" #include "dir.h" #include "ntfstime.h" #include "logging.h" #include "misc.h" #include "xattrs.h" #include "lib_utils.h" #include "bitmap.h" #include "problem.h" ntfs_inode *ntfs_inode_base(ntfs_inode *ni) { if (ni->nr_extents == -1) return ni->base_ni; return ni; } /** * ntfs_inode_mark_dirty - set the inode (and its base inode if it exists) dirty * @ni: ntfs inode to set dirty * * Set the inode @ni dirty so it is written out later (at the latest at * ntfs_inode_close() time). If @ni is an extent inode, set the base inode * dirty, too. * * This function cannot fail. */ void ntfs_inode_mark_dirty(ntfs_inode *ni) { NInoSetDirty(ni); if (ni->nr_extents == -1) NInoSetDirty(ni->base_ni); } /** * __ntfs_inode_allocate - Create and initialise an NTFS inode object * @vol: * * Description... * * Returns: */ static ntfs_inode *__ntfs_inode_allocate(ntfs_volume *vol) { ntfs_inode *ni; ni = (ntfs_inode*)ntfs_calloc(sizeof(ntfs_inode)); if (ni) ni->vol = vol; return ni; } /** * ntfs_inode_allocate - Create an NTFS inode object * @vol: * * Description... * * Returns: */ ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol) { return __ntfs_inode_allocate(vol); } /** * __ntfs_inode_release - Destroy an NTFS inode object * @ni: * * Description... * * Returns: */ static void __ntfs_inode_release(ntfs_inode *ni) { if (NVolFsck(ni->vol)) { if (ni->fsck_ibm) free(ni->fsck_ibm); } if (NInoDirty(ni)) ntfs_log_error("Releasing dirty inode %lld!\n", (long long)ni->mft_no); if (NInoAttrList(ni) && ni->attr_list) free(ni->attr_list); free(ni->mrec); free(ni); return; } /** * ntfs_inode_open - open an inode ready for access * @vol: volume to get the inode from * @mref: inode number / mft record number to open * * Allocate an ntfs_inode structure and initialize it for the given inode * specified by @mref. @mref specifies the inode number / mft record to read, * including the sequence number, which can be 0 if no sequence number checking * is to be performed. * * Then, allocate a buffer for the mft record, read the mft record from the * volume @vol, and attach it to the ntfs_inode structure (->mrec). The * mft record is mst deprotected and sanity checked for validity and we abort * if deprotection or checks fail. * * Finally, search for an attribute list attribute in the mft record and if one * is found, load the attribute list attribute value and attach it to the * ntfs_inode structure (->attr_list). Also set the NI_AttrList bit to indicate * this. * * Return a pointer to the ntfs_inode structure on success or NULL on error, * with errno set to the error code. */ static ntfs_inode *ntfs_inode_real_open(ntfs_volume *vol, const MFT_REF mref) { s64 l; ntfs_inode *ni = NULL; ntfs_attr_search_ctx *ctx; STANDARD_INFORMATION *std_info; le32 lthle; int olderrno; ntfs_log_enter("Entering for inode %lld\n", (long long)MREF(mref)); if (!vol) { errno = EINVAL; goto out; } ni = __ntfs_inode_allocate(vol); if (!ni) goto out; if (ntfs_file_record_read(vol, mref, &ni->mrec, NULL)) goto err_out; if (MREF_LE(ni->mrec->base_mft_record) != 0) { ntfs_log_trace("Inode(%"PRIu64") is not base inode\n", ni->mft_no); goto err_out; } if (!(ni->mrec->flags & MFT_RECORD_IN_USE)) { ni->mft_no = MREF(mref); /* * If system files is marked as removed(MFT_RECORD_IN_USED unset), * mark it used except FILE_Extend.(it could be included but not sure now) */ if (NVolFsck(vol) && (utils_is_metadata(ni) == 1) && ni->mft_no != FILE_Extend) { check_failed("System file(%"PRIu64") is marked unused, Fix it", ni->mft_no); if (ntfs_ask_repair(vol)) { ni->mrec->flags |= MFT_RECORD_IN_USE; ntfs_bitmap_set_bit(vol->mftbmp_na, ni->mft_no); ntfs_inode_mark_dirty(ni); fsck_err_fixed(); } } else { errno = ENOENT; goto err_out; } } ni->mft_no = MREF(mref); ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) goto err_out; /* Receive some basic information about inode. */ if (ntfs_attr_lookup(AT_STANDARD_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (!ni->mrec->base_mft_record) ntfs_log_perror("No STANDARD_INFORMATION in base record" " %lld", (long long)MREF(mref)); goto put_err_out; } lthle = ctx->attr->value_length; if (le32_to_cpu(lthle) < offsetof(STANDARD_INFORMATION, owner_id)) { ntfs_log_error("Corrupt STANDARD_INFORMATION in base" " record %lld\n", (long long)MREF(mref)); goto put_err_out; } std_info = (STANDARD_INFORMATION *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); ni->flags = std_info->file_attributes; ni->creation_time = std_info->creation_time; ni->last_data_change_time = std_info->last_data_change_time; ni->last_mft_change_time = std_info->last_mft_change_time; ni->last_access_time = std_info->last_access_time; /* Insert v3 extensions if present */ /* length may be seen as 48 (v1.x) or 72 (v3.x) */ if (le32_to_cpu(lthle) >= offsetof(STANDARD_INFORMATION, v3_end)) { set_nino_flag(ni, v3_Extensions); ni->owner_id = std_info->owner_id; ni->security_id = std_info->security_id; ni->quota_charged = std_info->quota_charged; ni->usn = std_info->usn; } else { clear_nino_flag(ni, v3_Extensions); ni->owner_id = const_cpu_to_le32(0); ni->security_id = const_cpu_to_le32(0); } /* Set attribute list information. */ olderrno = errno; if (ntfs_attr_lookup(AT_ATTRIBUTE_LIST, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (errno != ENOENT) goto put_err_out; /* Attribute list attribute does not present. */ /* restore previous errno to avoid misinterpretation */ errno = olderrno; goto get_size; } NInoSetAttrList(ni); l = ntfs_get_attribute_value_length(ctx->attr); if (!l) goto put_err_out; if ((u64)l > 0x40000) { errno = EIO; ntfs_log_perror("Too large attrlist attribute (%llu), inode " "%lld", (long long)l, (long long)MREF(mref)); goto put_err_out; } ni->attr_list_size = l; ni->attr_list = ntfs_malloc(ni->attr_list_size); if (!ni->attr_list) goto put_err_out; l = ntfs_get_attribute_value(vol, ctx->attr, ni->attr_list); if (!l) goto put_err_out; if (l != ni->attr_list_size) { errno = EIO; ntfs_log_perror("Unexpected attrlist size (%lld <> %u), inode " "%lld", (long long)l, ni->attr_list_size, (long long)MREF(mref)); goto put_err_out; } get_size: olderrno = errno; if (ntfs_attr_lookup(AT_DATA, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { if (errno != ENOENT) goto put_err_out; /* Directory or special file. */ /* restore previous errno to avoid misinterpretation */ errno = olderrno; ni->data_size = ni->allocated_size = 0; } else { if (ctx->attr->non_resident) { ni->data_size = sle64_to_cpu(ctx->attr->data_size); if (ctx->attr->flags & (ATTR_IS_COMPRESSED | ATTR_IS_SPARSE)) ni->allocated_size = sle64_to_cpu( ctx->attr->compressed_size); else ni->allocated_size = sle64_to_cpu( ctx->attr->allocated_size); } else { ni->data_size = le32_to_cpu(ctx->attr->value_length); ni->allocated_size = (ni->data_size + 7) & ~7; } set_nino_flag(ni,KnownSize); } ntfs_attr_put_search_ctx(ctx); out: ntfs_log_leave("\n"); return ni; put_err_out: ntfs_attr_put_search_ctx(ctx); err_out: __ntfs_inode_release(ni); ni = NULL; goto out; } /** * ntfs_inode_close - close an ntfs inode and free all associated memory * @ni: ntfs inode to close * * Make sure the ntfs inode @ni is clean. * * If the ntfs inode @ni is a base inode, close all associated extent inodes, * then deallocate all memory attached to it, and finally free the ntfs inode * structure itself. * * If it is an extent inode, we disconnect it from its base inode before we * destroy it. * * It is OK to pass NULL to this function, it is just noop in this case. * * Return 0 on success or -1 on error with errno set to the error code. On * error, @ni has not been freed. The user should attempt to handle the error * and call ntfs_inode_close() again. The following error codes are defined: * * EBUSY @ni and/or its attribute list runlist is/are dirty and the * attempt to write it/them to disk failed. * EINVAL @ni is invalid (probably it is an extent inode). * EIO I/O error while trying to write inode to disk. */ int ntfs_inode_real_close(ntfs_inode *ni) { int ret = -1; if (!ni) return 0; ntfs_log_enter("Entering for inode %lld\n", (long long)ni->mft_no); /* If we have dirty metadata, write it out. */ if (NInoDirty(ni) || NInoAttrListDirty(ni)) { if (ntfs_inode_sync(ni)) { if (errno != EIO) errno = EBUSY; goto err; } } /* Is this a base inode with mapped extent inodes? */ if (ni->nr_extents > 0) { while (ni->nr_extents > 0) { if (ntfs_inode_real_close(ni->extent_nis[0])) { if (errno != EIO) errno = EBUSY; goto err; } } } else if (ni->nr_extents == -1) { ntfs_inode **tmp_nis; ntfs_inode *base_ni; s32 i; /* * If the inode is an extent inode, disconnect it from the * base inode before destroying it. */ base_ni = ni->base_ni; for (i = 0; i < base_ni->nr_extents; ++i) { tmp_nis = base_ni->extent_nis; if (tmp_nis[i] != ni) continue; /* Found it. Disconnect. */ memmove(tmp_nis + i, tmp_nis + i + 1, (base_ni->nr_extents - i - 1) * sizeof(ntfs_inode *)); /* Buffer should be for multiple of four extents. */ if ((--base_ni->nr_extents) & 3) { i = -1; break; } /* * ElectricFence is unhappy with realloc(x,0) as free(x) * thus we explicitly separate these two cases. */ if (base_ni->nr_extents) { /* Resize the memory buffer. */ tmp_nis = realloc(tmp_nis, base_ni->nr_extents * sizeof(ntfs_inode *)); /* Ignore errors, they don't really matter. */ if (tmp_nis) base_ni->extent_nis = tmp_nis; } else if (tmp_nis) { free(tmp_nis); base_ni->extent_nis = (ntfs_inode**)NULL; } /* Allow for error checking. */ i = -1; break; } /* * We could successfully sync, so only log this error * and try to sync other inode extents too. */ if (i != -1) ntfs_log_error("Extent inode %lld was not found\n", (long long)ni->mft_no); } __ntfs_inode_release(ni); ret = 0; err: ntfs_log_leave("\n"); return ret; } #if CACHE_NIDATA_SIZE /* * Free an inode structure when there is not more space * in the cache */ void ntfs_inode_nidata_free(const struct CACHED_GENERIC *cached) { ntfs_inode_real_close(((const struct CACHED_NIDATA*)cached)->ni); } /* * Compute a hash value for an inode entry */ int ntfs_inode_nidata_hash(const struct CACHED_GENERIC *item) { return (((const struct CACHED_NIDATA*)item)->inum % (2*CACHE_NIDATA_SIZE)); } /* * inum comparing for entering/fetching from cache */ static int idata_cache_compare(const struct CACHED_GENERIC *cached, const struct CACHED_GENERIC *wanted) { return (((const struct CACHED_NIDATA*)cached)->inum != ((const struct CACHED_NIDATA*)wanted)->inum); } /* * Invalidate an inode entry when not needed anymore. * The entry should have been synced, it may be reused later, * if it is requested before it is dropped from cache. */ void ntfs_inode_invalidate(ntfs_volume *vol, const MFT_REF mref) { struct CACHED_NIDATA item; item.inum = MREF(mref); item.ni = (ntfs_inode*)NULL; item.pathname = (const char*)NULL; item.varsize = 0; ntfs_invalidate_cache(vol->nidata_cache, GENERIC(&item),idata_cache_compare,CACHE_FREE); } #endif /* * Open an inode * * When possible, an entry recorded in the cache is reused * * **NEVER REOPEN** an inode, this can lead to a duplicated * cache entry (hard to detect), and to an obsolete one being * reused. System files are however protected from being cached. */ ntfs_inode *ntfs_inode_open(ntfs_volume *vol, const MFT_REF mref) { ntfs_inode *ni; #if CACHE_NIDATA_SIZE struct CACHED_NIDATA item; struct CACHED_NIDATA *cached; /* fetch idata from cache */ item.inum = MREF(mref); debug_double_inode(item.inum,1); item.pathname = (const char*)NULL; item.varsize = 0; cached = (struct CACHED_NIDATA*)ntfs_fetch_cache(vol->nidata_cache, GENERIC(&item),idata_cache_compare); if (cached) { ni = cached->ni; /* do not keep open entries in cache */ ntfs_remove_cache(vol->nidata_cache, (struct CACHED_GENERIC*)cached,0); } else { ni = ntfs_inode_real_open(vol, mref); } if (!ni) { debug_double_inode(item.inum, 0); } #else ni = ntfs_inode_real_open(vol, mref); #endif return (ni); } /* * Close an inode entry * * If cacheing is in use, the entry is synced and kept available * in cache for further use. * * System files (inode < 16 or having the IS_4 flag) are protected * against being cached. */ int ntfs_inode_close(ntfs_inode *ni) { int res; #if CACHE_NIDATA_SIZE BOOL dirty; struct CACHED_NIDATA item; if (ni) { debug_double_inode(ni->mft_no,0); /* do not cache system files : could lead to double entries */ if (ni->vol && ni->vol->nidata_cache && ((ni->mft_no == FILE_root) || (!utils_is_metadata(ni)))) { /* If we have dirty metadata, write it out. */ dirty = NInoDirty(ni) || NInoAttrListDirty(ni); if (dirty) { res = ntfs_inode_sync(ni); /* do a real close if sync failed */ if (res) ntfs_inode_real_close(ni); } else res = 0; if (!res) { /* feed idata into cache */ item.inum = ni->mft_no; item.ni = ni; item.pathname = (const char*)NULL; item.varsize = 0; debug_cached_inode(ni); ntfs_enter_cache(ni->vol->nidata_cache, GENERIC(&item), idata_cache_compare); } } else { /* cache not ready or system file, really close */ res = ntfs_inode_real_close(ni); } } else res = 0; #else res = ntfs_inode_real_close(ni); #endif return (res); } /** * ntfs_extent_inode_open - load an extent inode and attach it to its base * @base_ni: base ntfs inode * @mref: mft reference of the extent inode to load (in little endian) * * First check if the extent inode @mref is already attached to the base ntfs * inode @base_ni, and if so, return a pointer to the attached extent inode. * * If the extent inode is not already attached to the base inode, allocate an * ntfs_inode structure and initialize it for the given inode @mref. @mref * specifies the inode number / mft record to read, including the sequence * number, which can be 0 if no sequence number checking is to be performed. * * Then, allocate a buffer for the mft record, read the mft record from the * volume @base_ni->vol, and attach it to the ntfs_inode structure (->mrec). * The mft record is mst deprotected and sanity checked for validity and we * abort if deprotection or checks fail. * * Finally attach the ntfs inode to its base inode @base_ni and return a * pointer to the ntfs_inode structure on success or NULL on error, with errno * set to the error code. * * Note, extent inodes are never closed directly. They are automatically * disposed off by the closing of the base inode. */ ntfs_inode *ntfs_extent_inode_open(ntfs_inode *base_ni, const leMFT_REF mref) { u64 mft_no = MREF_LE(mref); VCN extent_vcn; runlist_element *rl; ntfs_volume *vol; ntfs_inode *ni = NULL; ntfs_inode **extent_nis; int i; if (!base_ni) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return NULL; } ntfs_log_enter("Opening extent inode %lld (base mft record %lld).\n", (unsigned long long)mft_no, (unsigned long long)base_ni->mft_no); if (!base_ni->mft_no) { /* * When getting extents of MFT, we must be sure * they are in the MFT part which has already * been mapped, otherwise we fall into an endless * recursion. * Situations have been met where extents locations * are described in themselves. * This is a severe error which chkdsk cannot fix. */ vol = base_ni->vol; extent_vcn = mft_no << vol->mft_record_size_bits >> vol->cluster_size_bits; rl = vol->mft_na->rl; if (rl) { while (rl->length && ((rl->vcn + rl->length) <= extent_vcn)) rl++; } if (!rl || (rl->lcn < 0)) { ntfs_log_error("MFT is corrupt, cannot read" " its unmapped extent record %lld\n", (long long)mft_no); ntfs_log_error("Note : chkdsk cannot fix this," " try ntfsfix\n"); errno = EIO; ni = (ntfs_inode*)NULL; goto out; } } /* Is the extent inode already open and attached to the base inode? */ if (base_ni->nr_extents > 0) { extent_nis = base_ni->extent_nis; for (i = 0; i < base_ni->nr_extents; i++) { u16 seq_no; ni = extent_nis[i]; if (mft_no != ni->mft_no) continue; /* Verify the sequence number if given. */ seq_no = MSEQNO_LE(mref); if (seq_no && seq_no != le16_to_cpu( ni->mrec->sequence_number)) { errno = EIO; ntfs_log_perror("Found stale extent mft " "reference mft=%lld", (long long)ni->mft_no); goto out; } goto out; } } /* Wasn't there, we need to load the extent inode. */ ni = __ntfs_inode_allocate(base_ni->vol); if (!ni) goto out; if (ntfs_file_record_read(base_ni->vol, le64_to_cpu(mref), &ni->mrec, NULL)) goto err_out; if ((base_ni->mft_no != 0 &&(MREF_LE(ni->mrec->base_mft_record) == 0)) || (MREF_LE(ni->mrec->base_mft_record) != base_ni->mft_no)) { ntfs_log_error("Base mft record(%"PRIu64") of inode(%"PRIu64") " "is not a base inode(%"PRIu64")\n", MREF_LE(ni->mrec->base_mft_record), mft_no, base_ni->mft_no); goto err_out; } ni->mft_no = mft_no; ni->nr_extents = -1; ni->base_ni = base_ni; /* Attach extent inode to base inode, reallocating memory if needed. */ if (!(base_ni->nr_extents & 3)) { i = (base_ni->nr_extents + 4) * sizeof(ntfs_inode *); extent_nis = ntfs_malloc(i); if (!extent_nis) goto err_out; if (base_ni->nr_extents) { memcpy(extent_nis, base_ni->extent_nis, i - 4 * sizeof(ntfs_inode *)); free(base_ni->extent_nis); } base_ni->extent_nis = extent_nis; } base_ni->extent_nis[base_ni->nr_extents++] = ni; out: ntfs_log_leave("\n"); return ni; err_out: __ntfs_inode_release(ni); ni = NULL; goto out; } /** * ntfs_inode_attach_all_extents - attach all extents for target inode * @ni: opened ntfs inode for which perform attach * * Return 0 on success and -1 on error with errno set to the error code. */ int ntfs_inode_attach_all_extents(ntfs_inode *ni) { ATTR_LIST_ENTRY *ale; u64 prev_attached = 0; if (!ni) { ntfs_log_trace("Invalid arguments.\n"); errno = EINVAL; return -1; } if (ni->nr_extents == -1) ni = ni->base_ni; ntfs_log_trace("Entering for inode 0x%llx.\n", (long long) ni->mft_no); /* Inode haven't got attribute list, thus nothing to attach. */ if (!NInoAttrList(ni)) return 0; if (!ni->attr_list) { ntfs_log_trace("Corrupt in-memory struct.\n"); errno = EINVAL; return -1; } /* Walk through attribute list and attach all extents. */ errno = 0; ale = (ATTR_LIST_ENTRY *)ni->attr_list; while ((u8*)ale < ni->attr_list + ni->attr_list_size) { /* to prevent infinite loop */ if (le16_to_cpu(ale->length) == 0) return -1; if (ni->mft_no != MREF_LE(ale->mft_reference) && prev_attached != MREF_LE(ale->mft_reference)) { if (!ntfs_extent_inode_open(ni, ale->mft_reference)) { ntfs_log_trace("Couldn't attach extent inode.\n"); return -1; } prev_attached = MREF_LE(ale->mft_reference); } ale = (ATTR_LIST_ENTRY *)((u8*)ale + le16_to_cpu(ale->length)); } return 0; } /** * ntfs_inode_sync_standard_information - update standard information attribute * @ni: ntfs inode to update standard information * * Return 0 on success or -1 on error with errno set to the error code. */ static int ntfs_inode_sync_standard_information(ntfs_inode *ni) { ntfs_attr_search_ctx *ctx; STANDARD_INFORMATION *std_info; u32 lth; le32 lthle; ntfs_log_trace("Entering for inode %lld\n", (long long)ni->mft_no); ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; if (ntfs_attr_lookup(AT_STANDARD_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("Failed to sync standard info (inode %lld)", (long long)ni->mft_no); ntfs_attr_put_search_ctx(ctx); return -1; } std_info = (STANDARD_INFORMATION *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); std_info->file_attributes = ni->flags; if (!test_nino_flag(ni, TimesSet)) { std_info->creation_time = ni->creation_time; std_info->last_data_change_time = ni->last_data_change_time; std_info->last_mft_change_time = ni->last_mft_change_time; std_info->last_access_time = ni->last_access_time; } /* JPA update v3.x extensions, ensuring consistency */ lthle = ctx->attr->value_length; lth = le32_to_cpu(lthle); if (test_nino_flag(ni, v3_Extensions) && (lth < offsetof(STANDARD_INFORMATION, v3_end))) ntfs_log_error("bad sync of standard information\n"); if (lth >= offsetof(STANDARD_INFORMATION, v3_end)) { std_info->owner_id = ni->owner_id; std_info->security_id = ni->security_id; std_info->quota_charged = ni->quota_charged; std_info->usn = ni->usn; } ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); return 0; } /** * ntfs_inode_sync_file_name - update FILE_NAME attributes * @ni: ntfs inode to update FILE_NAME attributes * * Update all FILE_NAME attributes for inode @ni in the index. * * Return 0 on success or -1 on error with errno set to the error code. */ static int ntfs_inode_sync_file_name(ntfs_inode *ni, ntfs_inode *dir_ni) { ntfs_attr_search_ctx *ctx = NULL; ntfs_index_context *ictx; ntfs_inode *index_ni; FILE_NAME_ATTR *fn; FILE_NAME_ATTR *fnx; REPARSE_POINT *rpp; le32 reparse_tag; int err = 0; ntfs_log_trace("Entering for inode %lld\n", (long long)ni->mft_no); if (ni == dir_ni) { err = -EINVAL; goto err_out; } ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) { err = errno; goto err_out; } /* Collect the reparse tag, if any */ reparse_tag = const_cpu_to_le32(0); if (ni->flags & FILE_ATTR_REPARSE_POINT) { if (!ntfs_attr_lookup(AT_REPARSE_POINT, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { rpp = (REPARSE_POINT*)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); reparse_tag = rpp->reparse_tag; } ntfs_attr_reinit_search_ctx(ctx); } /* Walk through all FILE_NAME attributes and update them. */ while (!ntfs_attr_lookup(AT_FILE_NAME, NULL, 0, 0, 0, NULL, 0, ctx)) { fn = (FILE_NAME_ATTR *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); if (MREF_LE(fn->parent_directory) == ni->mft_no) { /* * WARNING: We cheat here and obtain 2 attribute * search contexts for one inode (first we obtained * above, second will be obtained inside * ntfs_index_lookup), it's acceptable for library, * but will deadlock in the kernel. */ index_ni = ni; } else if (dir_ni) index_ni = dir_ni; else index_ni = ntfs_inode_open(ni->vol, le64_to_cpu(fn->parent_directory)); if (!index_ni) { if (!err) err = errno; ntfs_log_perror("Failed to open inode %lld with index", (long long)MREF_LE(fn->parent_directory)); continue; } if (MREF_LE(fn->parent_directory) != index_ni->mft_no) { if (!dir_ni && index_ni != ni) ntfs_inode_close(index_ni); continue; } ictx = ntfs_index_ctx_get(index_ni, NTFS_INDEX_I30, 4); if (!ictx) { if (!err) err = errno; ntfs_log_perror("Failed to get index ctx, inode %lld", (long long)index_ni->mft_no); if ((ni != index_ni) && !dir_ni && ntfs_inode_close(index_ni) && !err) err = errno; continue; } if (ntfs_index_lookup(fn, sizeof(FILE_NAME_ATTR), ictx)) { if (!err) { if (errno == ENOENT) err = EIO; else err = errno; } ntfs_log_perror("Index lookup failed, index_ni:%lld inode:%lld", (long long)index_ni->mft_no, (long long)ni->mft_no); ntfs_index_ctx_put(ictx); if (ni != index_ni && !dir_ni && ntfs_inode_close(index_ni) && !err) err = errno; continue; } /* Update flags and file size. */ fnx = (FILE_NAME_ATTR *)ictx->data; fnx->file_attributes = (fnx->file_attributes & ~FILE_ATTR_VALID_FLAGS) | (ni->flags & FILE_ATTR_VALID_FLAGS); if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) fnx->data_size = fnx->allocated_size = const_cpu_to_sle64(0); else { fnx->allocated_size = cpu_to_sle64(ni->allocated_size); fnx->data_size = cpu_to_sle64(ni->data_size); /* * The file name record has also to be fixed if some * attribute update implied the unnamed data to be * made non-resident */ fn->allocated_size = fnx->allocated_size; } /* update or clear the reparse tag in the index */ fnx->reparse_point_tag = reparse_tag; if (!test_nino_flag(ni, TimesSet)) { fnx->creation_time = ni->creation_time; fnx->last_data_change_time = ni->last_data_change_time; fnx->last_mft_change_time = ni->last_mft_change_time; fnx->last_access_time = ni->last_access_time; } else { fnx->creation_time = fn->creation_time; fnx->last_data_change_time = fn->last_data_change_time; fnx->last_mft_change_time = fn->last_mft_change_time; fnx->last_access_time = fn->last_access_time; } ntfs_index_entry_mark_dirty(ictx); ntfs_index_ctx_put(ictx); if ((ni != index_ni) && !dir_ni && ntfs_inode_close(index_ni) && !err) err = errno; } /* Check for real error occurred. */ if (errno != ENOENT) { err = errno; ntfs_log_perror("Attribute lookup failed, inode %lld", (long long)ni->mft_no); goto err_out; } ntfs_attr_put_search_ctx(ctx); if (err) { errno = err; return -1; } return 0; err_out: if (ctx) ntfs_attr_put_search_ctx(ctx); errno = err; return -1; } /** * ntfs_inode_sync - write the inode (and its dirty extents) to disk * @ni: ntfs inode to write * * Write the inode @ni to disk as well as its dirty extent inodes if such * exist and @ni is a base inode. If @ni is an extent inode, only @ni is * written completely disregarding its base inode and any other extent inodes. * * For a base inode with dirty extent inodes if any writes fail for whatever * reason, the failing inode is skipped and the sync process is continued. At * the end the error condition that brought about the failure is returned. Thus * the smallest amount of data loss possible occurs. * * Return 0 on success or -1 on error with errno set to the error code. * The following error codes are defined: * EINVAL - Invalid arguments were passed to the function. * EBUSY - Inode and/or one of its extents is busy, try again later. * EIO - I/O error while writing the inode (or one of its extents). */ int ntfs_inode_sync_in_dir(ntfs_inode *ni, ntfs_inode *dir_ni) { int ret = 0; int err = 0; if (!ni) { errno = EINVAL; ntfs_log_error("Failed to sync NULL inode\n"); return -1; } ntfs_log_enter("Entering for inode %lld\n", (long long)ni->mft_no); /* Update STANDARD_INFORMATION. */ if ((ni->mrec->flags & MFT_RECORD_IN_USE) && ni->nr_extents != -1 && NInoDirty(ni) && ntfs_inode_sync_standard_information(ni)) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; } } /* Update FILE_NAME's in the index. */ if ((ni->mrec->flags & MFT_RECORD_IN_USE) && ni->nr_extents != -1 && NInoFileNameTestAndClearDirty(ni) && ntfs_inode_sync_file_name(ni, dir_ni)) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; } ntfs_log_perror("Failed to sync FILE_NAME (inode %lld)", (long long)ni->mft_no); NInoFileNameSetDirty(ni); } /* Write out attribute list from cache to disk. */ if ((ni->mrec->flags & MFT_RECORD_IN_USE) && ni->nr_extents != -1 && NInoAttrList(ni) && NInoAttrListTestAndClearDirty(ni)) { ntfs_attr *na; na = ntfs_attr_open(ni, AT_ATTRIBUTE_LIST, AT_UNNAMED, 0); if (!na) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; ntfs_log_perror("Attribute list sync failed " "(open, inode %lld)", (long long)ni->mft_no); } NInoAttrListSetDirty(ni); goto sync_inode; } if (na->data_size == ni->attr_list_size) { if (ntfs_attr_pwrite(na, 0, ni->attr_list_size, ni->attr_list) != ni->attr_list_size) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; ntfs_log_perror("Attribute list sync " "failed (write, inode %lld)", (long long)ni->mft_no); } NInoAttrListSetDirty(ni); } } else { err = EIO; ntfs_log_error("Attribute list sync failed (bad size, " "inode %lld)\n", (long long)ni->mft_no); NInoAttrListSetDirty(ni); } ntfs_attr_close(na); } sync_inode: /* Write this inode out to the $MFT (and $MFTMirr if applicable). */ if (NInoTestAndClearDirty(ni)) { if (ntfs_mft_record_write(ni->vol, ni->mft_no, ni->mrec)) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; } NInoSetDirty(ni); ntfs_log_perror("MFT record sync failed, inode %lld", (long long)ni->mft_no); } } /* If this is a base inode with extents write all dirty extents, too. */ if (ni->nr_extents > 0) { s32 i; for (i = 0; i < ni->nr_extents; ++i) { ntfs_inode *eni; eni = ni->extent_nis[i]; if (!NInoTestAndClearDirty(eni)) continue; if (ntfs_mft_record_write(eni->vol, eni->mft_no, eni->mrec)) { if (!err || errno == EIO) { err = errno; if (err != EIO) err = EBUSY; } NInoSetDirty(eni); ntfs_log_perror("Extent MFT record sync failed," " inode %lld/%lld", (long long)ni->mft_no, (long long)eni->mft_no); } } } if (err) { errno = err; ret = -1; } ntfs_log_leave("\n"); return ret; } int ntfs_inode_sync(ntfs_inode *ni) { return (ntfs_inode_sync_in_dir(ni, (ntfs_inode*)NULL)); } /* * Close an inode with an open parent inode */ int ntfs_inode_close_in_dir(ntfs_inode *ni, ntfs_inode *dir_ni) { int res; res = ntfs_inode_sync_in_dir(ni, dir_ni); if (res) { ntfs_log_perror("%s failed\n", __func__); if (errno != EIO) errno = EBUSY; } else res = ntfs_inode_close(ni); return (res); } /** * ntfs_inode_add_attrlist - add attribute list to inode and fill it * @ni: opened ntfs inode to which add attribute list * * Return 0 on success or -1 on error with errno set to the error code. * The following error codes are defined: * EINVAL - Invalid arguments were passed to the function. * EEXIST - Attribute list already exist. * EIO - Input/Ouput error occurred. * ENOMEM - Not enough memory to perform add. */ int ntfs_inode_add_attrlist(ntfs_inode *ni) { int err; ntfs_attr_search_ctx *ctx; u8 *al = NULL, *aln; int al_len = 0; ATTR_LIST_ENTRY *ale = NULL; ntfs_attr *na; if (!ni) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return -1; } ntfs_log_trace("inode %llu\n", (unsigned long long) ni->mft_no); if (NInoAttrList(ni) || ni->nr_extents) { errno = EEXIST; ntfs_log_perror("Inode already has attribute list"); return -1; } /* Form attribute list. */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) { err = errno; goto err_out; } /* Walk through all attributes. */ while (!ntfs_attr_lookup(AT_UNUSED, NULL, 0, 0, 0, NULL, 0, ctx)) { int ale_size; if (ctx->attr->type == AT_ATTRIBUTE_LIST) { err = EIO; ntfs_log_perror("Attribute list already present"); goto put_err_out; } ale_size = (sizeof(ATTR_LIST_ENTRY) + sizeof(ntfschar) * ctx->attr->name_length + 7) & ~7; al_len += ale_size; aln = realloc(al, al_len); if (!aln) { err = errno; ntfs_log_perror("Failed to realloc %d bytes", al_len); goto put_err_out; } ale = (ATTR_LIST_ENTRY *)(aln + ((u8 *)ale - al)); al = aln; memset(ale, 0, ale_size); /* Add attribute to attribute list. */ ale->type = ctx->attr->type; ale->length = cpu_to_le16((sizeof(ATTR_LIST_ENTRY) + sizeof(ntfschar) * ctx->attr->name_length + 7) & ~7); ale->name_length = ctx->attr->name_length; ale->name_offset = (u8 *)ale->name - (u8 *)ale; if (ctx->attr->non_resident) ale->lowest_vcn = ctx->attr->lowest_vcn; else ale->lowest_vcn = const_cpu_to_sle64(0); ale->mft_reference = MK_LE_MREF(ni->mft_no, le16_to_cpu(ni->mrec->sequence_number)); ale->instance = ctx->attr->instance; memcpy(ale->name, (u8 *)ctx->attr + le16_to_cpu(ctx->attr->name_offset), ctx->attr->name_length * sizeof(ntfschar)); ale = (ATTR_LIST_ENTRY *)(al + al_len); } /* Check for real error occurred. */ if (errno != ENOENT) { err = errno; ntfs_log_perror("%s: Attribute lookup failed, inode %lld", __FUNCTION__, (long long)ni->mft_no); goto put_err_out; } /* Set in-memory attribute list. */ ni->attr_list = al; ni->attr_list_size = al_len; NInoSetAttrList(ni); NInoAttrListSetDirty(ni); /* Free space if there is not enough it for $ATTRIBUTE_LIST. */ if (le32_to_cpu(ni->mrec->bytes_allocated) - le32_to_cpu(ni->mrec->bytes_in_use) < offsetof(ATTR_RECORD, resident_end)) { if (ntfs_inode_free_space(ni, offsetof(ATTR_RECORD, resident_end))) { /* Failed to free space. */ err = errno; ntfs_log_perror("Failed to free space for attrlist"); goto rollback; } } /* Add $ATTRIBUTE_LIST to mft record. */ if (ntfs_resident_attr_record_add(ni, AT_ATTRIBUTE_LIST, NULL, 0, NULL, 0, const_cpu_to_le16(0)) < 0) { err = errno; ntfs_log_perror("Couldn't add $ATTRIBUTE_LIST to MFT"); goto rollback; } /* Resize it. */ na = ntfs_attr_open(ni, AT_ATTRIBUTE_LIST, AT_UNNAMED, 0); if (!na) { err = errno; ntfs_log_perror("Failed to open just added $ATTRIBUTE_LIST"); goto remove_attrlist_record; } if (ntfs_attr_truncate(na, al_len)) { err = errno; ntfs_log_perror("Failed to resize just added $ATTRIBUTE_LIST"); ntfs_attr_close(na); goto remove_attrlist_record;; } ntfs_attr_put_search_ctx(ctx); ntfs_attr_close(na); return 0; remove_attrlist_record: /* Prevent ntfs_attr_recorm_rm from freeing attribute list. */ ni->attr_list = NULL; NInoClearAttrList(ni); /* Remove $ATTRIBUTE_LIST record. */ ntfs_attr_reinit_search_ctx(ctx); if (!ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { if (ntfs_attr_record_rm(ctx)) ntfs_log_perror("Rollback failed to remove attrlist"); } else ntfs_log_perror("Rollback failed to find attrlist"); /* Setup back in-memory runlist. */ ni->attr_list = al; ni->attr_list_size = al_len; NInoSetAttrList(ni); rollback: /* * Scan attribute list for attributes that placed not in the base MFT * record and move them to it. */ ntfs_attr_reinit_search_ctx(ctx); ale = (ATTR_LIST_ENTRY*)al; while ((u8*)ale < al + al_len) { if (MREF_LE(ale->mft_reference) != ni->mft_no) { if (!ntfs_attr_lookup(ale->type, ale->name, ale->name_length, CASE_SENSITIVE, sle64_to_cpu(ale->lowest_vcn), NULL, 0, ctx)) { if (ntfs_attr_record_move_to(ctx, ni)) ntfs_log_perror("Rollback failed to " "move attribute"); } else ntfs_log_perror("Rollback failed to find attr"); ntfs_attr_reinit_search_ctx(ctx); } ale = (ATTR_LIST_ENTRY*)((u8*)ale + le16_to_cpu(ale->length)); } /* Remove in-memory attribute list. */ ni->attr_list = NULL; ni->attr_list_size = 0; NInoClearAttrList(ni); NInoAttrListClearDirty(ni); put_err_out: ntfs_attr_put_search_ctx(ctx); err_out: free(al); errno = err; return -1; } /** * ntfs_inode_free_space - free space in the MFT record of an inode * @ni: ntfs inode in which MFT record needs more free space * @size: amount of space needed to free * * Return 0 on success or -1 on error with errno set to the error code. */ int ntfs_inode_free_space(ntfs_inode *ni, int size) { ntfs_attr_search_ctx *ctx; int freed; if (!ni || size < 0) { errno = EINVAL; ntfs_log_perror("%s: ni=%p size=%d", __FUNCTION__, ni, size); return -1; } ntfs_log_trace("Entering for inode %lld, size %d\n", (unsigned long long)ni->mft_no, size); freed = (le32_to_cpu(ni->mrec->bytes_allocated) - le32_to_cpu(ni->mrec->bytes_in_use)); if (size <= freed) return 0; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; /* * $STANDARD_INFORMATION and $ATTRIBUTE_LIST must stay in the base MFT * record, so position search context on the first attribute after them. */ if (ntfs_attr_position(AT_FILE_NAME, ctx)) goto put_err_out; while (1) { int record_size; /* * Check whether attribute is from different MFT record. If so, * find next, because we don't need such. */ while (ctx->ntfs_ino->mft_no != ni->mft_no) { retry: if (ntfs_attr_position(AT_UNUSED, ctx)) goto put_err_out; } if (ntfs_inode_base(ctx->ntfs_ino)->mft_no == FILE_MFT && ctx->attr->type == AT_DATA) goto retry; if (ctx->attr->type == AT_INDEX_ROOT) goto retry; record_size = le32_to_cpu(ctx->attr->length); if (ntfs_attr_record_move_away(ctx, 0)) { ntfs_log_perror("Failed to move out attribute #2"); break; } freed += record_size; /* Check whether we are done. */ if (size <= freed) { ntfs_attr_put_search_ctx(ctx); return 0; } /* * Reposition to first attribute after $STANDARD_INFORMATION * and $ATTRIBUTE_LIST instead of simply skipping this attribute * because in the case when we have got only in-memory attribute * list then ntfs_attr_lookup will fail when it tries to find * $ATTRIBUTE_LIST. */ ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_position(AT_FILE_NAME, ctx)) break; } put_err_out: ntfs_attr_put_search_ctx(ctx); if (errno == ENOSPC) ntfs_log_trace("No attributes left that could be moved out.\n"); return -1; } /** * ntfs_inode_update_times - update selected time fields for ntfs inode * @ni: ntfs inode for which update time fields * @mask: select which time fields should be updated * * This function updates time fields to current time. Fields to update are * selected using @mask (see enum @ntfs_time_update_flags for posssible values). */ void ntfs_inode_update_times(ntfs_inode *ni, ntfs_time_update_flags mask) { ntfs_time now; if (!ni) { ntfs_log_error("%s(): Invalid arguments.\n", __FUNCTION__); return; } if ((utils_is_metadata(ni) == 1 && ni->mft_no != FILE_root) || NVolReadOnly(ni->vol) || !mask) return; now = ntfs_current_time(); if (mask & NTFS_UPDATE_ATIME) ni->last_access_time = now; if (mask & NTFS_UPDATE_MTIME) ni->last_data_change_time = now; if (mask & NTFS_UPDATE_CTIME) ni->last_mft_change_time = now; NInoFileNameSetDirty(ni); NInoSetDirty(ni); } /** * ntfs_inode_badclus_bad - check for $Badclus:$Bad data attribute * @mft_no: mft record number where @attr is present * @attr: attribute record used to check for the $Bad attribute * * Check if the mft record given by @mft_no and @attr contains the bad sector * list. Please note that mft record numbers describing $Badclus extent inodes * will not match the current $Badclus:$Bad check. * * On success return 1 if the file is $Badclus:$Bad, otherwise return 0. * On error return -1 with errno set to the error code. */ int ntfs_inode_badclus_bad(u64 mft_no, ATTR_RECORD *attr) { int len, ret = 0; ntfschar *ustr; if (!attr) { ntfs_log_error("Invalid argument.\n"); errno = EINVAL; return -1; } if (mft_no != FILE_BadClus) return 0; if (attr->type != AT_DATA) return 0; if ((ustr = ntfs_str2ucs("$Bad", &len)) == NULL) { ntfs_log_perror("Couldn't convert '$Bad' to Unicode"); return -1; } if (ustr && ntfs_names_are_equal(ustr, len, (ntfschar *)((u8 *)attr + le16_to_cpu(attr->name_offset)), attr->name_length, 0, NULL, 0)) ret = 1; ntfs_ucsfree(ustr); return ret; } /* * Get high precision NTFS times * * They are returned in following order : create, update, access, change * provided they fit in requested size. * * Returns the modified size if successfull (or 32 if buffer size is null) * -errno if failed */ int ntfs_inode_get_times(ntfs_inode *ni, char *value, size_t size) { ntfs_attr_search_ctx *ctx; STANDARD_INFORMATION *std_info; u64 *times; int ret; ret = 0; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (ctx) { if (ntfs_attr_lookup(AT_STANDARD_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("Failed to get standard info (inode %lld)", (long long)ni->mft_no); } else { std_info = (STANDARD_INFORMATION *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); if (value && (size >= 8)) { times = (u64*)value; times[0] = sle64_to_cpu(std_info->creation_time); ret = 8; if (size >= 16) { times[1] = sle64_to_cpu(std_info->last_data_change_time); ret = 16; } if (size >= 24) { times[2] = sle64_to_cpu(std_info->last_access_time); ret = 24; } if (size >= 32) { times[3] = sle64_to_cpu(std_info->last_mft_change_time); ret = 32; } } else if (!size) ret = 32; else ret = -ERANGE; } ntfs_attr_put_search_ctx(ctx); } return (ret ? ret : -errno); } /* * Set high precision NTFS times * * They are expected in this order : create, update, access * provided they are present in input. The change time is set to * current time. * * The times are inserted directly in the standard_information and * file names attributes to avoid manipulating low precision times * * Returns 0 if success * -1 if there were an error (described by errno) */ int ntfs_inode_set_times(ntfs_inode *ni, const char *value, size_t size, int flags) { ntfs_attr_search_ctx *ctx; STANDARD_INFORMATION *std_info; FILE_NAME_ATTR *fn; u64 times[4]; ntfs_time now; int cnt; int ret; ret = -1; if ((size >= 8) && !(flags & XATTR_CREATE)) { /* Copy, to avoid alignment issue encountered on ARM */ memcpy(times, value, (size < sizeof(times) ? size : sizeof(times))); now = ntfs_current_time(); /* update the standard information attribute */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (ctx) { if (ntfs_attr_lookup(AT_STANDARD_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("Failed to get standard info (inode %lld)", (long long)ni->mft_no); } else { std_info = (STANDARD_INFORMATION *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); /* * Mark times set to avoid overwriting * them when the inode is closed. * The inode structure must also be updated * (with loss of precision) because of cacheing. * TODO : use NTFS precision in inode, and * return sub-second times in getattr() */ set_nino_flag(ni, TimesSet); std_info->creation_time = cpu_to_sle64(times[0]); ni->creation_time = std_info->creation_time; if (size >= 16) { std_info->last_data_change_time = cpu_to_sle64(times[1]); ni->last_data_change_time = std_info->last_data_change_time; } if (size >= 24) { std_info->last_access_time = cpu_to_sle64(times[2]); ni->last_access_time = std_info->last_access_time; } std_info->last_mft_change_time = now; ni->last_mft_change_time = now; ntfs_inode_mark_dirty(ctx->ntfs_ino); NInoFileNameSetDirty(ni); /* update the file names attributes */ ntfs_attr_reinit_search_ctx(ctx); cnt = 0; while (!ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { fn = (FILE_NAME_ATTR*)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); fn->creation_time = cpu_to_sle64(times[0]); if (size >= 16) fn->last_data_change_time = cpu_to_sle64(times[1]); if (size >= 24) fn->last_access_time = cpu_to_sle64(times[2]); fn->last_mft_change_time = now; cnt++; } if (cnt) ret = 0; else { ntfs_log_perror("Failed to get file names (inode %lld)", (long long)ni->mft_no); } } ntfs_attr_put_search_ctx(ctx); } } else if (size < 8) errno = ERANGE; else errno = EEXIST; return (ret); } ntfsprogs-plus-1.0.0/libntfs/ioctl.c000066400000000000000000000241111507404161300174350ustar00rootroot00000000000000/** * ioctl.c - Processing of ioctls * * This module is part of ntfs-3g library * * Copyright (c) 2014-2019 Jean-Pierre Andre * Copyright (c) 2014 Red Hat, Inc. * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_INTTYPES_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #include #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef MAJOR_IN_MKDEV #include #endif #ifdef MAJOR_IN_SYSMACROS #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_LINUX_FS_H #include #endif #include "compat.h" #include "debug.h" #include "bitmap.h" #include "attrib.h" #include "inode.h" #include "layout.h" #include "volume.h" #include "index.h" #include "logging.h" #include "ntfstime.h" #include "unistr.h" #include "dir.h" #include "security.h" #include "ioctl.h" #include "misc.h" #if defined(FITRIM) && defined(BLKDISCARD) /* Issue a TRIM request to the underlying device for the given clusters. */ static int fstrim_clusters(ntfs_volume *vol, LCN lcn, s64 length) { struct ntfs_device *dev = vol->dev; uint64_t range[2]; ntfs_log_debug("fstrim_clusters: %lld length %lld\n", (long long) lcn, (long long) length); range[0] = lcn << vol->cluster_size_bits; range[1] = length << vol->cluster_size_bits; if (dev->d_ops->ioctl(dev, BLKDISCARD, range) == -1) { ntfs_log_debug("fstrim_one_cluster: ioctl failed: %m\n"); return -errno; } return 0; } static int read_line(const char *path, char *line, size_t max_bytes) { FILE *fp; fp = fopen(path, "r"); if (fp == NULL) return -errno; if (fgets(line, max_bytes, fp) == NULL) { int ret = -EIO; /* fgets doesn't set errno */ fclose(fp); return ret; } fclose (fp); return 0; } static int read_u64(const char *path, u64 *n) { char line[64]; int ret; ret = read_line(path, line, sizeof line); if (ret) return ret; if (sscanf(line, "%" SCNu64, n) != 1) return -EINVAL; return 0; } /* Find discard limits for current backing device. */ static int fstrim_limits(ntfs_volume *vol, u64 *discard_alignment, u64 *discard_granularity, u64 *discard_max_bytes) { struct stat statbuf; char path1[40]; /* holds "/sys/dev/block/%d:%d" */ char path2[40 + sizeof(path1)]; /* less than 40 bytes more than path1 */ int ret; /* Stat the backing device. Caller has ensured it is a block device. */ if (stat(vol->dev->d_name, &statbuf) == -1) { ntfs_log_debug("fstrim_limits: could not stat %s\n", vol->dev->d_name); return -errno; } /* For whole devices, * /sys/dev/block/MAJOR:MINOR/discard_alignment * /sys/dev/block/MAJOR:MINOR/queue/discard_granularity * /sys/dev/block/MAJOR:MINOR/queue/discard_max_bytes * will exist. * For partitions, we also need to check the parent device: * /sys/dev/block/MAJOR:MINOR/../queue/discard_granularity * /sys/dev/block/MAJOR:MINOR/../queue/discard_max_bytes */ snprintf(path1, sizeof path1, "/sys/dev/block/%d:%d", major(statbuf.st_rdev), minor(statbuf.st_rdev)); snprintf(path2, sizeof path2, "%s/discard_alignment", path1); ret = read_u64(path2, discard_alignment); if (ret) { if (ret != -ENOENT) return ret; else /* We would expect this file to exist on all * modern kernels. But for the sake of very * old kernels: */ goto not_found; } snprintf(path2, sizeof path2, "%s/queue/discard_granularity", path1); ret = read_u64(path2, discard_granularity); if (ret) { if (ret != -ENOENT) return ret; else { snprintf(path2, sizeof path2, "%s/../queue/discard_granularity", path1); ret = read_u64(path2, discard_granularity); if (ret) { if (ret != -ENOENT) return ret; else goto not_found; } } } snprintf(path2, sizeof path2, "%s/queue/discard_max_bytes", path1); ret = read_u64(path2, discard_max_bytes); if (ret) { if (ret != -ENOENT) return ret; else { snprintf(path2, sizeof path2, "%s/../queue/discard_max_bytes", path1); ret = read_u64(path2, discard_max_bytes); if (ret) { if (ret != -ENOENT) return ret; else goto not_found; } } } return 0; not_found: /* If we reach here then we didn't find the device. This is * not an error, but set discard_max_bytes = 0 to indicate * that discard is not available. */ *discard_alignment = 0; *discard_granularity = 0; *discard_max_bytes = 0; return 0; } static inline LCN align_up(ntfs_volume *vol, LCN lcn, u64 granularity) { u64 aligned; aligned = (lcn << vol->cluster_size_bits) + granularity - 1; aligned -= aligned % granularity; return (aligned >> vol->cluster_size_bits); } static inline u64 align_down(ntfs_volume *vol, u64 count, u64 granularity) { u64 aligned; aligned = count << vol->cluster_size_bits; aligned -= aligned % granularity; return (aligned >> vol->cluster_size_bits); } #define FSTRIM_BUFSIZ 4096 /* Trim the filesystem. * * Free blocks between 'start' and 'start+len-1' (both byte offsets) * are found and TRIM requests are sent to the block device. 'minlen' * is the minimum continguous free range to discard. */ static int fstrim(ntfs_volume *vol, void *data, u64 *trimmed) { struct fstrim_range *range = data; u64 start = range->start; u64 len = range->len; u64 minlen = range->minlen; u64 discard_alignment, discard_granularity, discard_max_bytes; u8 *buf = NULL; LCN start_buf; int ret; ntfs_log_debug("fstrim: start=%llu len=%llu minlen=%llu\n", (unsigned long long) start, (unsigned long long) len, (unsigned long long) minlen); *trimmed = 0; /* Fail if user tries to use the fstrim -o/-l/-m options. * XXX We could fix these limitations in future. */ if (start != 0 || len != (uint64_t)-1) { ntfs_log_error("fstrim: setting start or length is not supported\n"); return -EINVAL; } if (minlen > vol->cluster_size) { ntfs_log_error("fstrim: minlen > cluster size is not supported\n"); return -EINVAL; } /* Only block devices are supported. It would be possible to * support backing files (ie. without using loop) but the * ioctls used to punch holes in files are completely * different. */ if (!NDevBlock(vol->dev)) { ntfs_log_error("fstrim: not supported for non-block-device\n"); return -EOPNOTSUPP; } ret = fstrim_limits(vol, &discard_alignment, &discard_granularity, &discard_max_bytes); if (ret) return ret; if (discard_alignment != 0) { ntfs_log_error("fstrim: backing device is not aligned for discards\n"); return -EOPNOTSUPP; } if (discard_max_bytes == 0) { ntfs_log_error("fstrim: backing device does not support discard (discard_max_bytes == 0)\n"); return -EOPNOTSUPP; } /* Sync the device before doing anything. */ ret = ntfs_device_sync(vol->dev); if (ret) return ret; /* Read through the bitmap. */ buf = ntfs_malloc(FSTRIM_BUFSIZ); if (buf == NULL) return -errno; for (start_buf = 0; start_buf < vol->nr_clusters; start_buf += FSTRIM_BUFSIZ * 8) { s64 count; s64 br; LCN end_buf, start_lcn; /* start_buf is LCN of first cluster in the current buffer. * end_buf is LCN of last cluster + 1 in the current buffer. */ end_buf = start_buf + FSTRIM_BUFSIZ*8; if (end_buf > vol->nr_clusters) end_buf = vol->nr_clusters; count = (end_buf - start_buf) / 8; br = ntfs_attr_pread(vol->lcnbmp_na, start_buf/8, count, buf); if (br != count) { if (br >= 0) ret = -EIO; else ret = -errno; goto free_out; } /* Trim the clusters in large as possible blocks, but * not larger than discard_max_bytes, and compatible * with the supported trim granularity. */ for (start_lcn = start_buf; start_lcn < end_buf; ++start_lcn) { if (!ntfs_bit_get(buf, start_lcn-start_buf)) { LCN end_lcn; LCN aligned_lcn; u64 aligned_count; /* Cluster 'start_lcn' is not in use, * find end of this run. */ end_lcn = start_lcn+1; while (end_lcn < end_buf && (u64) (end_lcn-start_lcn) << vol->cluster_size_bits < discard_max_bytes && !ntfs_bit_get(buf, end_lcn-start_buf)) end_lcn++; aligned_lcn = align_up(vol, start_lcn, discard_granularity); if (aligned_lcn >= end_lcn) aligned_count = 0; else { aligned_count = align_down(vol, end_lcn - aligned_lcn, discard_granularity); } if (aligned_count) { ret = fstrim_clusters(vol, aligned_lcn, aligned_count); if (ret) goto free_out; *trimmed += aligned_count << vol->cluster_size_bits; } start_lcn = end_lcn-1; } } } ret = 0; free_out: free(buf); return ret; } #endif /* FITRIM && BLKDISCARD */ int ntfs_ioctl(ntfs_inode *ni, unsigned long cmd, void *arg __attribute__((unused)), unsigned int flags __attribute__((unused)), void *data) { int ret = 0; switch (cmd) { #if defined(FITRIM) && defined(BLKDISCARD) case FITRIM: if (!ni || !data) ret = -EINVAL; else { u64 trimmed; struct fstrim_range *range = (struct fstrim_range*)data; ret = fstrim(ni->vol, data, &trimmed); range->len = trimmed; } break; #else #warning Trimming not supported : FITRIM or BLKDISCARD not defined #endif default : ret = -EINVAL; break; } return (ret); } ntfsprogs-plus-1.0.0/libntfs/lcnalloc.c000066400000000000000000000507561507404161300201300ustar00rootroot00000000000000/** * lcnalloc.c - Cluster (de)allocation code. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2004 Anton Altaparmakov * Copyright (c) 2004 Yura Pakhuchiy * Copyright (c) 2004-2008 Szabolcs Szakacsits * Copyright (c) 2008-2009 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "types.h" #include "attrib.h" #include "bitmap.h" #include "debug.h" #include "runlist.h" #include "volume.h" #include "lcnalloc.h" #include "logging.h" #include "misc.h" #include "fsck.h" /* * Plenty possibilities for big optimizations all over in the cluster * allocation, however at the moment the dominant bottleneck (~ 90%) is * the update of the mapping pairs which converges to the cubic Faulhaber's * formula as the function of the number of extents (fragments, runs). */ #define NTFS_LCNALLOC_BSIZE LCNBMP_ALLOC_SIZE #define NTFS_LCNALLOC_SKIP LCNBMP_ALLOC_SIZE enum { ZONE_MFT = 1, ZONE_DATA1 = 2, ZONE_DATA2 = 4 } ; static void ntfs_cluster_set_zone_pos(LCN start, LCN end, LCN *pos, LCN tc) { ntfs_log_trace("pos: %lld tc: %lld\n", (long long)*pos, (long long)tc); if (tc >= end) *pos = start; else if (tc >= start) *pos = tc; } static void ntfs_cluster_update_zone_pos(ntfs_volume *vol, u8 zone, LCN tc) { ntfs_log_trace("tc = %lld, zone = %d\n", (long long)tc, zone); if (zone == ZONE_MFT) ntfs_cluster_set_zone_pos(vol->mft_lcn, vol->mft_zone_end, &vol->mft_zone_pos, tc); else if (zone == ZONE_DATA1) ntfs_cluster_set_zone_pos(vol->mft_zone_end, vol->nr_clusters, &vol->data1_zone_pos, tc); else /* zone == ZONE_DATA2 */ ntfs_cluster_set_zone_pos(0, vol->mft_zone_start, &vol->data2_zone_pos, tc); } /* * Unmark full zones when a cluster has been freed in a full zone * * Next allocation will reuse the freed cluster */ static void update_full_status(ntfs_volume *vol, LCN lcn) { if (lcn >= vol->mft_zone_end) { if (vol->full_zones & ZONE_DATA1) { ntfs_cluster_update_zone_pos(vol, ZONE_DATA1, lcn); vol->full_zones &= ~ZONE_DATA1; } } else if (lcn < vol->mft_zone_start) { if (vol->full_zones & ZONE_DATA2) { ntfs_cluster_update_zone_pos(vol, ZONE_DATA2, lcn); vol->full_zones &= ~ZONE_DATA2; } } else { if (vol->full_zones & ZONE_MFT) { ntfs_cluster_update_zone_pos(vol, ZONE_MFT, lcn); vol->full_zones &= ~ZONE_MFT; } } } static s64 max_empty_bit_range(unsigned char *buf, int size) { int i, j, run = 0; int max_range = 0; s64 start_pos = -1; ntfs_log_trace("Entering\n"); i = 0; while (i < size) { switch (*buf) { case 0 : do { buf++; run += 8; i++; } while ((i < size) && !*buf); break; case 255 : if (run > max_range) { max_range = run; start_pos = (s64)i * 8 - run; } run = 0; do { buf++; i++; } while ((i < size) && (*buf == 255)); break; default : for (j = 0; j < 8; j++) { int bit = *buf & (1 << j); if (bit) { if (run > max_range) { max_range = run; start_pos = (s64)i * 8 + (j - run); } run = 0; } else run++; } i++; buf++; } } if (run > max_range) start_pos = (s64)i * 8 - run; return start_pos; } static int bitmap_writeback(ntfs_volume *vol, s64 pos, s64 size, void *b, u8 *writeback) { s64 written; ntfs_log_trace("Entering\n"); if (!*writeback) return 0; *writeback = 0; written = ntfs_attr_pwrite(vol->lcnbmp_na, pos, size, b); if (written != size) { if (!written) errno = EIO; ntfs_log_perror("Bitmap write error (%lld, %lld)", (long long)pos, (long long)size); return -1; } return 0; } /** * ntfs_cluster_alloc - allocate clusters on an ntfs volume * @vol: mounted ntfs volume on which to allocate the clusters * @start_vcn: vcn to use for the first allocated cluster * @count: number of clusters to allocate * @start_lcn: starting lcn at which to allocate the clusters (or -1 if none) * @zone: zone from which to allocate the clusters * * Allocate @count clusters preferably starting at cluster @start_lcn or at the * current allocator position if @start_lcn is -1, on the mounted ntfs volume * @vol. @zone is either DATA_ZONE for allocation of normal clusters and * MFT_ZONE for allocation of clusters for the master file table, i.e. the * $MFT/$DATA attribute. * * On success return a runlist describing the allocated cluster(s). * * On error return NULL with errno set to the error code. * * Notes on the allocation algorithm * ================================= * * There are two data zones. First is the area between the end of the mft zone * and the end of the volume, and second is the area between the start of the * volume and the start of the mft zone. On unmodified/standard NTFS 1.x * volumes, the second data zone doesn't exist due to the mft zone being * expanded to cover the start of the volume in order to reserve space for the * mft bitmap attribute. * * The complexity stems from the need of implementing the mft vs data zoned * approach and from the fact that we have access to the lcn bitmap via up to * LCNBMP_ALLOC_SIZE bytes at a time, so we need to cope with crossing over * boundaries of two buffers. Further, the fact that the allocator allows for * caller supplied hints as to the location of where allocation should begin * and the fact that the allocator keeps track of where in the data zones the * next natural allocation should occur, contribute to the complexity of the * function. But it should all be worthwhile, because this allocator: * 1) implements MFT zone reservation * 2) causes reduction in fragmentation. * The code is not optimized for speed. */ runlist *ntfs_cluster_alloc(ntfs_volume *vol, VCN start_vcn, s64 count, LCN start_lcn, const NTFS_CLUSTER_ALLOCATION_ZONES zone) { LCN zone_start, zone_end; /* current search range */ LCN last_read_pos, lcn; LCN bmp_pos; /* current bit position inside the bitmap */ LCN prev_lcn = 0, prev_run_len = 0; s64 clusters, br; runlist *rl = NULL, *trl; u8 *buf, *byte, bit, writeback; u8 pass = 1; /* 1: inside zone; 2: start of zone */ u8 search_zone; /* 4: data2 (start) 1: mft (middle) 2: data1 (end) */ u8 done_zones = 0; u8 has_guess, used_zone_pos; int err = 0, rlpos, rlsize, buf_size; ntfs_log_enter("Entering with count = 0x%llx, start_lcn = 0x%llx, " "zone = %s_ZONE.\n", (long long)count, (long long) start_lcn, zone == MFT_ZONE ? "MFT" : "DATA"); if (!vol || count < 0 || start_lcn < -1 || !vol->lcnbmp_na || (s8)zone < FIRST_ZONE || zone > LAST_ZONE) { errno = EINVAL; ntfs_log_perror("%s: vcn: %lld, count: %lld, lcn: %lld", __FUNCTION__, (long long)start_vcn, (long long)count, (long long)start_lcn); goto out; } /* Return empty runlist if @count == 0 */ if (!count) { rl = ntfs_malloc(0x1000); if (rl) { rl[0].vcn = start_vcn; rl[0].lcn = LCN_RL_NOT_MAPPED; rl[0].length = 0; } goto out; } buf = ntfs_malloc(LCNBMP_ALLOC_SIZE); if (!buf) goto out; /* * If no @start_lcn was requested, use the current zone * position otherwise use the requested @start_lcn. */ has_guess = 1; zone_start = start_lcn; if (zone_start < 0) { if (zone == DATA_ZONE) zone_start = vol->data1_zone_pos; else zone_start = vol->mft_zone_pos; has_guess = 0; } used_zone_pos = has_guess ? 0 : 1; if (!zone_start || zone_start == vol->mft_zone_start || zone_start == vol->mft_zone_end) pass = 2; if (zone_start < vol->mft_zone_start) { zone_end = vol->mft_zone_start; search_zone = ZONE_DATA2; } else if (zone_start < vol->mft_zone_end) { zone_end = vol->mft_zone_end; search_zone = ZONE_MFT; } else { zone_end = vol->nr_clusters; search_zone = ZONE_DATA1; } bmp_pos = zone_start; /* Loop until all clusters are allocated. */ clusters = count; rlpos = rlsize = 0; while (1) { /* check whether we have exhausted the current zone */ if (search_zone & vol->full_zones) goto zone_pass_done; last_read_pos = bmp_pos >> 3; br = ntfs_attr_pread(vol->lcnbmp_na, last_read_pos, LCNBMP_ALLOC_SIZE, buf); if (br <= 0) { if (!br) goto zone_pass_done; err = errno; ntfs_log_perror("Reading $BITMAP failed"); goto err_ret; } /* * We might have read less than LCNBMP_ALLOC_SIZE bytes * if we are close to the end of the attribute. */ buf_size = (int)br << 3; lcn = bmp_pos & 7; bmp_pos &= ~7; writeback = 0; while (lcn < buf_size) { byte = buf + (lcn >> 3); bit = 1 << (lcn & 7); if (has_guess) { if (*byte & bit) { has_guess = 0; break; } } else { lcn = max_empty_bit_range(buf, br); if (lcn < 0) break; has_guess = 1; continue; } /* First free bit is at lcn + bmp_pos. */ /* Reallocate memory if necessary. */ if ((rlpos + 2) * (int)sizeof(runlist) >= rlsize) { rlsize += 4096; trl = realloc(rl, rlsize); if (!trl) { err = ENOMEM; ntfs_log_perror("realloc() failed"); goto wb_err_ret; } rl = trl; } /* Allocate the bitmap bit. */ *byte |= bit; writeback = 1; /* set fsck lcn bitmap on fsck */ if (NVolFsck(vol)) { LCN lcn_no = lcn + bmp_pos; ntfs_fsck_set_lcnbmp_range(vol, lcn_no, 1, 1); ntfs_log_trace("last_read_pos %"PRIu64", lcn %"PRIu64"\n", last_read_pos, lcn_no); } if (NVolFreeSpaceKnown(vol)) { if (vol->free_clusters <= 0) ntfs_log_error("Non-positive free" " clusters (%lld)!\n", (long long)vol->free_clusters); else vol->free_clusters--; } /* * Coalesce with previous run if adjacent LCNs. * Otherwise, append a new run. */ if (prev_lcn == lcn + bmp_pos - prev_run_len && rlpos) { ntfs_log_debug("Cluster coalesce: prev_lcn: " "%lld lcn: %lld bmp_pos: %lld " "prev_run_len: %lld\n", (long long)prev_lcn, (long long)lcn, (long long)bmp_pos, (long long)prev_run_len); rl[rlpos - 1].length = ++prev_run_len; } else { if (rlpos) rl[rlpos].vcn = rl[rlpos - 1].vcn + prev_run_len; else { rl[rlpos].vcn = start_vcn; ntfs_log_debug("Start_vcn: %lld\n", (long long)start_vcn); } rl[rlpos].lcn = prev_lcn = lcn + bmp_pos; rl[rlpos].length = prev_run_len = 1; rlpos++; } ntfs_log_debug("RUN: %-16lld %-16lld %-16lld\n", (long long)rl[rlpos - 1].vcn, (long long)rl[rlpos - 1].lcn, (long long)rl[rlpos - 1].length); /* Done? */ if (!--clusters) { if (used_zone_pos) ntfs_cluster_update_zone_pos(vol, search_zone, lcn + bmp_pos + 1 + NTFS_LCNALLOC_SKIP); goto done_ret; } lcn++; } if (bitmap_writeback(vol, last_read_pos, br, buf, &writeback)) { err = errno; goto err_ret; } if (!used_zone_pos) { used_zone_pos = 1; if (search_zone == ZONE_MFT) zone_start = vol->mft_zone_pos; else if (search_zone == ZONE_DATA1) zone_start = vol->data1_zone_pos; else zone_start = vol->data2_zone_pos; if (!zone_start || zone_start == vol->mft_zone_start || zone_start == vol->mft_zone_end) pass = 2; bmp_pos = zone_start; } else bmp_pos += buf_size; if (bmp_pos < zone_end) continue; zone_pass_done: ntfs_log_trace("Finished current zone pass(%i).\n", pass); if (pass == 1) { pass = 2; zone_end = zone_start; if (search_zone == ZONE_MFT) zone_start = vol->mft_zone_start; else if (search_zone == ZONE_DATA1) zone_start = vol->mft_zone_end; else zone_start = 0; /* Sanity check. */ if (zone_end < zone_start) zone_end = zone_start; bmp_pos = zone_start; continue; } /* pass == 2 */ done_zones_check: done_zones |= search_zone; vol->full_zones |= search_zone; if (done_zones < (ZONE_MFT + ZONE_DATA1 + ZONE_DATA2)) { ntfs_log_trace("Switching zone.\n"); pass = 1; if (rlpos) { LCN tc = rl[rlpos - 1].lcn + rl[rlpos - 1].length + NTFS_LCNALLOC_SKIP; if (used_zone_pos) ntfs_cluster_update_zone_pos(vol, search_zone, tc); } switch (search_zone) { case ZONE_MFT: ntfs_log_trace("Zone switch: mft -> data1\n"); switch_to_data1_zone: search_zone = ZONE_DATA1; zone_start = vol->data1_zone_pos; zone_end = vol->nr_clusters; if (zone_start == vol->mft_zone_end) pass = 2; break; case ZONE_DATA1: ntfs_log_trace("Zone switch: data1 -> data2\n"); search_zone = ZONE_DATA2; zone_start = vol->data2_zone_pos; zone_end = vol->mft_zone_start; if (!zone_start) pass = 2; break; case ZONE_DATA2: if (!(done_zones & ZONE_DATA1)) { ntfs_log_trace("data2 -> data1\n"); goto switch_to_data1_zone; } ntfs_log_trace("Zone switch: data2 -> mft\n"); search_zone = ZONE_MFT; zone_start = vol->mft_zone_pos; zone_end = vol->mft_zone_end; if (zone_start == vol->mft_zone_start) pass = 2; break; } bmp_pos = zone_start; if (zone_start == zone_end) { ntfs_log_trace("Empty zone, skipped.\n"); goto done_zones_check; } continue; } ntfs_log_trace("All zones are finished, no space on device.\n"); err = ENOSPC; goto err_ret; } done_ret: ntfs_log_debug("At done_ret.\n"); /* Add runlist terminator element. */ rl[rlpos].vcn = rl[rlpos - 1].vcn + rl[rlpos - 1].length; rl[rlpos].lcn = LCN_RL_NOT_MAPPED; rl[rlpos].length = 0; if (bitmap_writeback(vol, last_read_pos, br, buf, &writeback)) { err = errno; goto err_ret; } done_err_ret: free(buf); if (err) { errno = err; ntfs_log_perror("Failed to allocate clusters"); rl = NULL; } out: ntfs_log_leave("\n"); return rl; wb_err_ret: ntfs_log_trace("At wb_err_ret.\n"); if (bitmap_writeback(vol, last_read_pos, br, buf, &writeback)) err = errno; err_ret: ntfs_log_trace("At err_ret.\n"); if (rl) { /* Add runlist terminator element. */ rl[rlpos].vcn = rl[rlpos - 1].vcn + rl[rlpos - 1].length; rl[rlpos].lcn = LCN_RL_NOT_MAPPED; rl[rlpos].length = 0; ntfs_debug_runlist_dump(rl); ntfs_cluster_free_from_rl(vol, rl); free(rl); rl = NULL; } goto done_err_ret; } /** * ntfs_cluster_free_from_rl - free clusters from runlist * @vol: mounted ntfs volume on which to free the clusters * @rl: runlist from which deallocate clusters * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_cluster_free_from_rl(ntfs_volume *vol, runlist *rl) { s64 nr_freed = 0; int ret = -1; ntfs_log_trace("Entering.\n"); for (; rl->length; rl++) { ntfs_log_trace("Dealloc lcn 0x%llx, len 0x%llx.\n", (long long)rl->lcn, (long long)rl->length); if (rl->lcn >= 0) { update_full_status(vol,rl->lcn); if (ntfs_bitmap_clear_run(vol->lcnbmp_na, rl->lcn, rl->length)) { ntfs_log_perror("Cluster deallocation failed " "(%lld, %lld)", (long long)rl->lcn, (long long)rl->length); goto out; } nr_freed += rl->length; if (NVolFsck(vol)) ntfs_fsck_set_lcnbmp_range(vol, rl->lcn, rl->length, 0); } } ret = 0; out: vol->free_clusters += nr_freed; if (NVolFreeSpaceKnown(vol) && (vol->free_clusters > vol->nr_clusters)) ntfs_log_error("Too many free clusters (%lld > %lld)!", (long long)vol->free_clusters, (long long)vol->nr_clusters); return ret; } /* * Basic cluster run free * Returns 0 if successful */ int ntfs_cluster_free_basic(ntfs_volume *vol, s64 lcn, s64 count) { s64 nr_freed = 0; int ret = -1; ntfs_log_trace("Entering.\n"); ntfs_log_trace("Dealloc lcn 0x%llx, len 0x%llx.\n", (long long)lcn, (long long)count); if (lcn >= 0) { update_full_status(vol,lcn); if (ntfs_bitmap_clear_run(vol->lcnbmp_na, lcn, count)) { ntfs_log_perror("Cluster deallocation failed " "(%lld, %lld)", (long long)lcn, (long long)count); goto out; } nr_freed += count; if (NVolFsck(vol)) ntfs_fsck_set_lcnbmp_range(vol, lcn, count, 0); } ret = 0; out: vol->free_clusters += nr_freed; if (vol->free_clusters > vol->nr_clusters) ntfs_log_error("Too many free clusters (%lld > %lld)!", (long long)vol->free_clusters, (long long)vol->nr_clusters); return ret; } /** * ntfs_cluster_free - free clusters on an ntfs volume * @vol: mounted ntfs volume on which to free the clusters * @na: attribute whose runlist describes the clusters to free * @start_vcn: vcn in @rl at which to start freeing clusters * @count: number of clusters to free or -1 for all clusters * * Free @count clusters starting at the cluster @start_vcn in the runlist * described by the attribute @na from the mounted ntfs volume @vol. * * If @count is -1, all clusters from @start_vcn to the end of the runlist * are deallocated. * * On success return the number of deallocated clusters (not counting sparse * clusters) and on error return -1 with errno set to the error code. */ int ntfs_cluster_free(ntfs_volume *vol, ntfs_attr *na, VCN start_vcn, s64 count) { runlist *rl; s64 delta, to_free, nr_freed = 0; int ret = -1; if (!vol || !vol->lcnbmp_na || !na || start_vcn < 0 || (count < 0 && count != -1)) { ntfs_log_trace("Invalid arguments!\n"); errno = EINVAL; return -1; } ntfs_log_enter("Entering for inode 0x%llx, attr 0x%x, count 0x%llx, " "vcn 0x%llx.\n", (unsigned long long)na->ni->mft_no, le32_to_cpu(na->type), (long long)count, (long long)start_vcn); rl = ntfs_attr_find_vcn(na, start_vcn); if (!rl) { if (errno == ENOENT) ret = 0; goto leave; } if (rl->lcn < 0 && rl->lcn != LCN_HOLE) { errno = EIO; ntfs_log_perror("%s: Unexpected lcn (%lld)", __FUNCTION__, (long long)rl->lcn); goto leave; } /* Find the starting cluster inside the run that needs freeing. */ delta = start_vcn - rl->vcn; /* The number of clusters in this run that need freeing. */ to_free = rl->length - delta; if (count >= 0 && to_free > count) to_free = count; if (rl->lcn != LCN_HOLE) { /* Do the actual freeing of the clusters in this run. */ update_full_status(vol,rl->lcn + delta); if (ntfs_bitmap_clear_run(vol->lcnbmp_na, rl->lcn + delta, to_free)) goto leave; nr_freed = to_free; if (NVolFsck(vol)) ntfs_fsck_set_lcnbmp_range(vol, rl->lcn + delta, to_free, 0); } /* Go to the next run and adjust the number of clusters left to free. */ ++rl; if (count >= 0) count -= to_free; /* * Loop over the remaining runs, using @count as a capping value, and * free them. */ for (; rl->length && count != 0; ++rl) { // FIXME: Need to try ntfs_attr_map_runlist() for attribute // list support! (AIA) if (rl->lcn < 0 && rl->lcn != LCN_HOLE) { if (NVolIsOnFsck(vol)) continue; // FIXME: Eeek! We need rollback! (AIA) errno = EIO; ntfs_log_perror("%s: Invalid lcn (%lli)", __FUNCTION__, (long long)rl->lcn); goto out; } /* The number of clusters in this run that need freeing. */ to_free = rl->length; if (count >= 0 && to_free > count) to_free = count; if (rl->lcn != LCN_HOLE) { update_full_status(vol,rl->lcn); if (ntfs_bitmap_clear_run(vol->lcnbmp_na, rl->lcn, to_free)) { // FIXME: Eeek! We need rollback! (AIA) ntfs_log_perror("%s: Clearing bitmap run failed", __FUNCTION__); goto out; } nr_freed += to_free; if (NVolFsck(vol)) ntfs_fsck_set_lcnbmp_range(vol, rl->lcn, to_free, 0); } if (count >= 0) count -= to_free; } if (count != -1 && count != 0) { // FIXME: Eeek! BUG() errno = EIO; ntfs_log_perror("%s: count still not zero (%lld)", __FUNCTION__, (long long)count); goto out; } ret = nr_freed; out: vol->free_clusters += nr_freed ; if (vol->free_clusters > vol->nr_clusters) ntfs_log_error("Too many free clusters (%lld > %lld)!", (long long)vol->free_clusters, (long long)vol->nr_clusters); leave: ntfs_log_leave("\n"); return ret; } ntfsprogs-plus-1.0.0/libntfs/lib_utils.c000066400000000000000000000121421507404161300203120ustar00rootroot00000000000000/** * utils.c - Part of the Linux-NTFS project. * * Copyright (c) 2002-2005 Richard Russon * Copyright (c) 2003-2006 Anton Altaparmakov * Copyright (c) 2003 Lode Leroy * Copyright (c) 2005-2007 Yura Pakhuchiy * Copyright (c) 2014 Jean-Pierre Andre * * This file is from src/utils.c to use function in libntfs-3g. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "lib_utils.h" #include "types.h" #include "debug.h" #include "logging.h" #include "misc.h" /** * find_attribute - Find an attribute of the given type * @type: An attribute type, e.g. AT_FILE_NAME * @ctx: A search context, created using ntfs_get_attr_search_ctx * * Using the search context to keep track, find the first/next occurrence of a * given attribute type. * * N.B. This will return a pointer into @mft. As long as the search context * has been created without an inode, it won't overflow the buffer. * * Return: Pointer Success, an attribute was found * NULL Error, no matching attributes were found */ ATTR_RECORD *find_attribute(const ATTR_TYPES type, ntfs_attr_search_ctx *ctx) { if (!ctx) { errno = EINVAL; return NULL; } if (ntfs_attr_lookup(type, NULL, 0, 0, 0, NULL, 0, ctx) != 0) { ntfs_log_debug("find_attribute didn't find an attribute of type: 0x%02x.\n", le32_to_cpu(type)); return NULL; /* None / no more of that type */ } ntfs_log_debug("find_attribute found an attribute of type: 0x%02x.\n", le32_to_cpu(type)); return ctx->attr; } /** * find_first_inode_attribute - Find the first attribute of a given type * it is same as find_first_attribute except using ctx * which have inode structure(ni). * find_first_attribute() can not find attribute if first attribute is * in extent mft record. */ ATTR_RECORD *find_first_inode_attribute(const ATTR_TYPES type, ntfs_inode *ni) { ntfs_attr_search_ctx *ctx; MFT_RECORD *mft; ATTR_RECORD *rec; if (!ni) { errno = EINVAL; return NULL; } mft = ni->mrec; ctx = ntfs_attr_get_search_ctx(ni, mft); if (!ctx) { ntfs_log_error("Couldn't create a search context.\n"); return NULL; } rec = find_attribute(type, ctx); ntfs_attr_put_search_ctx(ctx); if (rec) ntfs_log_debug("find_first_attribute: found attr of type 0x%02x.\n", le32_to_cpu(type)); else ntfs_log_debug("find_first_attribute: didn't find attr of type 0x%02x.\n", le32_to_cpu(type)); return rec; } /** * find_first_attribute - Find the first attribute of a given type * @type: An attribute type, e.g. AT_FILE_NAME * @mft: A buffer containing a raw MFT record * * Search through a raw MFT record for an attribute of a given type. * The return value is a pointer into the MFT record that was supplied. * * N.B. This will return a pointer into @mft. The pointer won't stray outside * the buffer, since we created the search context without an inode. * * Return: Pointer Success, an attribute was found * NULL Error, no matching attributes were found */ ATTR_RECORD *find_first_attribute(const ATTR_TYPES type, MFT_RECORD *mft) { ntfs_attr_search_ctx *ctx; ATTR_RECORD *rec; if (!mft) { errno = EINVAL; return NULL; } ctx = ntfs_attr_get_search_ctx(NULL, mft); if (!ctx) { ntfs_log_error("Couldn't create a search context.\n"); return NULL; } rec = find_attribute(type, ctx); ntfs_attr_put_search_ctx(ctx); if (rec) ntfs_log_debug("find_first_attribute: found attr of type 0x%02x.\n", le32_to_cpu(type)); else ntfs_log_debug("find_first_attribute: didn't find attr of type 0x%02x.\n", le32_to_cpu(type)); return rec; } /** * __metadata */ static int __metadata(ntfs_volume *vol, u64 num) { if (num <= FILE_UpCase) return 1; if (!vol) return -1; if ((vol->major_ver == 3) && (num == FILE_Extend)) return 1; return 0; } /** * utils_is_metadata - Determine if an inode represents a metadata file * @inode: An ntfs inode to be tested * * A handful of files in the volume contain filesystem data - metadata. * They can be identified by their inode number (offset in MFT/$DATA) or by * their parent. * * Return: 1 inode is a metadata file * 0 inode is not a metadata file * -1 Error occurred */ int utils_is_metadata(ntfs_inode *inode) { ntfs_volume *vol; ATTR_RECORD *rec; FILE_NAME_ATTR *attr; MFT_RECORD *file; u64 num; if (!inode) { errno = EINVAL; return -1; } vol = inode->vol; if (!vol) return -1; num = inode->mft_no; if (__metadata(vol, num) == 1) return 1; file = inode->mrec; if (file && (file->base_mft_record != 0)) { num = MREF_LE(file->base_mft_record); if (__metadata(vol, num) == 1) return 1; } rec = find_first_inode_attribute(AT_FILE_NAME, inode); if (!rec) return -1; /* We know this will always be resident. */ attr = (FILE_NAME_ATTR *)((char *)rec + le16_to_cpu(rec->value_offset)); num = MREF_LE(attr->parent_directory); if ((num != FILE_root) && (__metadata(vol, num) == 1)) return 1; if ((inode->flags & (FILE_ATTR_SYSTEM | FILE_ATTR_HIDDEN)) == (FILE_ATTR_SYSTEM | FILE_ATTR_HIDDEN)) return 1; return 0; } ntfsprogs-plus-1.0.0/libntfs/logfile.c000066400000000000000000000613711507404161300177550ustar00rootroot00000000000000/** * logfile.c - NTFS journal handling. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2005 Anton Altaparmakov * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2005-2009 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "attrib.h" #include "debug.h" #include "logfile.h" #include "volume.h" #include "mst.h" #include "logging.h" #include "misc.h" /** * ntfs_check_restart_page_header - check the page header for consistency * @rp: restart page header to check * @pos: position in logfile at which the restart page header resides * * Check the restart page header @rp for consistency and return TRUE if it is * consistent and FALSE otherwise. * * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not * require the full restart page. */ static BOOL ntfs_check_restart_page_header(RESTART_PAGE_HEADER *rp, s64 pos) { u32 logfile_system_page_size, logfile_log_page_size; u16 ra_ofs, usa_count, usa_ofs, usa_end = 0; BOOL have_usa = TRUE; ntfs_log_trace("Entering.\n"); /* * If the system or log page sizes are smaller than the ntfs block size * or either is not a power of 2 we cannot handle this log file. */ logfile_system_page_size = le32_to_cpu(rp->system_page_size); logfile_log_page_size = le32_to_cpu(rp->log_page_size); if (logfile_system_page_size < NTFS_BLOCK_SIZE || logfile_log_page_size < NTFS_BLOCK_SIZE || logfile_system_page_size & (logfile_system_page_size - 1) || logfile_log_page_size & (logfile_log_page_size - 1)) { ntfs_log_error("$LogFile uses unsupported page size.\n"); return FALSE; } /* * We must be either at !pos (1st restart page) or at pos = system page * size (2nd restart page). */ if (pos && pos != logfile_system_page_size) { ntfs_log_error("Found restart area in incorrect " "position in $LogFile.\n"); return FALSE; } /* * We only know how to handle version 1.1 and 2.0, though * version 2.0 is probably related to cached metadata in * Windows 8, and we will refuse to mount. * Nevertheless, do all the relevant checks before rejecting. */ if (((rp->major_ver != const_cpu_to_sle16(1)) || (rp->minor_ver != const_cpu_to_sle16(1))) && ((rp->major_ver != const_cpu_to_sle16(2)) || (rp->minor_ver != const_cpu_to_sle16(0)))) { ntfs_log_error("$LogFile version %i.%i is not " "supported.\n (This driver supports version " "1.1 and 2.0 only.)\n", (int)sle16_to_cpu(rp->major_ver), (int)sle16_to_cpu(rp->minor_ver)); return FALSE; } /* * If chkdsk has been run the restart page may not be protected by an * update sequence array. */ if (ntfs_is_chkd_record(rp->magic) && !le16_to_cpu(rp->usa_count)) { have_usa = FALSE; goto skip_usa_checks; } /* Verify the size of the update sequence array. */ usa_count = 1 + (logfile_system_page_size >> NTFS_BLOCK_SIZE_BITS); if (usa_count != le16_to_cpu(rp->usa_count)) { ntfs_log_error("$LogFile restart page specifies " "inconsistent update sequence array count.\n"); return FALSE; } /* Verify the position of the update sequence array. */ usa_ofs = le16_to_cpu(rp->usa_ofs); usa_end = usa_ofs + usa_count * sizeof(u16); if (usa_ofs < offsetof(RESTART_PAGE_HEADER, usn) || usa_end > NTFS_BLOCK_SIZE - sizeof(u16)) { ntfs_log_error("$LogFile restart page specifies " "inconsistent update sequence array offset.\n"); return FALSE; } skip_usa_checks: /* * Verify the position of the restart area. It must be: * - aligned to 8-byte boundary, * - after the update sequence array, and * - within the system page size. */ ra_ofs = le16_to_cpu(rp->restart_area_offset); if (ra_ofs & 7 || (have_usa ? ra_ofs < usa_end : ra_ofs < offsetof(RESTART_PAGE_HEADER, usn)) || ra_ofs > logfile_system_page_size) { ntfs_log_error("$LogFile restart page specifies " "inconsistent restart area offset.\n"); return FALSE; } /* * Only restart pages modified by chkdsk are allowed to have chkdsk_lsn * set. */ if (!ntfs_is_chkd_record(rp->magic) && sle64_to_cpu(rp->chkdsk_lsn)) { ntfs_log_error("$LogFile restart page is not modified " "by chkdsk but a chkdsk LSN is specified.\n"); return FALSE; } ntfs_log_trace("Done.\n"); return TRUE; } /** * ntfs_check_restart_area - check the restart area for consistency * @rp: restart page whose restart area to check * * Check the restart area of the restart page @rp for consistency and return * TRUE if it is consistent and FALSE otherwise. * * This function assumes that the restart page header has already been * consistency checked. * * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not * require the full restart page. */ static BOOL ntfs_check_restart_area(RESTART_PAGE_HEADER *rp) { u64 file_size; RESTART_AREA *ra; u16 ra_ofs, ra_len, ca_ofs; u8 fs_bits; ntfs_log_trace("Entering.\n"); ra_ofs = le16_to_cpu(rp->restart_area_offset); ra = (RESTART_AREA*)((u8*)rp + ra_ofs); /* * Everything before ra->file_size must be before the first word * protected by an update sequence number. This ensures that it is * safe to access ra->client_array_offset. */ if (ra_ofs + offsetof(RESTART_AREA, file_size) > NTFS_BLOCK_SIZE - sizeof(u16)) { ntfs_log_error("$LogFile restart area specifies " "inconsistent file offset.\n"); return FALSE; } /* * Now that we can access ra->client_array_offset, make sure everything * up to the log client array is before the first word protected by an * update sequence number. This ensures we can access all of the * restart area elements safely. Also, the client array offset must be * aligned to an 8-byte boundary. */ ca_ofs = le16_to_cpu(ra->client_array_offset); if (((ca_ofs + 7) & ~7) != ca_ofs || ra_ofs + ca_ofs > (u16)(NTFS_BLOCK_SIZE - sizeof(u16))) { ntfs_log_error("$LogFile restart area specifies " "inconsistent client array offset.\n"); return FALSE; } /* * The restart area must end within the system page size both when * calculated manually and as specified by ra->restart_area_length. * Also, the calculated length must not exceed the specified length. */ ra_len = ca_ofs + le16_to_cpu(ra->log_clients) * sizeof(LOG_CLIENT_RECORD); if ((u32)(ra_ofs + ra_len) > le32_to_cpu(rp->system_page_size) || (u32)(ra_ofs + le16_to_cpu(ra->restart_area_length)) > le32_to_cpu(rp->system_page_size) || ra_len > le16_to_cpu(ra->restart_area_length)) { ntfs_log_error("$LogFile restart area is out of bounds " "of the system page size specified by the " "restart page header and/or the specified " "restart area length is inconsistent.\n"); return FALSE; } /* * The ra->client_free_list and ra->client_in_use_list must be either * LOGFILE_NO_CLIENT or less than ra->log_clients or they are * overflowing the client array. */ if ((ra->client_free_list != LOGFILE_NO_CLIENT && le16_to_cpu(ra->client_free_list) >= le16_to_cpu(ra->log_clients)) || (ra->client_in_use_list != LOGFILE_NO_CLIENT && le16_to_cpu(ra->client_in_use_list) >= le16_to_cpu(ra->log_clients))) { ntfs_log_error("$LogFile restart area specifies " "overflowing client free and/or in use lists.\n"); return FALSE; } /* * Check ra->seq_number_bits against ra->file_size for consistency. * We cannot just use ffs() because the file size is not a power of 2. */ file_size = (u64)sle64_to_cpu(ra->file_size); fs_bits = 0; while (file_size) { file_size >>= 1; fs_bits++; } if (le32_to_cpu(ra->seq_number_bits) != (u32)(67 - fs_bits)) { ntfs_log_error("$LogFile restart area specifies " "inconsistent sequence number bits.\n"); return FALSE; } /* The log record header length must be a multiple of 8. */ if (((le16_to_cpu(ra->log_record_header_length) + 7) & ~7) != le16_to_cpu(ra->log_record_header_length)) { ntfs_log_error("$LogFile restart area specifies " "inconsistent log record header length.\n"); return FALSE; } /* Ditto for the log page data offset. */ if (((le16_to_cpu(ra->log_page_data_offset) + 7) & ~7) != le16_to_cpu(ra->log_page_data_offset)) { ntfs_log_error("$LogFile restart area specifies " "inconsistent log page data offset.\n"); return FALSE; } ntfs_log_trace("Done.\n"); return TRUE; } /** * ntfs_check_log_client_array - check the log client array for consistency * @rp: restart page whose log client array to check * * Check the log client array of the restart page @rp for consistency and * return TRUE if it is consistent and FALSE otherwise. * * This function assumes that the restart page header and the restart area have * already been consistency checked. * * Unlike ntfs_check_restart_page_header() and ntfs_check_restart_area(), this * function needs @rp->system_page_size bytes in @rp, i.e. it requires the full * restart page and the page must be multi sector transfer deprotected. */ static BOOL ntfs_check_log_client_array(RESTART_PAGE_HEADER *rp) { RESTART_AREA *ra; LOG_CLIENT_RECORD *ca, *cr; u16 nr_clients, idx; BOOL in_free_list, idx_is_first; u32 offset_clients; ntfs_log_trace("Entering.\n"); /* The restart area must be fully within page */ if ((le16_to_cpu(rp->restart_area_offset) + sizeof(RESTART_AREA)) > le32_to_cpu(rp->system_page_size)) goto err_out; ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset)); offset_clients = le16_to_cpu(rp->restart_area_offset) + le16_to_cpu(ra->client_array_offset); /* The clients' records must begin within page */ if (offset_clients >= le32_to_cpu(rp->system_page_size)) goto err_out; ca = (LOG_CLIENT_RECORD*)((u8*)ra + le16_to_cpu(ra->client_array_offset)); /* * Check the ra->client_free_list first and then check the * ra->client_in_use_list. Check each of the log client records in * each of the lists and check that the array does not overflow the * ra->log_clients value. Also keep track of the number of records * visited as there cannot be more than ra->log_clients records and * that way we detect eventual loops in within a list. */ nr_clients = le16_to_cpu(ra->log_clients); idx = le16_to_cpu(ra->client_free_list); in_free_list = TRUE; check_list: for (idx_is_first = TRUE; idx != LOGFILE_NO_CLIENT_CPU; nr_clients--, idx = le16_to_cpu(cr->next_client)) { if (!nr_clients || idx >= le16_to_cpu(ra->log_clients)) goto err_out; /* The client record must be fully within page */ if ((offset_clients + (idx + 1)*sizeof(LOG_CLIENT_RECORD)) > le32_to_cpu(rp->system_page_size)) goto err_out; /* Set @cr to the current log client record. */ cr = ca + idx; /* The first log client record must not have a prev_client. */ if (idx_is_first) { if (cr->prev_client != LOGFILE_NO_CLIENT) goto err_out; idx_is_first = FALSE; } } /* Switch to and check the in use list if we just did the free list. */ if (in_free_list) { in_free_list = FALSE; idx = le16_to_cpu(ra->client_in_use_list); goto check_list; } ntfs_log_trace("Done.\n"); return TRUE; err_out: ntfs_log_error("$LogFile log client array is corrupt.\n"); return FALSE; } /** * ntfs_check_and_load_restart_page - check the restart page for consistency * @log_na: opened ntfs attribute for journal $LogFile * @rp: restart page to check * @pos: position in @log_na at which the restart page resides * @wrp: [OUT] copy of the multi sector transfer deprotected restart page * @lsn: [OUT] set to the current logfile lsn on success * * Check the restart page @rp for consistency and return 0 if it is consistent * and errno otherwise. The restart page may have been modified by chkdsk in * which case its magic is CHKD instead of RSTR. * * This function only needs NTFS_BLOCK_SIZE bytes in @rp, i.e. it does not * require the full restart page. * * If @wrp is not NULL, on success, *@wrp will point to a buffer containing a * copy of the complete multi sector transfer deprotected page. On failure, * *@wrp is undefined. * * Similarly, if @lsn is not NULL, on success *@lsn will be set to the current * logfile lsn according to this restart page. On failure, *@lsn is undefined. * * The following error codes are defined: * EINVAL - The restart page is inconsistent. * ENOMEM - Not enough memory to load the restart page. * EIO - Failed to reading from $LogFile. */ static int ntfs_check_and_load_restart_page(ntfs_attr *log_na, RESTART_PAGE_HEADER *rp, s64 pos, RESTART_PAGE_HEADER **wrp, LSN *lsn) { RESTART_AREA *ra; RESTART_PAGE_HEADER *trp; int err; ntfs_log_trace("Entering.\n"); /* Check the restart page header for consistency. */ if (!ntfs_check_restart_page_header(rp, pos)) { /* Error output already done inside the function. */ return EINVAL; } /* Check the restart area for consistency. */ if (!ntfs_check_restart_area(rp)) { /* Error output already done inside the function. */ return EINVAL; } ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset)); /* * Allocate a buffer to store the whole restart page so we can multi * sector transfer deprotect it. * For safety, make sure this is consistent with the usa_count * and shorter than the full log size */ if ((le32_to_cpu(rp->system_page_size) > (u32)(le16_to_cpu(rp->usa_count) - 1)*NTFS_BLOCK_SIZE) || (le32_to_cpu(rp->system_page_size) > le64_to_cpu(log_na->data_size))) return (EINVAL); trp = ntfs_malloc(le32_to_cpu(rp->system_page_size)); if (!trp) return errno; /* * Read the whole of the restart page into the buffer. If it fits * completely inside @rp, just copy it from there. Otherwise read it * from disk. */ if (le32_to_cpu(rp->system_page_size) <= NTFS_BLOCK_SIZE) memcpy(trp, rp, le32_to_cpu(rp->system_page_size)); else if (ntfs_attr_pread(log_na, pos, le32_to_cpu(rp->system_page_size), trp) != le32_to_cpu(rp->system_page_size)) { err = errno; ntfs_log_error("Failed to read whole restart page into the " "buffer.\n"); if (err != ENOMEM) err = EIO; goto err_out; } /* * Perform the multi sector transfer deprotection on the buffer if the * restart page is protected. */ if ((!ntfs_is_chkd_record(trp->magic) || le16_to_cpu(trp->usa_count)) && ntfs_mst_post_read_fixup((NTFS_RECORD*)trp, le32_to_cpu(rp->system_page_size))) { /* * A multi sector tranfer error was detected. We only need to * abort if the restart page contents exceed the multi sector * transfer fixup of the first sector. */ if (le16_to_cpu(rp->restart_area_offset) + le16_to_cpu(ra->restart_area_length) > NTFS_BLOCK_SIZE - (int)sizeof(u16)) { ntfs_log_error("Multi sector transfer error " "detected in $LogFile restart page.\n"); err = EINVAL; goto err_out; } } /* * If the restart page is modified by chkdsk or there are no active * logfile clients, the logfile is consistent. Otherwise, need to * check the log client records for consistency, too. */ err = 0; if (ntfs_is_rstr_record(rp->magic) && ra->client_in_use_list != LOGFILE_NO_CLIENT) { if (!ntfs_check_log_client_array(trp)) { err = EINVAL; goto err_out; } } if (lsn) { if (ntfs_is_rstr_record(rp->magic)) *lsn = sle64_to_cpu(ra->current_lsn); else /* if (ntfs_is_chkd_record(rp->magic)) */ *lsn = sle64_to_cpu(rp->chkdsk_lsn); } ntfs_log_trace("Done.\n"); if (wrp) *wrp = trp; else { err_out: free(trp); } return err; } /** * ntfs_check_logfile - check in the journal if the volume is consistent * @log_na: ntfs attribute of loaded journal $LogFile to check * @rp: [OUT] on success this is a copy of the current restart page * * Check the $LogFile journal for consistency and return TRUE if it is * consistent and FALSE if not. On success, the current restart page is * returned in *@rp. Caller must call ntfs_free(*@rp) when finished with it. * * At present we only check the two restart pages and ignore the log record * pages. * * Note that the MstProtected flag is not set on the $LogFile inode and hence * when reading pages they are not deprotected. This is because we do not know * if the $LogFile was created on a system with a different page size to ours * yet and mst deprotection would fail if our page size is smaller. */ BOOL ntfs_check_logfile(ntfs_attr *log_na, RESTART_PAGE_HEADER **rp) { s64 size, pos; LSN rstr1_lsn, rstr2_lsn; ntfs_volume *vol = log_na->ni->vol; u8 *kaddr = NULL; RESTART_PAGE_HEADER *rstr1_ph = NULL; RESTART_PAGE_HEADER *rstr2_ph = NULL; int log_page_size, err; BOOL logfile_is_empty = TRUE; u8 log_page_bits; ntfs_log_trace("Entering.\n"); /* An empty $LogFile must have been clean before it got emptied. */ if (NVolLogFileEmpty(vol)) goto is_empty; size = log_na->data_size; /* Make sure the file doesn't exceed the maximum allowed size. */ if (size > (s64)MaxLogFileSize) size = MaxLogFileSize; log_page_size = DefaultLogPageSize; /* * Use generic_ffs() instead of ffs() to enable the compiler to * optimize log_page_size and log_page_bits into constants. */ log_page_bits = ffs(log_page_size) - 1; size &= ~(log_page_size - 1); /* * Ensure the log file is big enough to store at least the two restart * pages and the minimum number of log record pages. */ if (size < log_page_size * 2 || (size - log_page_size * 2) >> log_page_bits < MinLogRecordPages) { ntfs_log_error("$LogFile is too small.\n"); return FALSE; } /* Allocate memory for restart page. */ kaddr = ntfs_malloc(NTFS_BLOCK_SIZE); if (!kaddr) return FALSE; /* * Read through the file looking for a restart page. Since the restart * page header is at the beginning of a page we only need to search at * what could be the beginning of a page (for each page size) rather * than scanning the whole file byte by byte. If all potential places * contain empty and uninitialized records, the log file can be assumed * to be empty. */ for (pos = 0; pos < size; pos <<= 1) { /* * Read first NTFS_BLOCK_SIZE bytes of potential restart page. */ if (ntfs_attr_pread(log_na, pos, NTFS_BLOCK_SIZE, kaddr) != NTFS_BLOCK_SIZE) { ntfs_log_error("Failed to read first NTFS_BLOCK_SIZE " "bytes of potential restart page.\n"); goto err_out; } /* * A non-empty block means the logfile is not empty while an * empty block after a non-empty block has been encountered * means we are done. */ if (!ntfs_is_empty_recordp((le32*)kaddr)) logfile_is_empty = FALSE; else if (!logfile_is_empty) break; /* * A log record page means there cannot be a restart page after * this so no need to continue searching. */ if (ntfs_is_rcrd_recordp((le32*)kaddr)) break; /* If not a (modified by chkdsk) restart page, continue. */ if (!ntfs_is_rstr_recordp((le32*)kaddr) && !ntfs_is_chkd_recordp((le32*)kaddr)) { if (!pos) pos = NTFS_BLOCK_SIZE >> 1; continue; } /* * Check the (modified by chkdsk) restart page for consistency * and get a copy of the complete multi sector transfer * deprotected restart page. */ err = ntfs_check_and_load_restart_page(log_na, (RESTART_PAGE_HEADER*)kaddr, pos, !rstr1_ph ? &rstr1_ph : &rstr2_ph, !rstr1_ph ? &rstr1_lsn : &rstr2_lsn); if (!err) { /* * If we have now found the first (modified by chkdsk) * restart page, continue looking for the second one. */ if (!pos) { pos = NTFS_BLOCK_SIZE >> 1; continue; } /* * We have now found the second (modified by chkdsk) * restart page, so we can stop looking. */ break; } /* * Error output already done inside the function. Note, we do * not abort if the restart page was invalid as we might still * find a valid one further in the file. */ if (err != EINVAL) goto err_out; /* Continue looking. */ if (!pos) pos = NTFS_BLOCK_SIZE >> 1; } if (kaddr) { free(kaddr); kaddr = NULL; } if (logfile_is_empty) { NVolSetLogFileEmpty(vol); is_empty: ntfs_log_trace("Done. ($LogFile is empty.)\n"); return TRUE; } if (!rstr1_ph) { if (rstr2_ph) ntfs_log_error("BUG: rstr2_ph isn't NULL!\n"); ntfs_log_error("Did not find any restart pages in " "$LogFile and it was not empty.\n"); return FALSE; } /* If both restart pages were found, use the more recent one. */ if (rstr2_ph) { /* * If the second restart area is more recent, switch to it. * Otherwise just throw it away. */ if (rstr2_lsn > rstr1_lsn) { ntfs_log_debug("Using second restart page as it is more " "recent.\n"); free(rstr1_ph); rstr1_ph = rstr2_ph; /* rstr1_lsn = rstr2_lsn; */ } else { ntfs_log_debug("Using first restart page as it is more " "recent.\n"); free(rstr2_ph); } rstr2_ph = NULL; } /* All consistency checks passed. */ if (rp) *rp = rstr1_ph; else free(rstr1_ph); ntfs_log_trace("Done.\n"); return TRUE; err_out: free(kaddr); free(rstr1_ph); free(rstr2_ph); return FALSE; } /** * ntfs_is_logfile_clean - check in the journal if the volume is clean * @log_na: ntfs attribute of loaded journal $LogFile to check * @rp: copy of the current restart page * * Analyze the $LogFile journal and return TRUE if it indicates the volume was * shutdown cleanly and FALSE if not. * * At present we only look at the two restart pages and ignore the log record * pages. This is a little bit crude in that there will be a very small number * of cases where we think that a volume is dirty when in fact it is clean. * This should only affect volumes that have not been shutdown cleanly but did * not have any pending, non-check-pointed i/o, i.e. they were completely idle * at least for the five seconds preceding the unclean shutdown. * * This function assumes that the $LogFile journal has already been consistency * checked by a call to ntfs_check_logfile() and in particular if the $LogFile * is empty this function requires that NVolLogFileEmpty() is true otherwise an * empty volume will be reported as dirty. */ BOOL ntfs_is_logfile_clean(ntfs_attr *log_na, RESTART_PAGE_HEADER *rp) { RESTART_AREA *ra; ntfs_log_trace("Entering.\n"); /* An empty $LogFile must have been clean before it got emptied. */ if (NVolLogFileEmpty(log_na->ni->vol)) { ntfs_log_trace("$LogFile is empty\n"); return TRUE; } if (!rp) { ntfs_log_error("Restart page header is NULL\n"); return FALSE; } if (!ntfs_is_rstr_record(rp->magic) && !ntfs_is_chkd_record(rp->magic)) { ntfs_log_error("Restart page buffer is invalid\n"); return FALSE; } ra = (RESTART_AREA*)((u8*)rp + le16_to_cpu(rp->restart_area_offset)); /* * If the $LogFile has active clients, i.e. it is open, and we do not * have the RESTART_VOLUME_IS_CLEAN bit set in the restart area flags, * we assume there was an unclean shutdown. */ if (ra->client_in_use_list != LOGFILE_NO_CLIENT && !(ra->flags & RESTART_VOLUME_IS_CLEAN)) { ntfs_log_error("The disk contains an unclean file system (%d, " "%d).\n", le16_to_cpu(ra->client_in_use_list), le16_to_cpu(ra->flags)); return FALSE; } /* $LogFile indicates a clean shutdown. */ ntfs_log_trace("$LogFile indicates a clean shutdown\n"); return TRUE; } /** * ntfs_empty_logfile - empty the contents of the $LogFile journal * @na: ntfs attribute of journal $LogFile to empty * * Empty the contents of the $LogFile journal @na and return 0 on success and * -1 on error. * * This function assumes that the $LogFile journal has already been consistency * checked by a call to ntfs_check_logfile() and that ntfs_is_logfile_clean() * has been used to ensure that the $LogFile is clean. */ int ntfs_empty_logfile(ntfs_attr *na) { s64 pos, count; char buf[NTFS_BUF_SIZE]; ntfs_log_trace("Entering.\n"); if (NVolLogFileEmpty(na->ni->vol)) return 0; if (!NAttrNonResident(na)) { errno = EIO; ntfs_log_perror("Resident $LogFile $DATA attribute"); return -1; } memset(buf, -1, NTFS_BUF_SIZE); pos = 0; while ((count = na->data_size - pos) > 0) { if (count > NTFS_BUF_SIZE) count = NTFS_BUF_SIZE; count = ntfs_attr_pwrite(na, pos, count, buf); if (count <= 0) { ntfs_log_perror("Failed to reset $LogFile"); if (count != -1) errno = EIO; return -1; } pos += count; } NVolSetLogFileEmpty(na->ni->vol); return 0; } ntfsprogs-plus-1.0.0/libntfs/logging.c000066400000000000000000000414701507404161300177600ustar00rootroot00000000000000/** * logging.c - Centralised logging. Originated from the Linux-NTFS project. * * Copyright (c) 2005 Richard Russon * Copyright (c) 2005-2008 Szabolcs Szakacsits * Copyright (c) 2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STDARG_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_SYSLOG_H #include #endif #include "logging.h" #include "misc.h" #ifndef PATH_SEP #define PATH_SEP '/' #endif #ifdef DEBUG static int tab; #endif /* Some gcc 3.x, 4.[01].X crash with internal compiler error. */ #if __GNUC__ <= 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 1) # define BROKEN_GCC_FORMAT_ATTRIBUTE #else # define BROKEN_GCC_FORMAT_ATTRIBUTE __attribute__((format(printf, 6, 0))) #endif /** * struct ntfs_logging - Control info for the logging system * @levels: Bitfield of logging levels * @flags: Flags which affect the output style * @handler: Function to perform the actual logging */ struct ntfs_logging { u32 levels; u32 flags; ntfs_log_handler *handler BROKEN_GCC_FORMAT_ATTRIBUTE; }; /** * ntfs_log * This struct controls all the logging within the library and tools. */ static struct ntfs_logging ntfs_log = { #ifdef DEBUG NTFS_LOG_LEVEL_DEBUG | NTFS_LOG_LEVEL_TRACE | NTFS_LOG_LEVEL_ENTER | NTFS_LOG_LEVEL_LEAVE | #endif NTFS_LOG_LEVEL_INFO | NTFS_LOG_LEVEL_QUIET | NTFS_LOG_LEVEL_WARNING | NTFS_LOG_LEVEL_ERROR | NTFS_LOG_LEVEL_PERROR | NTFS_LOG_LEVEL_CRITICAL | NTFS_LOG_LEVEL_PROGRESS, NTFS_LOG_FLAG_ONLYNAME, #ifdef DEBUG ntfs_log_handler_outerr #else ntfs_log_handler_null #endif }; /** * ntfs_log_get_levels - Get a list of the current logging levels * * Find out which logging levels are enabled. * * Returns: Log levels in a 32-bit field */ u32 ntfs_log_get_levels(void) { return ntfs_log.levels; } /** * ntfs_log_set_levels - Enable extra logging levels * @levels: 32-bit field of log levels to set * * Enable one or more logging levels. * The logging levels are named: NTFS_LOG_LEVEL_*. * * Returns: Log levels that were enabled before the call */ u32 ntfs_log_set_levels(u32 levels) { u32 old; old = ntfs_log.levels; ntfs_log.levels |= levels; return old; } /** * ntfs_log_clear_levels - Disable some logging levels * @levels: 32-bit field of log levels to clear * * Disable one or more logging levels. * The logging levels are named: NTFS_LOG_LEVEL_*. * * Returns: Log levels that were enabled before the call */ u32 ntfs_log_clear_levels(u32 levels) { u32 old; old = ntfs_log.levels; ntfs_log.levels &= (~levels); return old; } /** * ntfs_log_get_flags - Get a list of logging style flags * * Find out which logging flags are enabled. * * Returns: Logging flags in a 32-bit field */ u32 ntfs_log_get_flags(void) { return ntfs_log.flags; } /** * ntfs_log_set_flags - Enable extra logging style flags * @flags: 32-bit field of logging flags to set * * Enable one or more logging flags. * The log flags are named: NTFS_LOG_LEVEL_*. * * Returns: Logging flags that were enabled before the call */ u32 ntfs_log_set_flags(u32 flags) { u32 old; old = ntfs_log.flags; ntfs_log.flags |= flags; return old; } /** * ntfs_log_clear_flags - Disable some logging styles * @flags: 32-bit field of logging flags to clear * * Disable one or more logging flags. * The log flags are named: NTFS_LOG_LEVEL_*. * * Returns: Logging flags that were enabled before the call */ u32 ntfs_log_clear_flags(u32 flags) { u32 old; old = ntfs_log.flags; ntfs_log.flags &= (~flags); return old; } /** * ntfs_log_get_stream - Default output streams for logging levels * @level: Log level * * By default, urgent messages are sent to "stderr". * Other messages are sent to "stdout". * * Returns: "string" Prefix to be used */ static FILE * ntfs_log_get_stream(u32 level) { FILE *stream; switch (level) { case NTFS_LOG_LEVEL_INFO: case NTFS_LOG_LEVEL_QUIET: case NTFS_LOG_LEVEL_PROGRESS: case NTFS_LOG_LEVEL_VERBOSE: stream = stdout; break; case NTFS_LOG_LEVEL_DEBUG: case NTFS_LOG_LEVEL_TRACE: case NTFS_LOG_LEVEL_ENTER: case NTFS_LOG_LEVEL_LEAVE: case NTFS_LOG_LEVEL_WARNING: case NTFS_LOG_LEVEL_ERROR: case NTFS_LOG_LEVEL_CRITICAL: case NTFS_LOG_LEVEL_PERROR: default: stream = stderr; break; } return stream; } /** * ntfs_log_get_prefix - Default prefixes for logging levels * @level: Log level to be prefixed * * Prefixing the logging output can make it easier to parse. * * Returns: "string" Prefix to be used */ static const char * ntfs_log_get_prefix(u32 level) { const char *prefix; switch (level) { case NTFS_LOG_LEVEL_DEBUG: prefix = "DEBUG: "; break; case NTFS_LOG_LEVEL_TRACE: prefix = "TRACE: "; break; case NTFS_LOG_LEVEL_QUIET: prefix = "QUIET: "; break; case NTFS_LOG_LEVEL_INFO: prefix = "INFO: "; break; case NTFS_LOG_LEVEL_VERBOSE: prefix = "VERBOSE: "; break; case NTFS_LOG_LEVEL_PROGRESS: prefix = "PROGRESS: "; break; case NTFS_LOG_LEVEL_WARNING: prefix = "WARNING: "; break; case NTFS_LOG_LEVEL_ERROR: prefix = "ERROR: "; break; case NTFS_LOG_LEVEL_PERROR: prefix = "ERROR: "; break; case NTFS_LOG_LEVEL_CRITICAL: prefix = "CRITICAL: "; break; default: prefix = ""; break; } return prefix; } /** * ntfs_log_set_handler - Provide an alternate logging handler * @handler: function to perform the logging * * This alternate handler will be called for all future logging requests. * If no @handler is specified, logging will revert to the default handler. */ void ntfs_log_set_handler(ntfs_log_handler *handler) { if (handler) { ntfs_log.handler = handler; #ifdef HAVE_SYSLOG_H if (handler == ntfs_log_handler_syslog) openlog("ntfs-3g", LOG_PID, LOG_USER); #endif } else ntfs_log.handler = ntfs_log_handler_null; } /** * ntfs_log_redirect - Pass on the request to the real handler * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @...: Arguments to be formatted * * This is just a redirector function. The arguments are simply passed to the * main logging handler (as defined in the global logging struct @ntfs_log). * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ int ntfs_log_redirect(const char *function, const char *file, int line, u32 level, void *data, const char *format, ...) { int olderr = errno; int ret; va_list args; if (!(ntfs_log.levels & level)) /* Don't log this message */ return 0; va_start(args, format); errno = olderr; ret = ntfs_log.handler(function, file, line, level, data, format, args); va_end(args); errno = olderr; return ret; } /** * ntfs_log_handler_syslog - syslog logging handler * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * A simple syslog logging handler. Ignores colors. * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ #ifdef HAVE_SYSLOG_H #define LOG_LINE_LEN 512 int ntfs_log_handler_syslog(const char *function __attribute__((unused)), const char *file __attribute__((unused)), int line __attribute__((unused)), u32 level, void *data __attribute__((unused)), const char *format, va_list args) { char logbuf[LOG_LINE_LEN]; int ret, olderr = errno; #ifndef DEBUG if ((level & NTFS_LOG_LEVEL_PERROR) && errno == ENOSPC) return 1; #endif ret = vsnprintf(logbuf, LOG_LINE_LEN, format, args); if (ret < 0) { vsyslog(LOG_NOTICE, format, args); ret = 1; goto out; } if ((LOG_LINE_LEN > ret + 3) && (level & NTFS_LOG_LEVEL_PERROR)) { strncat(logbuf, ": ", LOG_LINE_LEN - ret - 1); strncat(logbuf, strerror(olderr), LOG_LINE_LEN - (ret + 3)); ret = strlen(logbuf); } syslog(LOG_NOTICE, "%s", logbuf); out: errno = olderr; return ret; } #endif /* * Early logging before the logs are redirected * * (not quite satisfactory : this appears before the ntfs-g banner, * and with a different pid) */ void ntfs_log_early_error(const char *format, ...) { va_list args; va_start(args, format); #ifdef HAVE_SYSLOG_H openlog("ntfs-3g", LOG_PID, LOG_USER); ntfs_log_handler_syslog(NULL, NULL, 0, NTFS_LOG_LEVEL_ERROR, NULL, format, args); #else vfprintf(stderr,format,args); #endif va_end(args); } /** * ntfs_log_handler_fprintf - Basic logging handler * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * A simple logging handler. This is where the log line is finally displayed. * It is more likely that you will want to set the handler to either * ntfs_log_handler_outerr or ntfs_log_handler_stderr. * * Note: For this handler, @data is a pointer to a FILE output stream. * If @data is NULL, nothing will be displayed. * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ int ntfs_log_handler_fprintf(const char *function, const char *file, int line, u32 level, void *data, const char *format, va_list args) { #ifdef DEBUG int i; #endif int ret = 0; int olderr = errno; FILE *stream; if (!data) /* Interpret data as a FILE stream. */ return 0; /* If it's NULL, we can't do anything. */ stream = (FILE*)data; #ifdef DEBUG if (level == NTFS_LOG_LEVEL_LEAVE) { if (tab) tab--; return 0; } for (i = 0; i < tab; i++) ret += fprintf(stream, " "); #endif if ((ntfs_log.flags & NTFS_LOG_FLAG_ONLYNAME) && (strchr(file, PATH_SEP))) /* Abbreviate the filename */ file = strrchr(file, PATH_SEP) + 1; if (ntfs_log.flags & NTFS_LOG_FLAG_PREFIX) /* Prefix the output */ ret += fprintf(stream, "%s", ntfs_log_get_prefix(level)); if (ntfs_log.flags & NTFS_LOG_FLAG_FILENAME) /* Source filename */ ret += fprintf(stream, "%s ", file); if (ntfs_log.flags & NTFS_LOG_FLAG_LINE) /* Source line number */ ret += fprintf(stream, "(%d) ", line); if ((ntfs_log.flags & NTFS_LOG_FLAG_FUNCTION) || /* Source function */ (level & NTFS_LOG_LEVEL_TRACE) || (level & NTFS_LOG_LEVEL_ENTER)) ret += fprintf(stream, "%s(): ", function); ret += vfprintf(stream, format, args); if (level & NTFS_LOG_LEVEL_PERROR) ret += fprintf(stream, ": %s\n", strerror(olderr)); #ifdef DEBUG if (level == NTFS_LOG_LEVEL_ENTER) tab++; #endif fflush(stream); errno = olderr; return ret; } /** * ntfs_log_handler_null - Null logging handler (no output) * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * This handler produces no output. It provides a way to temporarily disable * logging, without having to change the levels and flags. * * Returns: 0 Message wasn't logged */ int ntfs_log_handler_null(const char *function __attribute__((unused)), const char *file __attribute__((unused)), int line __attribute__((unused)), u32 level __attribute__((unused)), void *data __attribute__((unused)), const char *format __attribute__((unused)), va_list args __attribute__((unused))) { return 0; } /** * ntfs_log_handler_stdout - All logs go to stdout * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * Display a log message to stdout. * * Note: For this handler, @data is a pointer to a FILE output stream. * If @data is NULL, then stdout will be used. * * Note: This function calls ntfs_log_handler_fprintf to do the main work. * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ int ntfs_log_handler_stdout(const char *function, const char *file, int line, u32 level, void *data, const char *format, va_list args) { if (!data) data = stdout; return ntfs_log_handler_fprintf(function, file, line, level, data, format, args); } /** * ntfs_log_handler_outerr - Logs go to stdout/stderr depending on level * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * Display a log message. The output stream will be determined by the log * level. * * Note: For this handler, @data is a pointer to a FILE output stream. * If @data is NULL, the function ntfs_log_get_stream will be called * * Note: This function calls ntfs_log_handler_fprintf to do the main work. * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ int ntfs_log_handler_outerr(const char *function, const char *file, int line, u32 level, void *data, const char *format, va_list args) { if (!data) data = ntfs_log_get_stream(level); return ntfs_log_handler_fprintf(function, file, line, level, data, format, args); } /** * ntfs_log_handler_stderr - All logs go to stderr * @function: Function in which the log line occurred * @file: File in which the log line occurred * @line: Line number on which the log line occurred * @level: Level at which the line is logged * @data: User specified data, possibly specific to a handler * @format: printf-style formatting string * @args: Arguments to be formatted * * Display a log message to stderr. * * Note: For this handler, @data is a pointer to a FILE output stream. * If @data is NULL, then stdout will be used. * * Note: This function calls ntfs_log_handler_fprintf to do the main work. * * Returns: -1 Error occurred * 0 Message wasn't logged * num Number of output characters */ int ntfs_log_handler_stderr(const char *function, const char *file, int line, u32 level, void *data, const char *format, va_list args) { if (!data) data = stderr; return ntfs_log_handler_fprintf(function, file, line, level, data, format, args); } /** * ntfs_log_parse_option - Act upon command line options * @option: Option flag * * Delegate some of the work of parsing the command line. All the options begin * with "--log-". Options cause log levels to be enabled in @ntfs_log (the * global logging structure). * * Note: The "colour" option changes the logging handler. * * Returns: TRUE Option understood * FALSE Invalid log option */ BOOL ntfs_log_parse_option(const char *option) { if (strcmp(option, "--log-debug") == 0) { ntfs_log_set_levels(NTFS_LOG_LEVEL_DEBUG); return TRUE; } else if (strcmp(option, "--log-verbose") == 0) { ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); return TRUE; } else if (strcmp(option, "--log-quiet") == 0) { ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); return TRUE; } else if (strcmp(option, "--log-trace") == 0) { ntfs_log_set_levels(NTFS_LOG_LEVEL_TRACE); return TRUE; } ntfs_log_debug("Unknown logging option '%s'\n", option); return FALSE; } ntfsprogs-plus-1.0.0/libntfs/mft.c000066400000000000000000002007731507404161300171230ustar00rootroot00000000000000/** * mft.c - Mft record handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2004-2008 Szabolcs Szakacsits * Copyright (c) 2005 Yura Pakhuchiy * Copyright (c) 2014-2021 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #include #include "compat.h" #include "types.h" #include "device.h" #include "debug.h" #include "bitmap.h" #include "attrib.h" #include "inode.h" #include "volume.h" #include "layout.h" #include "lcnalloc.h" #include "mft.h" #include "logging.h" #include "misc.h" #include "lib_utils.h" #include "problem.h" /** * ntfs_mft_records_read - read records from the mft from disk * @vol: volume to read from * @mref: starting mft record number to read * @count: number of mft records to read * @b: output data buffer * * Read @count mft records starting at @mref from volume @vol into buffer * @b. Return 0 on success or -1 on error, with errno set to the error * code. * * If any of the records exceed the initialized size of the $MFT/$DATA * attribute, i.e. they cannot possibly be allocated mft records, assume this * is a bug and return error code ESPIPE. * * The read mft records are mst deprotected and are hence ready to use. The * caller should check each record with is_baad_record() in case mst * deprotection failed. * * NOTE: @b has to be at least of size @count * vol->mft_record_size. */ int ntfs_mft_records_read(const ntfs_volume *vol, const MFT_REF mref, const s64 count, MFT_RECORD *b) { s64 br; VCN m; ntfs_log_trace("inode %llu\n", (unsigned long long)MREF(mref)); if (!vol || !vol->mft_na || !b || count < 0) { errno = EINVAL; ntfs_log_perror("%s: b=%p count=%lld mft=%llu", __FUNCTION__, b, (long long)count, (unsigned long long)MREF(mref)); return -1; } m = MREF(mref); /* Refuse to read non-allocated mft records. */ if (m + count > vol->mft_na->initialized_size >> vol->mft_record_size_bits) { errno = ESPIPE; ntfs_log_perror("Trying to read non-allocated mft records " "(%lld > %lld)", (long long)m + count, (long long)vol->mft_na->initialized_size >> vol->mft_record_size_bits); return -1; } br = ntfs_attr_mst_pread(vol->mft_na, m << vol->mft_record_size_bits, count, vol->mft_record_size, b); if (br != count) { if (br != -1) errno = EIO; ntfs_log_perror("Failed to read of MFT, mft=%llu count=%lld " "br=%lld", (long long)m, (long long)count, (long long)br); return -1; } return 0; } /** * ntfs_mft_records_write - write mft records to disk * @vol: volume to write to * @mref: starting mft record number to write * @count: number of mft records to write * @b: data buffer containing the mft records to write * * Write @count mft records starting at @mref from data buffer @b to volume * @vol. Return 0 on success or -1 on error, with errno set to the error code. * * If any of the records exceed the initialized size of the $MFT/$DATA * attribute, i.e. they cannot possibly be allocated mft records, assume this * is a bug and return error code ESPIPE. * * Before the mft records are written, they are mst protected. After the write, * they are deprotected again, thus resulting in an increase in the update * sequence number inside the data buffer @b. * * If any mft records are written which are also represented in the mft mirror * $MFTMirr, we make a copy of the relevant parts of the data buffer @b into a * temporary buffer before we do the actual write. Then if at least one mft * record was successfully written, we write the appropriate mft records from * the copied buffer to the mft mirror, too. */ int ntfs_mft_records_write(const ntfs_volume *vol, const MFT_REF mref, const s64 count, MFT_RECORD *b) { s64 bw; VCN m; void *bmirr = NULL; int cnt = 0, res = 0; if (!vol || !vol->mft_na || vol->mftmirr_size <= 0 || !b || count < 0) { errno = EINVAL; return -1; } m = MREF(mref); /* Refuse to write non-allocated mft records. */ if (m + count > vol->mft_na->initialized_size >> vol->mft_record_size_bits) { errno = ESPIPE; ntfs_log_perror("Trying to write non-allocated mft records " "(%lld > %lld)", (long long)m + count, (long long)vol->mft_na->initialized_size >> vol->mft_record_size_bits); return -1; } if (m < vol->mftmirr_size) { if (!vol->mftmirr_na) { errno = EINVAL; return -1; } cnt = vol->mftmirr_size - m; if (cnt > count) cnt = count; if ((m + cnt) > vol->mftmirr_na->initialized_size >> vol->mft_record_size_bits) { errno = ESPIPE; ntfs_log_perror("Trying to write non-allocated mftmirr" " records (%lld > %lld)", (long long)m + cnt, (long long)vol->mftmirr_na->initialized_size >> vol->mft_record_size_bits); return -1; } bmirr = ntfs_malloc(cnt * vol->mft_record_size); if (!bmirr) return -1; memcpy(bmirr, b, cnt * vol->mft_record_size); } bw = ntfs_attr_mst_pwrite(vol->mft_na, m << vol->mft_record_size_bits, count, vol->mft_record_size, b); if (bw != count) { if (bw != -1) errno = EIO; if (bw >= 0) ntfs_log_debug("Error: partial write while writing $Mft " "record(s)!\n"); else ntfs_log_perror("Error writing $Mft record(s)"); res = errno; } if (bmirr && bw > 0) { if (bw < cnt) cnt = bw; bw = ntfs_attr_mst_pwrite(vol->mftmirr_na, m << vol->mft_record_size_bits, cnt, vol->mft_record_size, bmirr); if (bw != cnt) { if (bw != -1) errno = EIO; ntfs_log_debug("Error: failed to sync $MFTMirr! Run " "chkdsk.\n"); res = errno; } } free(bmirr); if (!res) return res; errno = res; return -1; } /* * Check the consistency of an MFT record * * Make sure its general fields are safe, then examine all its * attributes and apply generic checks to them. * The attribute checks are skipped when a record is being read in * order to collect its sequence number for creating a new record. * * Returns 0 if the checks are successful * -1 with errno = EIO otherwise */ int ntfs_mft_record_check(ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *m) { ATTR_RECORD *a; int ret = -1; u32 offset; /* attribute start offset */ u32 min_offset; /* minimum attribute start offset */ u32 biu; /* bytes_in_use */ s32 space; BOOL fixed = FALSE; BOOL is_fsck = NVolFsck(vol); problem_context_t pctx = {0, }; if (is_fsck && mref <= FILE_MFTMirr) NVolClearFsck(vol); pctx.m = m; pctx.inum = MREF(mref); /* check magic number of mft */ if (!ntfs_is_file_record(m->magic)) { if (NVolFsck(vol) && m->magic != magic_BAAD) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_MFT_MAGIC_CORRUPTED, &pctx)) { m->magic = magic_FILE; fixed = TRUE; fsck_err_fixed(); } else goto err_out; } else if (!NVolNoFixupWarn(vol)) { ntfs_log_error("Record %llu has no FILE magic (0x%x)\n", (unsigned long long)MREF(mref), (int)le32_to_cpu(*(le32*)m)); goto err_out; } } /* check allocated size */ if (le32_to_cpu(m->bytes_allocated) != vol->mft_record_size) { if (NVolFsck(vol)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_MFT_SIZE_CORRUPTED, &pctx)) { m->bytes_allocated = cpu_to_le32(vol->mft_record_size); fixed = TRUE; fsck_err_fixed(); } else goto err_out; } else { ntfs_log_error("Record %llu has corrupt allocation size " "(%u <> %u)\n", (unsigned long long)MREF(mref), vol->mft_record_size, le32_to_cpu(m->bytes_allocated)); goto err_out; } } /* check bytes_in_use is aligned */ biu = le32_to_cpu(m->bytes_in_use); if (biu & 7) { ntfs_log_error("Used size of MFT record is badly aligned " "in record %llu", (unsigned long long)MREF(mref)); goto err_out; } /* check used size overflow */ if (!NVolNoFixupWarn(vol) && !NVolFsck(vol) && (biu > vol->mft_record_size)) { ntfs_log_error("Record %llu has corrupt in-use size " "(%u > %u)\n", (unsigned long long)MREF(mref), (int)biu, (int)vol->mft_record_size); goto err_out; } offset = le16_to_cpu(m->attrs_offset); min_offset = ((le16_to_cpu(m->usa_ofs) + le16_to_cpu(m->usa_count) * 2) + 7) & ~7; /* check alignment of attribute start offset */ if (offset & 7) { if (NVolFsck(vol)) { fsck_err_found(); ntfs_print_problem(vol, PR_MFT_ATTR_OFFSET_CORRUPTED, &pctx); } else ntfs_log_error("Attributes badly aligned in record %llu", (unsigned long long)MREF(mref)); if (ntfs_ask_repair(vol)) { offset = (offset + 7) & ~7; m->attrs_offset = cpu_to_le16(offset); fixed = TRUE; fsck_err_fixed(); } else goto err_out; } if (offset < min_offset) { ntfs_log_error("MFT record(%llu)'s attribute start offset " "is corrupted\n", (unsigned long long)MREF(mref)); goto err_out; } /* check attribute start offset overflow */ a = (ATTR_RECORD *)((char *)m + offset); if (p2n(a) < p2n(m) || (char *)a > (char *)m + vol->mft_record_size) { ntfs_log_error("Record %llu is corrupt\n", (unsigned long long)MREF(mref)); goto err_out; } if (!NVolNoFixupWarn(vol)) { space = vol->mft_record_size - offset; a = (ATTR_RECORD*)((char*)m + offset); /* check all attributes inconsistency */ while ((space >= (s32)offsetof(ATTR_RECORD, resident_end)) && (a->type != AT_END)) { if (ntfs_is_valid_attr_type(a) == FALSE) { offset += sizeof(ATTR_TYPES); a = (ATTR_RECORD *)((char *)m + offset); space -= sizeof(ATTR_TYPES); continue; } if ((le32_to_cpu(a->length) <= (u32)space) && !(le32_to_cpu(a->length) & 7)) { if (!ntfs_attr_inconsistent(vol, a, mref, &fixed)) { offset += le32_to_cpu(a->length); space -= le32_to_cpu(a->length); a = (ATTR_RECORD*)((char*)m + offset); } else goto err_out; } else { ntfs_log_error("Corrupted MFT record %llu\n", (unsigned long long)MREF(mref)); goto err_out; } } /* * We are supposed to reach an AT_END. Check bytes_in_use value. * +8 mean the attribute terminator. */ if ((a->type == AT_END) && (biu != offset + 8)) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_MFT_BIU_CORRUPTED, &pctx)) { m->bytes_in_use = cpu_to_le32(offset + 8); fixed = TRUE; fsck_err_fixed(); } } } ret = 0; err_out: if (is_fsck && mref <= FILE_MFTMirr) NVolSetFsck(vol); if (fixed) { if (ntfs_mft_record_write(vol, mref, m)) ret = -1; } if (ret) errno = EIO; return ret; } /** * ntfs_file_record_read - read a FILE record from the mft from disk * @vol: volume to read from * @mref: mft reference specifying mft record to read * @mrec: address of pointer in which to return the mft record * @attr: address of pointer in which to return the first attribute * * Read a FILE record from the mft of @vol from the storage medium. @mref * specifies the mft record to read, including the sequence number, which can * be 0 if no sequence number checking is to be performed. * * The function allocates a buffer large enough to hold the mft record and * reads the record into the buffer (mst deprotecting it in the process). * *@mrec is then set to point to the buffer. * * If @attr is not NULL, *@attr is set to point to the first attribute in the * mft record, i.e. *@attr is a pointer into *@mrec. * * Return 0 on success, or -1 on error, with errno set to the error code. * * The read mft record is checked for having the magic FILE, * and for having a matching sequence number (if MSEQNO(*@mref) != 0). * If either of these fails, -1 is returned and errno is set to EIO. If you get * this, but you still want to read the mft record (e.g. in order to correct * it), use ntfs_mft_record_read() directly. * * Note: Caller has to free *@mrec when finished. * * Note: We do not check if the mft record is flagged in use. The caller can * check if desired. */ int ntfs_file_record_read(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD **mrec, ATTR_RECORD **attr) { MFT_RECORD *m; if (!vol || !mrec) { errno = EINVAL; ntfs_log_perror("%s: mrec=%p", __FUNCTION__, mrec); return -1; } m = *mrec; if (!m) { m = ntfs_malloc(vol->mft_record_size); if (!m) return -1; } if (ntfs_mft_record_read(vol, mref, m)) goto err_out; /* should check first before calling ntfs_mft_record_check(), * whether sequence numbers are matched */ if (MSEQNO(mref) && MSEQNO(mref) != le16_to_cpu(m->sequence_number)) { ntfs_log_error("Record %llu has wrong SeqNo (%d <> %d)\n", (unsigned long long)MREF(mref), MSEQNO(mref), le16_to_cpu(m->sequence_number)); errno = EIO; goto err_out; } if (ntfs_mft_record_check(vol, mref, m)) goto err_out; *mrec = m; if (attr) *attr = (ATTR_RECORD*)((char*)m + le16_to_cpu(m->attrs_offset)); return 0; err_out: if (m != *mrec) free(m); return -1; } /** * ntfs_mft_record_layout - layout an mft record into a memory buffer * @vol: volume to which the mft record will belong * @mref: mft reference specifying the mft record number * @mrec: destination buffer of size >= @vol->mft_record_size bytes * * Layout an empty, unused mft record with the mft reference @mref into the * buffer @m. The volume @vol is needed because the mft record structure was * modified in NTFS 3.1 so we need to know which volume version this mft record * will be used on. * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_mft_record_layout(const ntfs_volume *vol, const MFT_REF mref, MFT_RECORD *mrec) { ATTR_RECORD *a; if (!vol || !mrec) { errno = EINVAL; ntfs_log_perror("%s: mrec=%p", __FUNCTION__, mrec); return -1; } /* Aligned to 2-byte boundary. */ if (vol->major_ver < 3 || (vol->major_ver == 3 && !vol->minor_ver)) mrec->usa_ofs = cpu_to_le16((sizeof(MFT_RECORD_OLD) + 1) & ~1); else { /* Abort if mref is > 32 bits. */ if (MREF(mref) & 0x0000ffff00000000ull) { errno = ERANGE; ntfs_log_perror("Mft reference exceeds 32 bits"); return -1; } mrec->usa_ofs = cpu_to_le16((sizeof(MFT_RECORD) + 1) & ~1); /* * Set the NTFS 3.1+ specific fields while we know that the * volume version is 3.1+. */ mrec->reserved = const_cpu_to_le16(0); mrec->mft_record_number = cpu_to_le32(MREF(mref)); } mrec->magic = magic_FILE; if (vol->mft_record_size >= NTFS_BLOCK_SIZE) mrec->usa_count = cpu_to_le16(vol->mft_record_size / NTFS_BLOCK_SIZE + 1); else { mrec->usa_count = const_cpu_to_le16(1); ntfs_log_error("Sector size is bigger than MFT record size. " "Setting usa_count to 1. If Windows chkdsk " "reports this as corruption, please email %s " "stating that you saw this message and that " "the file system created was corrupt. " "Thank you.\n", NTFS_DEV_LIST); } /* Set the update sequence number to 1. */ *(le16*)((u8*)mrec + le16_to_cpu(mrec->usa_ofs)) = const_cpu_to_le16(1); mrec->lsn = const_cpu_to_sle64(0ll); mrec->sequence_number = const_cpu_to_le16(1); mrec->link_count = const_cpu_to_le16(0); /* Aligned to 8-byte boundary. */ mrec->attrs_offset = cpu_to_le16((le16_to_cpu(mrec->usa_ofs) + (le16_to_cpu(mrec->usa_count) << 1) + 7) & ~7); mrec->flags = const_cpu_to_le16(0); /* * Using attrs_offset plus eight bytes (for the termination attribute), * aligned to 8-byte boundary. */ mrec->bytes_in_use = cpu_to_le32((le16_to_cpu(mrec->attrs_offset) + 8 + 7) & ~7); mrec->bytes_allocated = cpu_to_le32(vol->mft_record_size); mrec->base_mft_record = const_cpu_to_le64((MFT_REF)0); mrec->next_attr_instance = const_cpu_to_le16(0); a = (ATTR_RECORD*)((u8*)mrec + le16_to_cpu(mrec->attrs_offset)); a->type = AT_END; a->length = const_cpu_to_le32(0); /* Finally, clear the unused part of the mft record. */ memset((u8*)a + 8, 0, vol->mft_record_size - ((u8*)a + 8 - (u8*)mrec)); return 0; } /** * ntfs_mft_record_format - format an mft record on an ntfs volume * @vol: volume on which to format the mft record * @mref: mft reference specifying mft record to format * * Format the mft record with the mft reference @mref in $MFT/$DATA, i.e. lay * out an empty, unused mft record in memory and write it to the volume @vol. * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_mft_record_format(const ntfs_volume *vol, const MFT_REF mref) { MFT_RECORD *m; int ret = -1; ntfs_log_enter("Entering\n"); m = ntfs_calloc(vol->mft_record_size); if (!m) goto out; if (ntfs_mft_record_layout(vol, mref, m)) goto free_m; if (ntfs_mft_record_write(vol, mref, m)) goto free_m; ret = 0; free_m: free(m); out: ntfs_log_leave("\n"); return ret; } static const char *es = " Leaving inconsistent metadata. Run chkdsk."; /** * ntfs_ffz - Find the first unset (zero) bit in a word * @word: * * Description... * * Returns: */ static inline unsigned int ntfs_ffz(unsigned int word) { return ffs(~word) - 1; } static int ntfs_is_mft(ntfs_inode *ni) { if (ni && ni->mft_no == FILE_MFT) return 1; return 0; } #define RESERVED_MFT_RECORDS 64 /** * ntfs_mft_bitmap_find_free_rec - find a free mft record in the mft bitmap * @vol: volume on which to search for a free mft record * @base_ni: open base inode if allocating an extent mft record or NULL * * Search for a free mft record in the mft bitmap attribute on the ntfs volume * @vol. * * If @base_ni is NULL start the search at the default allocator position. * * If @base_ni is not NULL start the search at the mft record after the base * mft record @base_ni. * * Return the free mft record on success and -1 on error with errno set to the * error code. An error code of ENOSPC means that there are no free mft * records in the currently initialized mft bitmap. */ static int ntfs_mft_bitmap_find_free_rec(ntfs_volume *vol, ntfs_inode *base_ni) { s64 pass_end, ll, data_pos, pass_start, ofs, bit; ntfs_attr *mftbmp_na; u8 *buf, *byte = NULL; unsigned int size; u8 pass, b = 0; int ret = -1; ntfs_log_enter("Entering\n"); mftbmp_na = vol->mftbmp_na; /* * Set the end of the pass making sure we do not overflow the mft * bitmap. */ size = MFTBMP_ALLOC_SIZE; pass_end = vol->mft_na->allocated_size >> vol->mft_record_size_bits; ll = mftbmp_na->initialized_size << 3; if (pass_end > ll) pass_end = ll; pass = 1; if (!base_ni) data_pos = vol->mft_data_pos; else data_pos = base_ni->mft_no + 1; if (data_pos < RESERVED_MFT_RECORDS) data_pos = RESERVED_MFT_RECORDS; if (data_pos >= pass_end) { data_pos = RESERVED_MFT_RECORDS; pass = 2; /* This happens on a freshly formatted volume. */ if (data_pos >= pass_end) { errno = ENOSPC; goto leave; } } if (ntfs_is_mft(base_ni)) { data_pos = 0; pass = 2; } pass_start = data_pos; buf = ntfs_malloc(MFTBMP_ALLOC_SIZE); if (!buf) goto leave; ntfs_log_debug("Starting bitmap search: pass %u, pass_start 0x%llx, " "pass_end 0x%llx, data_pos 0x%llx.\n", pass, (long long)pass_start, (long long)pass_end, (long long)data_pos); /* Loop until a free mft record is found. */ for (; pass <= 2; size = MFTBMP_ALLOC_SIZE) { /* Cap size to pass_end. */ ofs = data_pos >> 3; ll = ((pass_end + 7) >> 3) - ofs; if (size > ll) size = ll; ll = ntfs_attr_pread(mftbmp_na, ofs, size, buf); if (ll < 0) { ntfs_log_perror("Failed to read $MFT bitmap"); free(buf); goto leave; } ntfs_log_debug("Read 0x%llx bytes.\n", (long long)ll); /* If we read at least one byte, search @buf for a zero bit. */ if (ll) { size = ll << 3; bit = data_pos & 7; data_pos &= ~7ull; ntfs_log_debug("Before inner for loop: size 0x%x, " "data_pos 0x%llx, bit 0x%llx, " "*byte 0x%hhx, b %u.\n", size, (long long)data_pos, (long long)bit, (u8) (byte ? *byte : -1), b); for (; bit < size && data_pos + bit < pass_end; bit &= ~7ull, bit += 8) { /* * If we're extending $MFT and running out of the first * mft record (base record) then give up searching since * no guarantee that the found record will be accessible. */ if (ntfs_is_mft(base_ni) && bit > 400) goto out; byte = buf + (bit >> 3); if (*byte == 0xff) continue; /* Note: ffz() result must be zero based. */ b = ntfs_ffz((unsigned long)*byte); if (b < 8 && b >= (bit & 7)) { free(buf); ret = data_pos + (bit & ~7ull) + b; goto leave; } } ntfs_log_debug("After inner for loop: size 0x%x, " "data_pos 0x%llx, bit 0x%llx, " "*byte 0x%hhx, b %u.\n", size, (long long)data_pos, (long long)bit, (u8) (byte ? *byte : -1), b); data_pos += size; /* * If the end of the pass has not been reached yet, * continue searching the mft bitmap for a zero bit. */ if (data_pos < pass_end) continue; } /* Do the next pass. */ pass++; if (pass == 2) { /* * Starting the second pass, in which we scan the first * part of the zone which we omitted earlier. */ pass_end = pass_start; data_pos = pass_start = RESERVED_MFT_RECORDS; ntfs_log_debug("pass %i, pass_start 0x%llx, pass_end " "0x%llx.\n", pass, (long long)pass_start, (long long)pass_end); if (data_pos >= pass_end) break; } } /* No free mft records in currently initialized mft bitmap. */ out: free(buf); errno = ENOSPC; leave: ntfs_log_leave("\n"); return ret; } static int ntfs_mft_attr_extend(ntfs_attr *na) { int ret = STATUS_ERROR; ntfs_log_enter("Entering\n"); if (!NInoAttrList(na->ni)) { if (ntfs_inode_add_attrlist(na->ni)) { ntfs_log_perror("%s: Can not add attrlist #3", __FUNCTION__); goto out; } /* We can't sync the $MFT inode since its runlist is bogus. */ ret = STATUS_KEEP_SEARCHING; goto out; } if (ntfs_attr_update_mapping_pairs(na, 0)) { ntfs_log_perror("%s: MP update failed", __FUNCTION__); goto out; } ret = STATUS_OK; out: ntfs_log_leave("\n"); return ret; } /** * ntfs_mft_bitmap_extend_allocation_i - see ntfs_mft_bitmap_extend_allocation */ static int ntfs_mft_bitmap_extend_allocation_i(ntfs_volume *vol) { LCN lcn; s64 ll = 0; /* silence compiler warning */ ntfs_attr *mftbmp_na; runlist_element *rl, *rl2 = NULL; /* silence compiler warning */ ntfs_attr_search_ctx *ctx; MFT_RECORD *m = NULL; /* silence compiler warning */ ATTR_RECORD *a = NULL; /* silence compiler warning */ int err, mp_size; int ret = STATUS_ERROR; u32 old_alen = 0; /* silence compiler warning */ BOOL mp_rebuilt = FALSE; BOOL update_mp = FALSE; mftbmp_na = vol->mftbmp_na; /* * Determine the last lcn of the mft bitmap. The allocated size of the * mft bitmap cannot be zero so we are ok to do this. */ rl = ntfs_attr_find_vcn(mftbmp_na, (mftbmp_na->allocated_size - 1) >> vol->cluster_size_bits); if (!rl || !rl->length || rl->lcn < 0) { ntfs_log_error("Failed to determine last allocated " "cluster of mft bitmap attribute.\n"); if (rl) errno = EIO; return STATUS_ERROR; } lcn = rl->lcn + rl->length; rl2 = ntfs_cluster_alloc(vol, rl[1].vcn, 1, lcn, DATA_ZONE); if (!rl2) { ntfs_log_error("Failed to allocate a cluster for " "the mft bitmap.\n"); return STATUS_ERROR; } rl = ntfs_runlists_merge(mftbmp_na->rl, rl2); if (!rl) { err = errno; ntfs_log_error("Failed to merge runlists for mft " "bitmap.\n"); if (ntfs_cluster_free_from_rl(vol, rl2)) ntfs_log_error("Failed to deallocate " "cluster.%s\n", es); free(rl2); errno = err; return STATUS_ERROR; } mftbmp_na->rl = rl; ntfs_log_debug("Adding one run to mft bitmap.\n"); /* Find the last run in the new runlist. */ for (; rl[1].length; rl++) ; /* * Update the attribute record as well. Note: @rl is the last * (non-terminator) runlist element of mft bitmap. */ ctx = ntfs_attr_get_search_ctx(mftbmp_na->ni, NULL); if (!ctx) goto undo_alloc; if (ntfs_attr_lookup(mftbmp_na->type, mftbmp_na->name, mftbmp_na->name_len, 0, rl[1].vcn, NULL, 0, ctx)) { ntfs_log_error("Failed to find last attribute extent of " "mft bitmap attribute.\n"); goto undo_alloc; } m = ctx->mrec; a = ctx->attr; ll = sle64_to_cpu(a->lowest_vcn); rl2 = ntfs_attr_find_vcn(mftbmp_na, ll); if (!rl2 || !rl2->length) { ntfs_log_error("Failed to determine previous last " "allocated cluster of mft bitmap attribute.\n"); if (rl2) errno = EIO; goto undo_alloc; } /* Get the size for the new mapping pairs array for this extent. */ mp_size = ntfs_get_size_for_mapping_pairs(vol, rl2, ll, INT_MAX); if (mp_size <= 0) { ntfs_log_error("Get size for mapping pairs failed for " "mft bitmap attribute extent.\n"); goto undo_alloc; } /* Expand the attribute record if necessary. */ old_alen = le32_to_cpu(a->length); if (ntfs_attr_record_resize(m, a, mp_size + le16_to_cpu(a->mapping_pairs_offset))) { ntfs_log_info("extending $MFT bitmap\n"); ret = ntfs_mft_attr_extend(vol->mftbmp_na); if (ret == STATUS_OK) goto ok; if (ret == STATUS_ERROR) { ntfs_log_perror("%s: ntfs_mft_attr_extend failed", __FUNCTION__); update_mp = TRUE; } goto undo_alloc; } mp_rebuilt = TRUE; /* Generate the mapping pairs array directly into the attr record. */ if (ntfs_mapping_pairs_build(vol, (u8*)a + le16_to_cpu(a->mapping_pairs_offset), mp_size, rl2, ll, NULL)) { ntfs_log_error("Failed to build mapping pairs array for " "mft bitmap attribute.\n"); errno = EIO; goto undo_alloc; } /* Update the highest_vcn. */ a->highest_vcn = cpu_to_sle64(rl[1].vcn - 1); /* * We now have extended the mft bitmap allocated_size by one cluster. * Reflect this in the ntfs_attr structure and the attribute record. */ if (a->lowest_vcn) { /* * We are not in the first attribute extent, switch to it, but * first ensure the changes will make it to disk later. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(mftbmp_na->type, mftbmp_na->name, mftbmp_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute " "extent of mft bitmap attribute.\n"); goto restore_undo_alloc; } a = ctx->attr; } ok: mftbmp_na->allocated_size += vol->cluster_size; a->allocated_size = cpu_to_sle64(mftbmp_na->allocated_size); /* Ensure the changes make it to disk. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); return STATUS_OK; restore_undo_alloc: err = errno; ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(mftbmp_na->type, mftbmp_na->name, mftbmp_na->name_len, 0, rl[1].vcn, NULL, 0, ctx)) { ntfs_log_error("Failed to find last attribute extent of " "mft bitmap attribute.%s\n", es); ntfs_attr_put_search_ctx(ctx); mftbmp_na->allocated_size += vol->cluster_size; /* * The only thing that is now wrong is ->allocated_size of the * base attribute extent which chkdsk should be able to fix. */ errno = err; return STATUS_ERROR; } m = ctx->mrec; a = ctx->attr; a->highest_vcn = cpu_to_sle64(rl[1].vcn - 2); errno = err; undo_alloc: err = errno; /* Remove the last run from the runlist. */ lcn = rl->lcn; rl->lcn = rl[1].lcn; rl->length = 0; /* FIXME: use an ntfs_cluster_free_* function */ if (ntfs_bitmap_clear_bit(vol->lcnbmp_na, lcn)) ntfs_log_error("Failed to free cluster.%s\n", es); else vol->free_clusters++; if (mp_rebuilt) { if (ntfs_mapping_pairs_build(vol, (u8*)a + le16_to_cpu(a->mapping_pairs_offset), old_alen - le16_to_cpu(a->mapping_pairs_offset), rl2, ll, NULL)) ntfs_log_error("Failed to restore mapping " "pairs array.%s\n", es); if (ntfs_attr_record_resize(m, a, old_alen)) ntfs_log_error("Failed to restore attribute " "record.%s\n", es); ntfs_inode_mark_dirty(ctx->ntfs_ino); } if (update_mp) { if (ntfs_attr_update_mapping_pairs(vol->mftbmp_na, 0)) ntfs_log_perror("%s: MP update failed", __FUNCTION__); } if (ctx) ntfs_attr_put_search_ctx(ctx); errno = err; return ret; } /** * ntfs_mft_bitmap_extend_allocation - extend mft bitmap attribute by a cluster * @vol: volume on which to extend the mft bitmap attribute * * Extend the mft bitmap attribute on the ntfs volume @vol by one cluster. * * Note: Only changes allocated_size, i.e. does not touch initialized_size or * data_size. * * Return 0 on success and -1 on error with errno set to the error code. */ static int ntfs_mft_bitmap_extend_allocation(ntfs_volume *vol) { int ret; ntfs_log_enter("Entering\n"); ret = ntfs_mft_bitmap_extend_allocation_i(vol); ntfs_log_leave("\n"); return ret; } /** * ntfs_mft_bitmap_extend_initialized - extend mft bitmap initialized data * @vol: volume on which to extend the mft bitmap attribute * * Extend the initialized portion of the mft bitmap attribute on the ntfs * volume @vol by 8 bytes. * * Note: Only changes initialized_size and data_size, i.e. requires that * allocated_size is big enough to fit the new initialized_size. * * Return 0 on success and -1 on error with errno set to the error code. */ static int ntfs_mft_bitmap_extend_initialized(ntfs_volume *vol) { s64 old_data_size, old_initialized_size, ll; ntfs_attr *mftbmp_na; ntfs_attr_search_ctx *ctx; ATTR_RECORD *a; int err; int ret = -1; ntfs_log_enter("Entering\n"); mftbmp_na = vol->mftbmp_na; ctx = ntfs_attr_get_search_ctx(mftbmp_na->ni, NULL); if (!ctx) goto out; if (ntfs_attr_lookup(mftbmp_na->type, mftbmp_na->name, mftbmp_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute extent of " "mft bitmap attribute.\n"); err = errno; goto put_err_out; } a = ctx->attr; old_data_size = mftbmp_na->data_size; old_initialized_size = mftbmp_na->initialized_size; mftbmp_na->initialized_size += 8; a->initialized_size = cpu_to_sle64(mftbmp_na->initialized_size); if (mftbmp_na->initialized_size > mftbmp_na->data_size) { mftbmp_na->data_size = mftbmp_na->initialized_size; a->data_size = cpu_to_sle64(mftbmp_na->data_size); } /* Ensure the changes make it to disk. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); /* Initialize the mft bitmap attribute value with zeroes. */ ll = 0; ll = ntfs_attr_pwrite(mftbmp_na, old_initialized_size, 8, &ll); if (ll == 8) { ntfs_log_debug("Wrote eight initialized bytes to mft bitmap.\n"); vol->free_mft_records += (8 * 8); ret = 0; goto out; } ntfs_log_error("Failed to write to mft bitmap.\n"); err = errno; if (ll >= 0) err = EIO; /* Try to recover from the error. */ ctx = ntfs_attr_get_search_ctx(mftbmp_na->ni, NULL); if (!ctx) goto err_out; if (ntfs_attr_lookup(mftbmp_na->type, mftbmp_na->name, mftbmp_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute extent of " "mft bitmap attribute.%s\n", es); put_err_out: ntfs_attr_put_search_ctx(ctx); goto err_out; } a = ctx->attr; mftbmp_na->initialized_size = old_initialized_size; a->initialized_size = cpu_to_sle64(old_initialized_size); if (mftbmp_na->data_size != old_data_size) { mftbmp_na->data_size = old_data_size; a->data_size = cpu_to_sle64(old_data_size); } ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); ntfs_log_debug("Restored status of mftbmp: allocated_size 0x%llx, " "data_size 0x%llx, initialized_size 0x%llx.\n", (long long)mftbmp_na->allocated_size, (long long)mftbmp_na->data_size, (long long)mftbmp_na->initialized_size); err_out: errno = err; out: ntfs_log_leave("\n"); return ret; } /** * ntfs_mft_data_extend_allocation - extend mft data attribute * @vol: volume on which to extend the mft data attribute * * Extend the mft data attribute on the ntfs volume @vol by 16 mft records * worth of clusters or if not enough space for this by one mft record worth * of clusters. * * Note: Only changes allocated_size, i.e. does not touch initialized_size or * data_size. * * Return 0 on success and -1 on error with errno set to the error code. */ static int ntfs_mft_data_extend_allocation(ntfs_volume *vol) { LCN lcn; VCN old_last_vcn; s64 min_nr, nr, ll = 0; /* silence compiler warning */ ntfs_attr *mft_na; runlist_element *rl, *rl2; ntfs_attr_search_ctx *ctx; MFT_RECORD *m = NULL; /* silence compiler warning */ ATTR_RECORD *a = NULL; /* silence compiler warning */ int err, mp_size; int ret = STATUS_ERROR; u32 old_alen = 0; /* silence compiler warning */ BOOL mp_rebuilt = FALSE; BOOL update_mp = FALSE; ntfs_log_enter("Extending mft data allocation.\n"); mft_na = vol->mft_na; /* * Determine the preferred allocation location, i.e. the last lcn of * the mft data attribute. The allocated size of the mft data * attribute cannot be zero so we are ok to do this. */ rl = ntfs_attr_find_vcn(mft_na, (mft_na->allocated_size - 1) >> vol->cluster_size_bits); if (!rl || !rl->length || rl->lcn < 0) { ntfs_log_error("Failed to determine last allocated " "cluster of mft data attribute.\n"); if (rl) errno = EIO; goto out; } lcn = rl->lcn + rl->length; ntfs_log_debug("Last lcn of mft data attribute is 0x%llx.\n", (long long)lcn); /* Minimum allocation is one mft record worth of clusters. */ min_nr = vol->mft_record_size >> vol->cluster_size_bits; if (!min_nr) min_nr = 1; /* Want to allocate 16 mft records worth of clusters. */ nr = vol->mft_record_size << 4 >> vol->cluster_size_bits; if (!nr) nr = min_nr; old_last_vcn = rl[1].vcn; do { rl2 = ntfs_cluster_alloc(vol, old_last_vcn, nr, lcn, MFT_ZONE); if (rl2) break; if (errno != ENOSPC || nr == min_nr) { ntfs_log_perror("Failed to allocate (%lld) clusters " "for $MFT", (long long)nr); goto out; } /* * There is not enough space to do the allocation, but there * might be enough space to do a minimal allocation so try that * before failing. */ nr = min_nr; ntfs_log_debug("Retrying mft data allocation with minimal cluster " "count %lli.\n", (long long)nr); } while (1); ntfs_log_debug("Allocated %lld clusters.\n", (long long)nr); rl = ntfs_runlists_merge(mft_na->rl, rl2); if (!rl) { err = errno; ntfs_log_error("Failed to merge runlists for mft data " "attribute.\n"); if (ntfs_cluster_free_from_rl(vol, rl2)) ntfs_log_error("Failed to deallocate clusters " "from the mft data attribute.%s\n", es); free(rl2); errno = err; goto out; } mft_na->rl = rl; /* Find the last run in the new runlist. */ for (; rl[1].length; rl++) ; /* Update the attribute record as well. */ ctx = ntfs_attr_get_search_ctx(mft_na->ni, NULL); if (!ctx) goto undo_alloc; if (ntfs_attr_lookup(mft_na->type, mft_na->name, mft_na->name_len, 0, rl[1].vcn, NULL, 0, ctx)) { ntfs_log_error("Failed to find last attribute extent of " "mft data attribute.\n"); goto undo_alloc; } m = ctx->mrec; a = ctx->attr; ll = sle64_to_cpu(a->lowest_vcn); rl2 = ntfs_attr_find_vcn(mft_na, ll); if (!rl2 || !rl2->length) { ntfs_log_error("Failed to determine previous last " "allocated cluster of mft data attribute.\n"); if (rl2) errno = EIO; goto undo_alloc; } /* Get the size for the new mapping pairs array for this extent. */ mp_size = ntfs_get_size_for_mapping_pairs(vol, rl2, ll, INT_MAX); if (mp_size <= 0) { ntfs_log_error("Get size for mapping pairs failed for " "mft data attribute extent.\n"); goto undo_alloc; } /* Expand the attribute record if necessary. */ old_alen = le32_to_cpu(a->length); if (ntfs_attr_record_resize(m, a, mp_size + le16_to_cpu(a->mapping_pairs_offset))) { ret = ntfs_mft_attr_extend(vol->mft_na); if (ret == STATUS_OK) goto ok; if (ret == STATUS_ERROR) { ntfs_log_perror("%s: ntfs_mft_attr_extend failed", __FUNCTION__); update_mp = TRUE; } goto undo_alloc; } mp_rebuilt = TRUE; /* * Generate the mapping pairs array directly into the attribute record. */ if (ntfs_mapping_pairs_build(vol, (u8*)a + le16_to_cpu(a->mapping_pairs_offset), mp_size, rl2, ll, NULL)) { ntfs_log_error("Failed to build mapping pairs array of " "mft data attribute.\n"); errno = EIO; goto undo_alloc; } /* Update the highest_vcn. */ a->highest_vcn = cpu_to_sle64(rl[1].vcn - 1); /* * We now have extended the mft data allocated_size by nr clusters. * Reflect this in the ntfs_attr structure and the attribute record. * @rl is the last (non-terminator) runlist element of mft data * attribute. */ if (a->lowest_vcn) { /* * We are not in the first attribute extent, switch to it, but * first ensure the changes will make it to disk later. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(mft_na->type, mft_na->name, mft_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute " "extent of mft data attribute.\n"); goto restore_undo_alloc; } a = ctx->attr; } ok: mft_na->allocated_size += nr << vol->cluster_size_bits; a->allocated_size = cpu_to_sle64(mft_na->allocated_size); /* Ensure the changes make it to disk. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); ret = STATUS_OK; out: ntfs_log_leave("\n"); return ret; restore_undo_alloc: err = errno; ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(mft_na->type, mft_na->name, mft_na->name_len, 0, rl[1].vcn, NULL, 0, ctx)) { ntfs_log_error("Failed to find last attribute extent of " "mft data attribute.%s\n", es); ntfs_attr_put_search_ctx(ctx); mft_na->allocated_size += nr << vol->cluster_size_bits; /* * The only thing that is now wrong is ->allocated_size of the * base attribute extent which chkdsk should be able to fix. */ errno = err; ret = STATUS_ERROR; goto out; } m = ctx->mrec; a = ctx->attr; a->highest_vcn = cpu_to_sle64(old_last_vcn - 1); errno = err; undo_alloc: err = errno; if (ntfs_cluster_free(vol, mft_na, old_last_vcn, -1) < 0) ntfs_log_error("Failed to free clusters from mft data " "attribute.%s\n", es); if (ntfs_rl_truncate(&mft_na->rl, old_last_vcn)) ntfs_log_error("Failed to truncate mft data attribute " "runlist.%s\n", es); if (mp_rebuilt) { if (ntfs_mapping_pairs_build(vol, (u8*)a + le16_to_cpu(a->mapping_pairs_offset), old_alen - le16_to_cpu(a->mapping_pairs_offset), rl2, ll, NULL)) ntfs_log_error("Failed to restore mapping pairs " "array.%s\n", es); if (ntfs_attr_record_resize(m, a, old_alen)) ntfs_log_error("Failed to restore attribute " "record.%s\n", es); ntfs_inode_mark_dirty(ctx->ntfs_ino); } if (update_mp) { if (ntfs_attr_update_mapping_pairs(vol->mft_na, 0)) ntfs_log_perror("%s: MP update failed", __FUNCTION__); } if (ctx) ntfs_attr_put_search_ctx(ctx); errno = err; goto out; } static int ntfs_mft_record_init(ntfs_volume *vol, s64 size) { int ret = -1; ntfs_attr *mft_na; s64 old_data_initialized, old_data_size; ntfs_attr_search_ctx *ctx; ntfs_log_enter("Entering\n"); /* NOTE: Caller must sanity check vol, vol->mft_na and vol->mftbmp_na */ mft_na = vol->mft_na; /* * The mft record is outside the initialized data. Extend the mft data * attribute until it covers the allocated record. The loop is only * actually traversed more than once when a freshly formatted volume * is first written to so it optimizes away nicely in the common case. */ ntfs_log_debug("Status of mft data before extension: " "allocated_size 0x%llx, data_size 0x%llx, " "initialized_size 0x%llx.\n", (long long)mft_na->allocated_size, (long long)mft_na->data_size, (long long)mft_na->initialized_size); while (size > mft_na->allocated_size) { if (ntfs_mft_data_extend_allocation(vol) == STATUS_ERROR) goto out; ntfs_log_debug("Status of mft data after allocation extension: " "allocated_size 0x%llx, data_size 0x%llx, " "initialized_size 0x%llx.\n", (long long)mft_na->allocated_size, (long long)mft_na->data_size, (long long)mft_na->initialized_size); } old_data_initialized = mft_na->initialized_size; old_data_size = mft_na->data_size; /* * Extend mft data initialized size (and data size of course) to reach * the allocated mft record, formatting the mft records along the way. * Note: We only modify the ntfs_attr structure as that is all that is * needed by ntfs_mft_record_format(). We will update the attribute * record itself in one fell swoop later on. */ while (size > mft_na->initialized_size) { s64 ll2 = mft_na->initialized_size >> vol->mft_record_size_bits; mft_na->initialized_size += vol->mft_record_size; if (mft_na->initialized_size > mft_na->data_size) mft_na->data_size = mft_na->initialized_size; ntfs_log_debug("Initializing mft record 0x%llx.\n", (long long)ll2); if (ntfs_mft_record_format(vol, ll2) < 0) { ntfs_log_perror("Failed to format mft record"); goto undo_data_init; } } /* Update the mft data attribute record to reflect the new sizes. */ ctx = ntfs_attr_get_search_ctx(mft_na->ni, NULL); if (!ctx) goto undo_data_init; if (ntfs_attr_lookup(mft_na->type, mft_na->name, mft_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute extent of " "mft data attribute.\n"); ntfs_attr_put_search_ctx(ctx); goto undo_data_init; } ctx->attr->initialized_size = cpu_to_sle64(mft_na->initialized_size); ctx->attr->data_size = cpu_to_sle64(mft_na->data_size); ctx->attr->allocated_size = cpu_to_sle64(mft_na->allocated_size); /* Ensure the changes make it to disk. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); ntfs_log_debug("Status of mft data after mft record initialization: " "allocated_size 0x%llx, data_size 0x%llx, " "initialized_size 0x%llx.\n", (long long)mft_na->allocated_size, (long long)mft_na->data_size, (long long)mft_na->initialized_size); /* Sanity checks. */ if (mft_na->data_size > mft_na->allocated_size || mft_na->initialized_size > mft_na->data_size) NTFS_BUG("mft_na sanity checks failed"); /* Sync MFT to minimize data loss if there won't be clean unmount. */ if (ntfs_inode_sync(mft_na->ni)) goto undo_data_init; ret = 0; out: ntfs_log_leave("\n"); return ret; undo_data_init: mft_na->initialized_size = old_data_initialized; mft_na->data_size = old_data_size; goto out; } static int ntfs_mft_rec_init(ntfs_volume *vol, s64 size) { int ret = -1; ntfs_attr *mft_na; s64 old_data_initialized, old_data_size; ntfs_attr_search_ctx *ctx; ntfs_log_enter("Entering\n"); mft_na = vol->mft_na; if (size > mft_na->allocated_size || size > mft_na->initialized_size) { errno = EIO; ntfs_log_perror("%s: unexpected $MFT sizes, see below", __FUNCTION__); ntfs_log_error("$MFT: size=%lld allocated_size=%lld " "data_size=%lld initialized_size=%lld\n", (long long)size, (long long)mft_na->allocated_size, (long long)mft_na->data_size, (long long)mft_na->initialized_size); goto out; } old_data_initialized = mft_na->initialized_size; old_data_size = mft_na->data_size; /* Update the mft data attribute record to reflect the new sizes. */ ctx = ntfs_attr_get_search_ctx(mft_na->ni, NULL); if (!ctx) goto undo_data_init; if (ntfs_attr_lookup(mft_na->type, mft_na->name, mft_na->name_len, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Failed to find first attribute extent of " "mft data attribute.\n"); ntfs_attr_put_search_ctx(ctx); goto undo_data_init; } ctx->attr->initialized_size = cpu_to_sle64(mft_na->initialized_size); ctx->attr->data_size = cpu_to_sle64(mft_na->data_size); /* CHECKME: ctx->attr->allocation_size is already ok? */ /* Ensure the changes make it to disk. */ ntfs_inode_mark_dirty(ctx->ntfs_ino); ntfs_attr_put_search_ctx(ctx); /* Sanity checks. */ if (mft_na->data_size > mft_na->allocated_size || mft_na->initialized_size > mft_na->data_size) NTFS_BUG("mft_na sanity checks failed"); out: ntfs_log_leave("\n"); return ret; undo_data_init: mft_na->initialized_size = old_data_initialized; mft_na->data_size = old_data_size; goto out; } ntfs_inode *ntfs_mft_rec_alloc(ntfs_volume *vol, BOOL mft_data) { s64 ll, bit; ntfs_attr *mft_na, *mftbmp_na; MFT_RECORD *m; ntfs_inode *ni = NULL; ntfs_inode *base_ni; int err; le16 seq_no, usn; BOOL forced_mft_data; ntfs_log_enter("Entering\n"); mft_na = vol->mft_na; mftbmp_na = vol->mftbmp_na; base_ni = mft_na->ni; /* * The first extent containing $MFT:$AT_DATA is better located * in record 15 to make sure it can be read at mount time. * The record 15 is prereserved as a base inode with no * extents and no name, and it is marked in use. */ forced_mft_data = FALSE; if (mft_data) { ntfs_inode *ext_ni = ntfs_inode_open(vol, FILE_mft_data); /* * If record 15 cannot be opened, it is probably in * use as an extent. Apply standard procedure for * further extents. */ if (ext_ni) { /* * Make sure record 15 is a base extent and it has * no name. A base inode with no name cannot be in use. * The test based on base_mft_record fails for * extents of MFT, so we need a special check. * If already used, apply standard procedure. */ if (!ext_ni->mrec->base_mft_record && !ext_ni->mrec->link_count) forced_mft_data = TRUE; ntfs_inode_close(ext_ni); /* Double-check, in case it is used for MFT */ if (forced_mft_data && base_ni->nr_extents) { int i; for (i=0; inr_extents; i++) { if (base_ni->extent_nis[i] && (base_ni->extent_nis[i]->mft_no == FILE_mft_data)) forced_mft_data = FALSE; } } } } if (forced_mft_data) bit = FILE_mft_data; else bit = ntfs_mft_bitmap_find_free_rec(vol, base_ni); if (bit >= 0) goto found_free_rec; if (errno != ENOSPC) goto out; errno = ENOSPC; /* strerror() is intentionally used below, we want to log this error. */ ntfs_log_error("No free mft record for $MFT: %s\n", strerror(errno)); goto err_out; found_free_rec: if (ntfs_bitmap_set_bit(mftbmp_na, bit)) { ntfs_log_error("Failed to allocate bit in mft bitmap #2\n"); goto err_out; } ll = (bit + 1) << vol->mft_record_size_bits; if (ll > mft_na->initialized_size) if (ntfs_mft_rec_init(vol, ll) < 0) goto undo_mftbmp_alloc; /* * We now have allocated and initialized the mft record. Need to read * it from disk and re-format it, preserving the sequence number if it * is not zero as well as the update sequence number if it is not zero * or -1 (0xffff). */ m = ntfs_malloc(vol->mft_record_size); if (!m) goto undo_mftbmp_alloc; if (ntfs_mft_record_read(vol, bit, m)) { free(m); goto undo_mftbmp_alloc; } /* Sanity check that the mft record is really not in use. */ if (!forced_mft_data && (ntfs_is_file_record(m->magic) && (m->flags & MFT_RECORD_IN_USE))) { ntfs_log_error("Inode %lld is used but it wasn't marked in " "$MFT bitmap. Fixed.\n", (long long)bit); free(m); goto undo_mftbmp_alloc; } /* * Retrieve the former seq_no and usn so that the new record * cannot be mistaken for the former one. * However the original record may just be garbage, so * use some sensible value when they cannot be retrieved. */ seq_no = m->sequence_number; if (le16_to_cpu(m->usa_ofs) <= (NTFS_BLOCK_SIZE - 2)) usn = *(le16*)((u8*)m + (le16_to_cpu(m->usa_ofs) & -2)); else usn = const_cpu_to_le16(1); if (ntfs_mft_record_layout(vol, bit, m)) { ntfs_log_error("Failed to re-format mft record.\n"); free(m); goto undo_mftbmp_alloc; } if (seq_no) m->sequence_number = seq_no; seq_no = usn; if (seq_no && seq_no != const_cpu_to_le16(0xffff)) *(le16*)((u8*)m + le16_to_cpu(m->usa_ofs)) = usn; /* Set the mft record itself in use. */ m->flags |= MFT_RECORD_IN_USE; /* Now need to open an ntfs inode for the mft record. */ ni = ntfs_inode_allocate(vol); if (!ni) { ntfs_log_error("Failed to allocate buffer for inode.\n"); free(m); goto undo_mftbmp_alloc; } ni->mft_no = bit; ni->mrec = m; /* * If we are allocating an extent mft record, make the opened inode an * extent inode and attach it to the base inode. Also, set the base * mft record reference in the extent inode. */ ni->nr_extents = -1; ni->base_ni = base_ni; m->base_mft_record = MK_LE_MREF(base_ni->mft_no, le16_to_cpu(base_ni->mrec->sequence_number)); /* * Attach the extent inode to the base inode, reallocating * memory if needed. */ if (!(base_ni->nr_extents & 3)) { ntfs_inode **extent_nis; int i; i = (base_ni->nr_extents + 4) * sizeof(ntfs_inode *); extent_nis = ntfs_malloc(i); if (!extent_nis) { free(m); free(ni); goto undo_mftbmp_alloc; } if (base_ni->nr_extents) { memcpy(extent_nis, base_ni->extent_nis, i - 4 * sizeof(ntfs_inode *)); free(base_ni->extent_nis); } base_ni->extent_nis = extent_nis; } base_ni->extent_nis[base_ni->nr_extents++] = ni; /* Make sure the allocated inode is written out to disk later. */ ntfs_inode_mark_dirty(ni); /* Initialize time, allocated and data size in ntfs_inode struct. */ ni->data_size = ni->allocated_size = 0; ni->flags = const_cpu_to_le32(0); ni->creation_time = ni->last_data_change_time = ni->last_mft_change_time = ni->last_access_time = ntfs_current_time(); /* Update the default mft allocation position if it was used. */ if (!base_ni) vol->mft_data_pos = bit + 1; /* Return the opened, allocated inode of the allocated mft record. */ ntfs_log_error("allocated %sinode %lld\n", base_ni ? "extent " : "", (long long)bit); out: ntfs_log_leave("\n"); return ni; undo_mftbmp_alloc: err = errno; if (ntfs_bitmap_clear_bit(mftbmp_na, bit)) ntfs_log_error("Failed to clear bit in mft bitmap.%s\n", es); errno = err; err_out: if (!errno) errno = EIO; ni = NULL; goto out; } /** * ntfs_mft_record_alloc - allocate an mft record on an ntfs volume * @vol: volume on which to allocate the mft record * @base_ni: open base inode if allocating an extent mft record or NULL * * Allocate an mft record in $MFT/$DATA of an open ntfs volume @vol. * * If @base_ni is NULL make the mft record a base mft record and allocate it at * the default allocator position. * * If @base_ni is not NULL make the allocated mft record an extent record, * allocate it starting at the mft record after the base mft record and attach * the allocated and opened ntfs inode to the base inode @base_ni. * * On success return the now opened ntfs (extent) inode of the mft record. * * On error return NULL with errno set to the error code. * * To find a free mft record, we scan the mft bitmap for a zero bit. To * optimize this we start scanning at the place specified by @base_ni or if * @base_ni is NULL we start where we last stopped and we perform wrap around * when we reach the end. Note, we do not try to allocate mft records below * number 24 because numbers 0 to 15 are the defined system files anyway and 16 * to 24 are used for storing extension mft records or used by chkdsk to store * its log. However the record number 15 is dedicated to the first extent to * the $DATA attribute of $MFT. This is required to avoid the possibility * of creating a run list with a circular dependence which once written to disk * can never be read in again. Windows will only use records 16 to 24 for * normal files if the volume is completely out of space. We never use them * which means that when the volume is really out of space we cannot create any * more files while Windows can still create up to 8 small files. We can start * doing this at some later time, it does not matter much for now. * * When scanning the mft bitmap, we only search up to the last allocated mft * record. If there are no free records left in the range 24 to number of * allocated mft records, then we extend the $MFT/$DATA attribute in order to * create free mft records. We extend the allocated size of $MFT/$DATA by 16 * records at a time or one cluster, if cluster size is above 16kiB. If there * is not sufficient space to do this, we try to extend by a single mft record * or one cluster, if cluster size is above the mft record size, but we only do * this if there is enough free space, which we know from the values returned * by the failed cluster allocation function when we tried to do the first * allocation. * * No matter how many mft records we allocate, we initialize only the first * allocated mft record, incrementing mft data size and initialized size * accordingly, open an ntfs_inode for it and return it to the caller, unless * there are less than 24 mft records, in which case we allocate and initialize * mft records until we reach record 24 which we consider as the first free mft * record for use by normal files. * * If during any stage we overflow the initialized data in the mft bitmap, we * extend the initialized size (and data size) by 8 bytes, allocating another * cluster if required. The bitmap data size has to be at least equal to the * number of mft records in the mft, but it can be bigger, in which case the * superfluous bits are padded with zeroes. * * Thus, when we return successfully (return value non-zero), we will have: * - initialized / extended the mft bitmap if necessary, * - initialized / extended the mft data if necessary, * - set the bit corresponding to the mft record being allocated in the * mft bitmap, * - open an ntfs_inode for the allocated mft record, and we will * - return the ntfs_inode. * * On error (return value zero), nothing will have changed. If we had changed * anything before the error occurred, we will have reverted back to the * starting state before returning to the caller. Thus, except for bugs, we * should always leave the volume in a consistent state when returning from * this function. * * Note, this function cannot make use of most of the normal functions, like * for example for attribute resizing, etc, because when the run list overflows * the base mft record and an attribute list is used, it is very important that * the extension mft records used to store the $DATA attribute of $MFT can be * reached without having to read the information contained inside them, as * this would make it impossible to find them in the first place after the * volume is dismounted. $MFT/$BITMAP probably does not need to follow this * rule because the bitmap is not essential for finding the mft records, but on * the other hand, handling the bitmap in this special way would make life * easier because otherwise there might be circular invocations of functions * when reading the bitmap but if we are careful, we should be able to avoid * all problems. */ ntfs_inode *ntfs_mft_record_alloc(ntfs_volume *vol, ntfs_inode *base_ni) { s64 ll, bit; ntfs_attr *mft_na, *mftbmp_na; MFT_RECORD *m; ntfs_inode *ni = NULL; int err; u32 usa_ofs; le16 seq_no, usn; BOOL oldwarn; if (base_ni) ntfs_log_enter("Entering (allocating an extent mft record for " "base mft record %lld).\n", (long long)base_ni->mft_no); else ntfs_log_enter("Entering (allocating a base mft record)\n"); if (!vol || !vol->mft_na || !vol->mftbmp_na) { errno = EINVAL; goto out; } if (ntfs_is_mft(base_ni)) { ni = ntfs_mft_rec_alloc(vol, FALSE); goto out; } mft_na = vol->mft_na; mftbmp_na = vol->mftbmp_na; retry: bit = ntfs_mft_bitmap_find_free_rec(vol, base_ni); if (bit >= 0) { ntfs_log_debug("found free record (#1) at %lld\n", (long long)bit); goto found_free_rec; } if (errno != ENOSPC) goto out; /* * No free mft records left. If the mft bitmap already covers more * than the currently used mft records, the next records are all free, * so we can simply allocate the first unused mft record. * Note: We also have to make sure that the mft bitmap at least covers * the first 24 mft records as they are special and whilst they may not * be in use, we do not allocate from them. */ ll = mft_na->initialized_size >> vol->mft_record_size_bits; if (mftbmp_na->initialized_size << 3 > ll && mftbmp_na->initialized_size > RESERVED_MFT_RECORDS / 8) { bit = ll; if (bit < RESERVED_MFT_RECORDS) bit = RESERVED_MFT_RECORDS; ntfs_log_debug("found free record (#2) at %lld\n", (long long)bit); goto found_free_rec; } /* * The mft bitmap needs to be expanded until it covers the first unused * mft record that we can allocate. * Note: The smallest mft record we allocate is mft record 24. */ ntfs_log_debug("Status of mftbmp before extension: allocated_size 0x%llx, " "data_size 0x%llx, initialized_size 0x%llx.\n", (long long)mftbmp_na->allocated_size, (long long)mftbmp_na->data_size, (long long)mftbmp_na->initialized_size); if (mftbmp_na->initialized_size + 8 > mftbmp_na->allocated_size) { int ret = ntfs_mft_bitmap_extend_allocation(vol); if (ret == STATUS_ERROR) goto err_out; if (ret == STATUS_KEEP_SEARCHING) { ret = ntfs_mft_bitmap_extend_allocation(vol); if (ret != STATUS_OK) goto err_out; } ntfs_log_debug("Status of mftbmp after allocation extension: " "allocated_size 0x%llx, data_size 0x%llx, " "initialized_size 0x%llx.\n", (long long)mftbmp_na->allocated_size, (long long)mftbmp_na->data_size, (long long)mftbmp_na->initialized_size); } /* * We now have sufficient allocated space, extend the initialized_size * as well as the data_size if necessary and fill the new space with * zeroes. */ bit = mftbmp_na->initialized_size << 3; if (ntfs_mft_bitmap_extend_initialized(vol)) goto err_out; ntfs_log_debug("Status of mftbmp after initialized extension: " "allocated_size 0x%llx, data_size 0x%llx, " "initialized_size 0x%llx.\n", (long long)mftbmp_na->allocated_size, (long long)mftbmp_na->data_size, (long long)mftbmp_na->initialized_size); ntfs_log_debug("found free record (#3) at %lld\n", (long long)bit); found_free_rec: /* @bit is the found free mft record, allocate it in the mft bitmap. */ if (ntfs_bitmap_set_bit(mftbmp_na, bit)) { ntfs_log_error("Failed to allocate bit in mft bitmap.\n"); goto err_out; } /* The mft bitmap is now uptodate. Deal with mft data attribute now. */ ll = (bit + 1) << vol->mft_record_size_bits; if (ll > mft_na->initialized_size) if (ntfs_mft_record_init(vol, ll) < 0) goto undo_mftbmp_alloc; /* * We now have allocated and initialized the mft record. Need to read * it from disk and re-format it, preserving the sequence number if it * is not zero as well as the update sequence number if it is not zero * or -1 (0xffff). */ m = ntfs_malloc(vol->mft_record_size); if (!m) goto undo_mftbmp_alloc; /* * As this is allocating a new record, do not expect it to have * been initialized previously, so do not warn over bad fixups * (hence avoid warn flooding when an NTFS partition has been wiped). */ oldwarn = !NVolNoFixupWarn(vol); NVolSetNoFixupWarn(vol); if (ntfs_mft_record_read(vol, bit, m)) { if (oldwarn) NVolClearNoFixupWarn(vol); free(m); goto undo_mftbmp_alloc; } if (oldwarn) NVolClearNoFixupWarn(vol); /* Sanity check that the mft record is really not in use. */ if (ntfs_is_file_record(m->magic) && (m->flags & MFT_RECORD_IN_USE)) { ntfs_log_error("Inode %lld is used but it wasn't marked in " "$MFT bitmap. Fixed.\n", (long long)bit); free(m); goto retry; } seq_no = m->sequence_number; /* * As ntfs_mft_record_read() returns what has been read * even when the fixups have been found bad, we have to * check where we fetch the initial usn from. */ usa_ofs = le16_to_cpu(m->usa_ofs); if (!(usa_ofs & 1) && (usa_ofs < NTFS_BLOCK_SIZE)) { usn = *(le16*)((u8*)m + usa_ofs); } else usn = const_cpu_to_le16(1); if (ntfs_mft_record_layout(vol, bit, m)) { ntfs_log_error("Failed to re-format mft record.\n"); free(m); goto undo_mftbmp_alloc; } if (seq_no) m->sequence_number = seq_no; seq_no = usn; if (seq_no && seq_no != const_cpu_to_le16(0xffff)) *(le16*)((u8*)m + le16_to_cpu(m->usa_ofs)) = usn; /* Set the mft record itself in use. */ m->flags |= MFT_RECORD_IN_USE; /* Now need to open an ntfs inode for the mft record. */ ni = ntfs_inode_allocate(vol); if (!ni) { ntfs_log_error("Failed to allocate buffer for inode.\n"); free(m); goto undo_mftbmp_alloc; } ni->mft_no = bit; ni->mrec = m; /* * If we are allocating an extent mft record, make the opened inode an * extent inode and attach it to the base inode. Also, set the base * mft record reference in the extent inode. */ if (base_ni) { ni->nr_extents = -1; ni->base_ni = base_ni; m->base_mft_record = MK_LE_MREF(base_ni->mft_no, le16_to_cpu(base_ni->mrec->sequence_number)); /* * Attach the extent inode to the base inode, reallocating * memory if needed. */ if (!(base_ni->nr_extents & 3)) { ntfs_inode **extent_nis; int i; i = (base_ni->nr_extents + 4) * sizeof(ntfs_inode *); extent_nis = ntfs_malloc(i); if (!extent_nis) { free(m); free(ni); goto undo_mftbmp_alloc; } if (base_ni->nr_extents) { memcpy(extent_nis, base_ni->extent_nis, i - 4 * sizeof(ntfs_inode *)); free(base_ni->extent_nis); } base_ni->extent_nis = extent_nis; } base_ni->extent_nis[base_ni->nr_extents++] = ni; } /* Make sure the allocated inode is written out to disk later. */ ntfs_inode_mark_dirty(ni); /* Initialize time, allocated and data size in ntfs_inode struct. */ ni->data_size = ni->allocated_size = 0; ni->flags = const_cpu_to_le32(0); ni->creation_time = ni->last_data_change_time = ni->last_mft_change_time = ni->last_access_time = ntfs_current_time(); /* Update the default mft allocation position if it was used. */ if (!base_ni) vol->mft_data_pos = bit + 1; /* Return the opened, allocated inode of the allocated mft record. */ ntfs_log_debug("allocated %sinode 0x%llx.\n", base_ni ? "extent " : "", (long long)bit); vol->free_mft_records--; out: ntfs_log_leave("\n"); return ni; undo_mftbmp_alloc: err = errno; if (ntfs_bitmap_clear_bit(mftbmp_na, bit)) ntfs_log_error("Failed to clear bit in mft bitmap.%s\n", es); errno = err; err_out: if (!errno) errno = EIO; ni = NULL; goto out; } /** * ntfs_mft_record_free - free an mft record on an ntfs volume * @vol: volume on which to free the mft record * @ni: open ntfs inode of the mft record to free * * Free the mft record of the open inode @ni on the mounted ntfs volume @vol. * Note that this function calls ntfs_inode_close() internally and hence you * cannot use the pointer @ni any more after this function returns success. * * On success return 0 and on error return -1 with errno set to the error code. */ int ntfs_mft_record_free(ntfs_volume *vol, ntfs_inode *ni) { u64 mft_no; int err; u16 seq_no; le16 old_seq_no; ntfs_log_trace("Entering for inode 0x%llx.\n", (long long) ni->mft_no); if (!vol || !vol->mftbmp_na || !ni) { errno = EINVAL; return -1; } if (utils_is_metadata(ni) == 1) { errno = EINVAL; return -1; } /* Cache the mft reference for later. */ mft_no = ni->mft_no; /* Mark the mft record as not in use. */ ni->mrec->flags &= ~MFT_RECORD_IN_USE; /* Increment the sequence number, skipping zero, if it is not zero. */ old_seq_no = ni->mrec->sequence_number; seq_no = le16_to_cpu(old_seq_no); if (seq_no == 0xffff) seq_no = 1; else if (seq_no) seq_no++; ni->mrec->sequence_number = cpu_to_le16(seq_no); /* Set the inode dirty and write it out. */ ntfs_inode_mark_dirty(ni); if (ntfs_inode_sync(ni)) { err = errno; goto sync_rollback; } /* Clear the bit in the $MFT/$BITMAP corresponding to this record. */ if (ntfs_bitmap_clear_bit(vol->mftbmp_na, mft_no)) { err = errno; // FIXME: If ntfs_bitmap_clear_run() guarantees rollback on // error, this could be changed to goto sync_rollback; goto bitmap_rollback; } /* Throw away the now freed inode. */ #if CACHE_NIDATA_SIZE if (!ntfs_inode_real_close(ni)) { #else if (!ntfs_inode_close(ni)) { #endif vol->free_mft_records++; return 0; } err = errno; /* Rollback what we did... */ bitmap_rollback: if (ntfs_bitmap_set_bit(vol->mftbmp_na, mft_no)) ntfs_log_debug("Eeek! Rollback failed in ntfs_mft_record_free(). " "Leaving inconsistent metadata!\n"); sync_rollback: ni->mrec->flags |= MFT_RECORD_IN_USE; ni->mrec->sequence_number = old_seq_no; ntfs_inode_mark_dirty(ni); errno = err; return -1; } /** * ntfs_mft_usn_dec - Decrement USN by one * @mrec: pointer to an mft record * * On success return 0 and on error return -1 with errno set. */ int ntfs_mft_usn_dec(MFT_RECORD *mrec) { u16 usn; le16 *usnp; if (!mrec) { errno = EINVAL; return -1; } usnp = (le16*)((char*)mrec + le16_to_cpu(mrec->usa_ofs)); usn = le16_to_cpup(usnp); if (usn-- <= 1) usn = 0xfffe; *usnp = cpu_to_le16(usn); return 0; } ntfsprogs-plus-1.0.0/libntfs/misc.c000066400000000000000000000033531507404161300172630ustar00rootroot00000000000000/** * misc.c : miscellaneous : * - dealing with errors in memory allocation * * Copyright (c) 2008 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #include "types.h" #include "misc.h" #include "logging.h" /** * ntfs_calloc * * Return a pointer to the allocated memory or NULL if the request fails. */ void *ntfs_calloc(size_t size) { void *p; p = calloc(1, size); if (!p) ntfs_log_perror("Failed to calloc %lld bytes", (long long)size); return p; } void *ntfs_malloc(size_t size) { void *p; p = malloc(size); if (!p) ntfs_log_perror("Failed to malloc %lld bytes", (long long)size); return p; } void *ntfs_realloc(void *ptr, size_t size) { void *p; p = realloc(ptr, size); if (!p) ntfs_log_perror("Failed to realloc %lld bytes", (long long)size); return p; } void ntfs_free(void *p) { free(p); } ntfsprogs-plus-1.0.0/libntfs/mst.c000066400000000000000000000200121507404161300171220ustar00rootroot00000000000000/** * mst.c - Multi sector fixup handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * Copyright (c) 2006-2009 Szabolcs Szakacsits * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_ERRNO_H #include #endif #include "mst.h" #include "logging.h" /* * Basic validation of a NTFS multi-sector record. The record size must be a * multiple of the logical sector size; and the update sequence array must be * properly aligned, of the expected length, and must end before the last le16 * in the first logical sector. */ static BOOL is_valid_record(u32 size, u16 usa_ofs, u16 usa_count) { return size % NTFS_BLOCK_SIZE == 0 && usa_ofs % 2 == 0 && usa_count == 1 + (size / NTFS_BLOCK_SIZE) && usa_ofs + ((u32)usa_count * 2) <= NTFS_BLOCK_SIZE - 2; } /** * ntfs_mst_post_read_fixup - deprotect multi sector transfer protected data * @b: pointer to the data to deprotect * @size: size in bytes of @b * * Perform the necessary post read multi sector transfer fixups and detect the * presence of incomplete multi sector transfers. - In that case, overwrite the * magic of the ntfs record header being processed with "BAAD" (in memory only!) * and abort processing. * * Return 0 on success and -1 on error, with errno set to the error code. The * following error codes are defined: * EINVAL Invalid arguments or invalid NTFS record in buffer @b. * EIO Multi sector transfer error was detected. Magic of the NTFS * record in @b will have been set to "BAAD". */ int ntfs_mst_post_read_fixup_warn(NTFS_RECORD *b, const u32 size, BOOL warn) { u16 usa_ofs, usa_count, usn; u16 *usa_pos, *data_pos; ntfs_log_trace("Entering\n"); /* Setup the variables. */ usa_ofs = le16_to_cpu(b->usa_ofs); usa_count = le16_to_cpu(b->usa_count); if (!is_valid_record(size, usa_ofs, usa_count)) { errno = EINVAL; if (warn) { ntfs_log_perror("%s: magic: 0x%08lx size: %ld " " usa_ofs: %d usa_count: %u", __FUNCTION__, (long)le32_to_cpu(*(le32 *)b), (long)size, (int)usa_ofs, (unsigned int)usa_count); } b->magic = magic_BAAD; return -1; } /* Position of usn in update sequence array. */ usa_pos = (u16*)b + usa_ofs/sizeof(u16); /* * The update sequence number which has to be equal to each of the * u16 values before they are fixed up. Note no need to care for * endianness since we are comparing and moving data for on disk * structures which means the data is consistent. - If it is * consistency the wrong endianness it doesn't make any difference. */ usn = *usa_pos; /* * Position in protected data of first u16 that needs fixing up. */ data_pos = (u16*)b + NTFS_BLOCK_SIZE/sizeof(u16) - 1; /* * Check for incomplete multi sector transfer(s). */ while (--usa_count) { if (*data_pos != usn) { /* * Incomplete multi sector transfer detected! )-: * Set the magic to "BAAD" and return failure. * Note that magic_BAAD is already converted to le32. */ errno = EIO; ntfs_log_perror("Incomplete multi-sector transfer: " "magic: 0x%08x size: %d usa_ofs: %d usa_count:" " %d data: %d usn: %d", le32_to_cpu(*(le32 *)b), size, usa_ofs, usa_count, *data_pos, usn); b->magic = magic_BAAD; return -1; } data_pos += NTFS_BLOCK_SIZE/sizeof(u16); } /* Re-setup the variables. */ usa_count = le16_to_cpu(b->usa_count); data_pos = (u16*)b + NTFS_BLOCK_SIZE/sizeof(u16) - 1; /* Fixup all sectors. */ while (--usa_count) { /* * Increment position in usa and restore original data from * the usa into the data buffer. */ *data_pos = *(++usa_pos); /* Increment position in data as well. */ data_pos += NTFS_BLOCK_SIZE/sizeof(u16); } return 0; } /* * Deprotect multi sector transfer protected data * with a warning if an error is found. */ int ntfs_mst_post_read_fixup(NTFS_RECORD *b, const u32 size) { return (ntfs_mst_post_read_fixup_warn(b,size,TRUE)); } /** * ntfs_mst_pre_write_fixup - apply multi sector transfer protection * @b: pointer to the data to protect * @size: size in bytes of @b * * Perform the necessary pre write multi sector transfer fixup on the data * pointer to by @b of @size. * * Return 0 if fixups applied successfully or -1 if no fixups were performed * due to errors. In that case errno i set to the error code (EINVAL). * * NOTE: We consider the absence / invalidity of an update sequence array to * mean error. This means that you have to create a valid update sequence * array header in the ntfs record before calling this function, otherwise it * will fail (the header needs to contain the position of the update sequence * array together with the number of elements in the array). You also need to * initialise the update sequence number before calling this function * otherwise a random word will be used (whatever was in the record at that * position at that time). */ int ntfs_mst_pre_write_fixup(NTFS_RECORD *b, const u32 size) { u16 usa_ofs, usa_count, usn; le16 le_usn; le16 *usa_pos, *data_pos; ntfs_log_trace("Entering\n"); /* Sanity check + only fixup if it makes sense. */ if (!b || ntfs_is_baad_record(b->magic) || ntfs_is_hole_record(b->magic)) { errno = EINVAL; ntfs_log_perror("%s: bad argument", __FUNCTION__); return -1; } /* Setup the variables. */ usa_ofs = le16_to_cpu(b->usa_ofs); usa_count = le16_to_cpu(b->usa_count); if (!is_valid_record(size, usa_ofs, usa_count)) { errno = EINVAL; ntfs_log_perror("%s", __FUNCTION__); return -1; } /* Position of usn in update sequence array. */ usa_pos = (le16*)((u8*)b + usa_ofs); /* * Cyclically increment the update sequence number * (skipping 0 and -1, i.e. 0xffff). */ usn = le16_to_cpup(usa_pos) + 1; if (usn == 0xffff || !usn) usn = 1; le_usn = cpu_to_le16(usn); *usa_pos = le_usn; /* Position in data of first le16 that needs fixing up. */ data_pos = (le16*)b + NTFS_BLOCK_SIZE/sizeof(le16) - 1; /* Fixup all sectors. */ while (--usa_count) { /* * Increment the position in the usa and save the * original data from the data buffer into the usa. */ *(++usa_pos) = *data_pos; /* Apply fixup to data. */ *data_pos = le_usn; /* Increment position in data as well. */ data_pos += NTFS_BLOCK_SIZE/sizeof(le16); } return 0; } /** * ntfs_mst_post_write_fixup - deprotect multi sector transfer protected data * @b: pointer to the data to deprotect * * Perform the necessary post write multi sector transfer fixup, not checking * for any errors, because we assume we have just used * ntfs_mst_pre_write_fixup(), thus the data will be fine or we would never * have gotten here. */ void ntfs_mst_post_write_fixup(NTFS_RECORD *b) { u16 *usa_pos, *data_pos; u16 usa_ofs = le16_to_cpu(b->usa_ofs); u16 usa_count = le16_to_cpu(b->usa_count); ntfs_log_trace("Entering\n"); /* Position of usn in update sequence array. */ usa_pos = (u16*)b + usa_ofs/sizeof(u16); /* Position in protected data of first u16 that needs fixing up. */ data_pos = (u16*)b + NTFS_BLOCK_SIZE/sizeof(u16) - 1; /* Fixup all sectors. */ while (--usa_count) { /* * Increment position in usa and restore original data from * the usa into the data buffer. */ *data_pos = *(++usa_pos); /* Increment position in data as well. */ data_pos += NTFS_BLOCK_SIZE/sizeof(u16); } } ntfsprogs-plus-1.0.0/libntfs/object_id.c000066400000000000000000000404171507404161300202540ustar00rootroot00000000000000/** * object_id.c - Processing of object ids * * This module is part of ntfs-3g library * * Copyright (c) 2009-2019 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_SYS_SYSMACROS_H #include #endif #include "compat.h" #include "types.h" #include "debug.h" #include "attrib.h" #include "inode.h" #include "dir.h" #include "volume.h" #include "mft.h" #include "index.h" #include "lcnalloc.h" #include "object_id.h" #include "logging.h" #include "misc.h" #include "xattrs.h" /* * Endianness considerations * * According to RFC 4122, GUIDs should be printed with the most * significant byte first, and the six fields be compared individually * for ordering. RFC 4122 does not define the internal representation. * * Windows apparently stores the first three fields in little endian * order, and the last two fields in big endian order. * * Here we always copy disk images with no endianness change, * and, for indexing, GUIDs are compared as if they were a sequence * of four little-endian unsigned 32 bit integers (as Windows * does it that way.) * * --------------------- begin from RFC 4122 ---------------------- * Consider each field of the UUID to be an unsigned integer as shown * in the table in section Section 4.1.2. Then, to compare a pair of * UUIDs, arithmetically compare the corresponding fields from each * UUID in order of significance and according to their data type. * Two UUIDs are equal if and only if all the corresponding fields * are equal. * * UUIDs, as defined in this document, can also be ordered * lexicographically. For a pair of UUIDs, the first one follows the * second if the most significant field in which the UUIDs differ is * greater for the first UUID. The second precedes the first if the * most significant field in which the UUIDs differ is greater for * the second UUID. * * The fields are encoded as 16 octets, with the sizes and order of the * fields defined above, and with each field encoded with the Most * Significant Byte first (known as network byte order). Note that the * field names, particularly for multiplexed fields, follow historical * practice. * * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | time_low | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | time_mid | time_hi_and_version | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |clk_seq_hi_res | clk_seq_low | node (0-1) | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | node (2-5) | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * * ---------------------- end from RFC 4122 ----------------------- */ typedef struct { union { /* alignment may be needed to evaluate collations */ u32 alignment; GUID guid; } object_id; } OBJECT_ID_INDEX_KEY; typedef struct { le64 file_id; GUID birth_volume_id; GUID birth_object_id; GUID domain_id; } OBJECT_ID_INDEX_DATA; // known as OBJ_ID_INDEX_DATA struct OBJECT_ID_INDEX { /* index entry in $Extend/$ObjId */ INDEX_ENTRY_HEADER header; OBJECT_ID_INDEX_KEY key; OBJECT_ID_INDEX_DATA data; } ; static ntfschar objid_index_name[] = { const_cpu_to_le16('$'), const_cpu_to_le16('O') }; /* * Set the index for a new object id * * Returns 0 if success * -1 if failure, explained by errno */ static int set_object_id_index(ntfs_inode *ni, ntfs_index_context *xo, const OBJECT_ID_ATTR *object_id) { struct OBJECT_ID_INDEX indx; u64 file_id_cpu; le64 file_id; le16 seqn; seqn = ni->mrec->sequence_number; file_id_cpu = MK_MREF(ni->mft_no,le16_to_cpu(seqn)); file_id = cpu_to_le64(file_id_cpu); indx.header.data_offset = const_cpu_to_le16( sizeof(INDEX_ENTRY_HEADER) + sizeof(OBJECT_ID_INDEX_KEY)); indx.header.data_length = const_cpu_to_le16( sizeof(OBJECT_ID_INDEX_DATA)); indx.header.reservedV = const_cpu_to_le32(0); indx.header.length = const_cpu_to_le16( sizeof(struct OBJECT_ID_INDEX)); indx.header.key_length = const_cpu_to_le16( sizeof(OBJECT_ID_INDEX_KEY)); indx.header.flags = const_cpu_to_le16(0); indx.header.reserved = const_cpu_to_le16(0); memcpy(&indx.key.object_id,object_id,sizeof(GUID)); indx.data.file_id = file_id; memcpy(&indx.data.birth_volume_id, &object_id->birth_volume_id,sizeof(GUID)); memcpy(&indx.data.birth_object_id, &object_id->birth_object_id,sizeof(GUID)); memcpy(&indx.data.domain_id, &object_id->domain_id,sizeof(GUID)); ntfs_index_ctx_reinit(xo); return (ntfs_ie_add(xo,(INDEX_ENTRY*)&indx)); } /* * Open the $Extend/$ObjId file and its index * * Return the index context if opened * or NULL if an error occurred (errno tells why) * * The index has to be freed and inode closed when not needed any more. */ static ntfs_index_context *open_object_id_index(ntfs_volume *vol) { u64 inum; ntfs_inode *ni; ntfs_inode *dir_ni; ntfs_index_context *xo; /* do not use path_name_to inode - could reopen root */ dir_ni = ntfs_inode_open(vol, FILE_Extend); ni = (ntfs_inode*)NULL; if (dir_ni) { inum = ntfs_inode_lookup_by_mbsname(dir_ni,"$ObjId"); if (inum != (u64)-1) ni = ntfs_inode_open(vol, inum); ntfs_inode_close(dir_ni); } if (ni) { xo = ntfs_index_ctx_get(ni, objid_index_name, 2); if (!xo) { ntfs_inode_close(ni); } } else xo = (ntfs_index_context*)NULL; return (xo); } /* * Merge object_id data stored in the index into * a full object_id struct. * * returns 0 if merging successful * -1 if no data could be merged. This is generally not an error */ static int merge_index_data(ntfs_inode *ni, const OBJECT_ID_ATTR *objectid_attr, OBJECT_ID_ATTR *full_objectid) { OBJECT_ID_INDEX_KEY key; struct OBJECT_ID_INDEX *entry; ntfs_index_context *xo; ntfs_inode *xoni; int res; res = -1; xo = open_object_id_index(ni->vol); if (xo) { memcpy(&key.object_id,objectid_attr,sizeof(GUID)); if (!ntfs_index_lookup(&key, sizeof(OBJECT_ID_INDEX_KEY), xo)) { entry = (struct OBJECT_ID_INDEX*)xo->entry; /* make sure inode numbers match */ if (entry && (MREF(le64_to_cpu(entry->data.file_id)) == ni->mft_no)) { memcpy(&full_objectid->birth_volume_id, &entry->data.birth_volume_id, sizeof(GUID)); memcpy(&full_objectid->birth_object_id, &entry->data.birth_object_id, sizeof(GUID)); memcpy(&full_objectid->domain_id, &entry->data.domain_id, sizeof(GUID)); res = 0; } } xoni = xo->ni; ntfs_index_ctx_put(xo); ntfs_inode_close(xoni); } return (res); } /* * Remove an object id index entry if attribute present * * Returns the size of existing object id * (the existing object_d is returned) * -1 if failure, explained by errno */ static int remove_object_id_index(ntfs_attr *na, ntfs_index_context *xo, OBJECT_ID_ATTR *old_attr) { OBJECT_ID_INDEX_KEY key; struct OBJECT_ID_INDEX *entry; s64 size; int ret; ret = na->data_size; if (ret) { /* read the existing object id attribute */ size = ntfs_attr_pread(na, 0, sizeof(GUID), old_attr); if (size >= (s64)sizeof(GUID)) { memcpy(&key.object_id, &old_attr->object_id,sizeof(GUID)); if (!ntfs_index_lookup(&key, sizeof(OBJECT_ID_INDEX_KEY), xo)) { entry = (struct OBJECT_ID_INDEX*)xo->entry; memcpy(&old_attr->birth_volume_id, &entry->data.birth_volume_id, sizeof(GUID)); memcpy(&old_attr->birth_object_id, &entry->data.birth_object_id, sizeof(GUID)); memcpy(&old_attr->domain_id, &entry->data.domain_id, sizeof(GUID)); if (ntfs_index_rm(xo)) ret = -1; } } else { ret = -1; errno = ENODATA; } } return (ret); } /* * Update the object id and index * * The object_id attribute should have been created and the * non-duplication of the GUID should have been checked before. * * Returns 0 if success * -1 if failure, explained by errno * If could not remove the existing index, nothing is done, * If could not write the new data, no index entry is inserted * If failed to insert the index, data is removed */ static int update_object_id(ntfs_inode *ni, ntfs_index_context *xo, const OBJECT_ID_ATTR *value, size_t size) { OBJECT_ID_ATTR old_attr; ntfs_attr *na; int oldsize; int written; int res; res = 0; na = ntfs_attr_open(ni, AT_OBJECT_ID, AT_UNNAMED, 0); if (na) { memset(&old_attr, 0, sizeof(OBJECT_ID_ATTR)); /* remove the existing index entry */ oldsize = remove_object_id_index(na,xo,&old_attr); if (oldsize < 0) res = -1; else { /* resize attribute */ res = ntfs_attr_truncate(na, (s64)sizeof(GUID)); /* write the object_id in attribute */ if (!res && value) { written = (int)ntfs_attr_pwrite(na, (s64)0, (s64)sizeof(GUID), &value->object_id); if (written != (s64)sizeof(GUID)) { ntfs_log_error("Failed to update " "object id\n"); errno = EIO; res = -1; } } /* overwrite index data with new value */ memcpy(&old_attr, value, (size < sizeof(OBJECT_ID_ATTR) ? size : sizeof(OBJECT_ID_ATTR))); if (!res && set_object_id_index(ni,xo,&old_attr)) { /* * If cannot index, try to remove the object * id and log the error. There will be an * inconsistency if removal fails. */ ntfs_attr_rm(na); ntfs_log_error("Failed to index object id." " Possible corruption.\n"); } } ntfs_attr_close(na); NInoSetDirty(ni); } else res = -1; return (res); } /* * Add a (dummy) object id to an inode if it does not exist * * returns 0 if attribute was inserted (or already present) * -1 if adding failed (explained by errno) */ static int add_object_id(ntfs_inode *ni, int flags) { int res; u8 dummy; res = -1; /* default return */ if (!ntfs_attr_exist(ni,AT_OBJECT_ID, AT_UNNAMED,0)) { if (!(flags & XATTR_REPLACE)) { /* * no object id attribute : add one, * apparently, this does not feed the new value in * Note : NTFS version must be >= 3 */ if (ni->vol->major_ver >= 3) { res = ntfs_attr_add(ni, AT_OBJECT_ID, AT_UNNAMED, 0, &dummy, (s64)0); NInoSetDirty(ni); } else errno = EOPNOTSUPP; } else errno = ENODATA; } else { if (flags & XATTR_CREATE) errno = EEXIST; else res = 0; } return (res); } /* * Delete an object_id index entry * * Returns 0 if success * -1 if failure, explained by errno */ int ntfs_delete_object_id_index(ntfs_inode *ni) { ntfs_index_context *xo; ntfs_inode *xoni; ntfs_attr *na; OBJECT_ID_ATTR old_attr; int res; res = 0; na = ntfs_attr_open(ni, AT_OBJECT_ID, AT_UNNAMED, 0); if (na) { /* * read the existing object id * and un-index it */ xo = open_object_id_index(ni->vol); if (xo) { if (remove_object_id_index(na,xo,&old_attr) < 0) res = -1; xoni = xo->ni; ntfs_index_entry_mark_dirty(xo); NInoSetDirty(xoni); ntfs_index_ctx_put(xo); ntfs_inode_close(xoni); } ntfs_attr_close(na); } return (res); } /* * Get the ntfs object id into an extended attribute * * If present, the object_id from the attribute and the GUIDs * from the index are returned (formatted as OBJECT_ID_ATTR) * * Returns the global size (can be 0, 16 or 64) * and the buffer is updated if it is long enough */ int ntfs_get_ntfs_object_id(ntfs_inode *ni, char *value, size_t size) { OBJECT_ID_ATTR full_objectid; OBJECT_ID_ATTR *objectid_attr; s64 attr_size; int full_size; full_size = 0; /* default to no data and some error to be defined */ if (ni) { objectid_attr = (OBJECT_ID_ATTR*)ntfs_attr_readall(ni, AT_OBJECT_ID,(ntfschar*)NULL, 0, &attr_size); if (objectid_attr) { /* restrict to only GUID present in attr */ if (attr_size == sizeof(GUID)) { memcpy(&full_objectid.object_id, objectid_attr,sizeof(GUID)); full_size = sizeof(GUID); /* get data from index, if any */ if (!merge_index_data(ni, objectid_attr, &full_objectid)) { full_size = sizeof(OBJECT_ID_ATTR); } if (full_size <= (s64)size) { if (value) memcpy(value,&full_objectid, full_size); else errno = EINVAL; } } else { /* unexpected size, better return unsupported */ errno = EOPNOTSUPP; full_size = 0; } free(objectid_attr); } else errno = ENODATA; } return (full_size ? (int)full_size : -errno); } /* * Set the object id from an extended attribute * * The first 16 bytes are the new object id, they can be followed * by the birth volume id, the birth object id and the domain id. * If they are not present, their previous value is kept. * Only the object id is stored into the attribute, all the fields * are stored into the index. * * Returns 0, or -1 if there is a problem */ int ntfs_set_ntfs_object_id(ntfs_inode *ni, const char *value, size_t size, int flags) { OBJECT_ID_INDEX_KEY key; ntfs_inode *xoni; ntfs_index_context *xo; int res; res = 0; if (ni && value && (size >= sizeof(GUID))) { xo = open_object_id_index(ni->vol); if (xo) { /* make sure the GUID was not used elsewhere */ memcpy(&key.object_id, value, sizeof(GUID)); if ((ntfs_index_lookup(&key, sizeof(OBJECT_ID_INDEX_KEY), xo)) || (MREF_LE(((struct OBJECT_ID_INDEX*)xo->entry) ->data.file_id) == ni->mft_no)) { ntfs_index_ctx_reinit(xo); res = add_object_id(ni, flags); if (!res) { /* update value and index */ res = update_object_id(ni,xo, (const OBJECT_ID_ATTR*)value, size); } } else { /* GUID is present elsewhere */ res = -1; errno = EEXIST; } xoni = xo->ni; ntfs_index_entry_mark_dirty(xo); NInoSetDirty(xoni); ntfs_index_ctx_put(xo); ntfs_inode_close(xoni); } else { res = -1; } } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } /* * Remove the object id * * Returns 0, or -1 if there is a problem */ int ntfs_remove_ntfs_object_id(ntfs_inode *ni) { int res; int olderrno; ntfs_attr *na; ntfs_inode *xoni; ntfs_index_context *xo; int oldsize; OBJECT_ID_ATTR old_attr; res = 0; if (ni) { /* * open and delete the object id */ na = ntfs_attr_open(ni, AT_OBJECT_ID, AT_UNNAMED,0); if (na) { /* first remove index (old object id needed) */ xo = open_object_id_index(ni->vol); if (xo) { oldsize = remove_object_id_index(na,xo, &old_attr); if (oldsize < 0) { res = -1; } else { /* now remove attribute */ res = ntfs_attr_rm(na); if (res && (oldsize > (int)sizeof(GUID))) { /* * If we could not remove the * attribute, try to restore the * index and log the error. There * will be an inconsistency if * the reindexing fails. */ set_object_id_index(ni, xo, &old_attr); ntfs_log_error( "Failed to remove object id." " Possible corruption.\n"); } } xoni = xo->ni; ntfs_index_entry_mark_dirty(xo); NInoSetDirty(xoni); ntfs_index_ctx_put(xo); ntfs_inode_close(xoni); } olderrno = errno; ntfs_attr_close(na); /* avoid errno pollution */ if (errno == ENOENT) errno = olderrno; } else { errno = ENODATA; res = -1; } NInoSetDirty(ni); } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } ntfsprogs-plus-1.0.0/libntfs/problem.c000066400000000000000000000252361507404161300177740ustar00rootroot00000000000000/* SPDX-License-Identifier : GPL-2.0 */ /* problem.c : manage problem which is found during fsck */ #include #include "problem.h" static struct ntfs_problem problem_table[] = { /* Pre-scan MFT */ { PR_PRE_SCAN_MFT, "Scan all mft entries and apply those lcn bitmap to disk", PR_PREEN_NOMSG | PR_NO_NOMSG, }, { PR_RESET_LOG_FILE, "Reset logfile", PR_PREEN_NOMSG | PR_NO_NOMSG, }, { PR_MFT_FLAG_MISMATCH, "Inode(@In:@IN): MFT flag set as directory, but MFT/$FN is not set.", }, { PR_DIR_NONZERO_SIZE, "Directory(@In:@IN) has non-zero length(@Fs:@Is).", }, { PR_MFT_REPARSE_TAG_MISMATCH, "Inode(@In:@IN): Reparse tag is different with IDX/$FN, MFT/$FN.", }, { PR_MFT_ALLOCATED_SIZE_MISMATCH, "Inode(@In): Allocated size is different with IDX/$FN(@Fs), MFT/$DATA(@Is).", }, { PR_MFT_DATA_SIZE_MISMATCH, "Inode(@In): Data size is different with IDX/$FN(@Fd), MFT/$DATA(@Id).", }, { PR_DIR_FLAG_MISMATCH_IDX_FN, "Directory(@In): MFT flag is set to directory, IDX/$FN is not.", }, { PR_DIR_FLAG_MISMATCH_MFT_FN, "Directory(@In): MFT/$FN flag is set to directory, but there's no $IR.", }, { PR_DIR_IR_NOT_EXIST, "Directory(@In): INDEX/$FN flag is set to directory, but there's no $IR.", }, { PR_MFT_FLAG_MISMATCH_IDX_FN, "Inode(@In): MFT/$FN is set to file, but IDX/$FN is set to directory.", }, { PR_FILE_HAVE_IR, "Inode(@In): MFT/$FN is set to file, but there's no $DATA, $IR exist.", }, { PR_ATTR_LOWEST_VCN_IS_NOT_ZERO, "Inode(@In:@At): Attirbute lowest vcn(@av) is not zero.", }, { PR_ATTR_NON_RESIDENT_SIZES_MISMATCH, "Inode(@In:@At): Size of non resident are corrupted.", }, { PR_ATTR_VALUE_OFFSET_BADLY_ALIGNED, "Inode(@In:@At): Value offset badly aligned in attribute.", }, { PR_ATTR_VALUE_OFFSET_CORRUPTED, "Inode(@In:@At): Value offset is corrupted in attribute.", }, { PR_ATTR_NAME_OFFSET_CORRUPTED, "Inode(@In:@At): Name offset is corrupted in attribute.", }, { PR_ATTR_LENGTH_CORRUPTED, "Inode(@In:@At): Attribute length is corrupted in attribute.", }, { PR_ATTR_FN_FLAG_MISMATCH, "Inode(@In:@At): $FN flag's not matched attribute flag.", }, { PR_ATTR_IR_SIZE_MISMATCH, "Directory(@In): $IR index block size is corrupted.", }, { PR_IA_MAGIC_CORRUPTED, "Directory(@In): Index block(vcn:@av) signature is corrupted.", }, { PR_MFT_MAGIC_CORRUPTED, "Inode(@In): MFT magic signature is corrupted.", }, { PR_MFT_SIZE_CORRUPTED, "Inode(@In:@Is): MFT allocated size is corrupted.", }, { PR_MFT_ATTR_OFFSET_CORRUPTED, "Inode(@In): MFT attribute offset is badly algined.", }, { PR_MFT_BIU_CORRUPTED, "Inode(@In): MFT byte-in-use field is corrupted.", }, { PR_IE_ZERO_LENGTH, "Directory(@In): Index entry length is zero, It should be at least size of IE header.", }, { PR_BOOT_SECTOR_INVALID, "Invalid boot sector,", }, { PR_MOUNT_LOAD_MFT_FAILURE, "Failed to load $MFT(0), recover from $MFTMirr", }, { PR_MOUNT_LOAD_MFTMIRR_FAILURE, "Failed to load $MFTMirr(1), recover from $MFTMirr", }, { PR_MOUNT_REPAIRED_MFTMIRR_CORRUPTED, "$MFT is corrupted, repair $MFT from $MFTMirr", }, { PR_IE_FLAG_SUB_NODE_CORRUPTED, "Directory(@In): Index entry have sub-node, buf flag is not set.", }, { PR_MOUNT_MFT_MFTMIRR_MISMATCH, "$MFT/$MFTMirr records do not match. Repair $MFTMirror", }, { PR_IE_END_FLAG_CORRUPTED, "Directory(@In): Index entry is empty, but did not set end flag.", }, { PR_LOG_APPLY_RUNLIST_TO_DISK, "Inode(@In): Repaired runlist should be applied to disk", PR_PREEN_NOMSG, }, { PR_DIR_HAVE_RESIDENT_IA, "Directory(@In) has resident $INDEX_ALLOCATION.", }, { PR_ATTRLIST_LENGTH_CORRUPTED, "Inode(@In:@At): Attribute list length is corrupted.", }, { PR_IDX_ENTRY_CORRUPTED, "Inode(@In:@IN): Index entry is corrupted, Remove it from parent(@Pn)", }, { PR_IDX_BITMAP_SIZE_MISMATCH, "Inode(@In): Bitmap of index allocation size are different.", }, { PR_IDX_BITMAP_MISMATCH, "Inode(@In): Checked index bitmap and on disk index bitmap are different.", }, { PR_CLUSTER_BITMAP_MISMATCH, "Inode(@In:@At): Cluster bitmap of fsck and disk are different. Apply to disk", }, { PR_ORPHANED_MFT_REPAIR, "Found an orphaned file(@In), try to add index entry", }, { PR_DIR_IDX_INITIALIZE, "Initialize all index structure of directory(@In).", }, { PR_BITMAP_MFT_SIZE_MISMATCH, "$Bitmap size(@Ad) is smaller than expected(@Sd).", }, { PR_DIR_EMPTY_IE_LENGTH_CORRUPTED, "Directory(@In): Length of empty entry of $INDEX_ROOT is not valid.", }, { PR_CLUSTER_DUPLICATION_FOUND, "Inode(@In:@At): Found cluster duplication.", }, { PR_ORPHANED_MFT_OPEN_FAILURE, "Inode(@In) open failed. Clear MFT bitmap of inode", PR_PREEN_NOMSG, }, { PR_ORPHANED_MFT_CHECK_FAILURE, "Inode(@In) check failed. Delete orphaned NFT candidiates", PR_PREEN_NOMSG, }, { 0, }, }; static struct ntfs_problem *find_problem(problem_code_t code) { int i; for (i = 0; problem_table[i].code; i++) { if (problem_table[i].code == code) return &problem_table[i]; } return NULL; } static void expand_inode_expression(problem_context_t *pctx, char ch) { ntfs_inode *ni = NULL; MFT_RECORD *m = NULL; if (pctx->ni) ni = pctx->ni; if (pctx->m) m = pctx->m; switch (ch) { case 'n': /* inode number */ fprintf(stderr, "%" PRIu64 "", ni ? ni->mft_no : pctx->inum); break; case 's': /* inode allocated size ($FN allocated size) */ fprintf(stderr, "%" PRIu64 "", ni ? ni->allocated_size : m ? le32_to_cpu(m->bytes_allocated) : pctx->asize); break; case 'd': /* inode data size ($FN data size) */ fprintf(stderr, "%" PRIu64 "", ni ? ni->data_size : pctx->dsize); break; case 'N': fprintf(stderr, "%s", pctx->filename); break; default: break; } } static void expand_attr_expression(problem_context_t *pctx, char ch) { ntfs_attr *na = NULL; ATTR_RECORD *a = NULL; if (!pctx->na && !pctx->a) return; if (pctx->na) na = pctx->na; if (pctx->a) a = pctx->a; switch (ch) { case 't': /* attribute type */ fprintf(stderr, "%02x", na ? na->type: (int)le32_to_cpu(a->type)); break; case 's': /* attribute allocated size */ fprintf(stderr, "%" PRIu64 "", na ? na->allocated_size : sle64_to_cpu(a->allocated_size)); break; case 'd': /* attribute data size */ fprintf(stderr, "%" PRIu64 "", na ? na->data_size : sle64_to_cpu(a->data_size)); break; default: break; } } static void expand_fn_expression(problem_context_t *pctx, char ch) { FILE_NAME_ATTR *fn = NULL; if (!pctx->fn) return; fn = pctx->fn; switch (ch) { case 's': /* index key ($FN) allocated size */ fprintf(stderr, "%" PRIu64 "", le64_to_cpu(fn->allocated_size)); break; case 'd': /* index key ($FN) data size */ fprintf(stderr, "%" PRIu64 "", le64_to_cpu(fn->data_size)); break; default: break; } } static void expand_pinode_expression(problem_context_t *pctx, char ch) { ntfs_index_context *ictx = NULL; if (!pctx->ictx) return; ictx = pctx->ictx; switch (ch) { case 'n': /* parent inode number */ fprintf(stderr, "%" PRIu64 "", ictx->ni->mft_no); break; default: break; } } static void expand_ib_expression(problem_context_t *pctx, char ch) { switch (ch) { case 'v': /* index block vcn */ fprintf(stderr, "%" PRIu64 "", pctx->vcn); break; default: break; } } static void expand_sp_expression(problem_context_t *pctx, char ch) { switch (ch) { case 'd': /* related data */ fprintf(stderr, "%" PRIu64 "", pctx->dsize); break; default: break; } } static void print_param_message(problem_context_t *pctx, const char *param) { const char *cp; int i; if (!pctx) return; for (cp = param; *cp; cp++) { if (cp[0] != '@') { for (i = 1; cp[i]; i++) if (cp[i] == '@') break; fprintf(stderr, "%.*s", i, cp); cp += (i - 1); continue; } cp++; switch (cp[0]) { case 'I': /* inode */ cp++; expand_inode_expression(pctx, *cp); break; case 'A': /* attribute */ cp++; expand_attr_expression(pctx, *cp); break; case 'F': /* index key filename */ cp++; expand_fn_expression(pctx, *cp); break; case 'P': /* parent inode */ cp++; expand_pinode_expression(pctx, *cp); break; case 'a': /* index block */ cp++; expand_ib_expression(pctx, *cp); break; case 'S': /* specific data */ cp++; expand_sp_expression(pctx, *cp); break; } } } static void print_message(problem_context_t *pctx, const char *message) { if (message && *message) print_param_message(pctx, message); } BOOL ntfs_ask_repair(const ntfs_volume *vol) { BOOL repair = FALSE; char answer[8]; if (NVolFsNoRepair(vol) || !NVolFsck(vol)) { ntfs_log_error("No\n"); return FALSE; } else if (NVolFsYesRepair(vol) || NVolFsAutoRepair(vol)) { ntfs_log_error("Yes\n"); return TRUE; } else if (NVolFsAskRepair(vol)) { do { ntfs_log_error(" (y/N) "); fflush(stderr); if (fgets(answer, sizeof(answer), stdin)) { if (strcasecmp(answer, "Y\n") == 0) return TRUE; else if (strcasecmp(answer, "\n") == 0 || strcasecmp(answer, "N\n") == 0) return FALSE; } } while (1); } return repair; } void ntfs_print_problem(ntfs_volume *vol, problem_code_t code, problem_context_t *pctx) { struct ntfs_problem *p; int suppress = 0; const char *message; p = find_problem(code); if (!p) { ntfs_log_error("Unhandled error code (0x%x)!\n", code); return; } if ((p->flags & PR_PREEN_NOMSG) && (vol->option_flags & NTFS_MNT_FS_PREEN_REPAIR)) suppress++; if ((p->flags & PR_NO_NOMSG) && (vol->option_flags & NTFS_MNT_FS_NO_REPAIR)) suppress++; if (suppress) return; message = p->desc; print_message(pctx, message); fflush(stderr); } void ntfs_init_problem_ctx(problem_context_t *pctx, ntfs_inode *ni, ntfs_attr *na, ntfs_attr_search_ctx *ctx, ntfs_index_context *ictx, MFT_RECORD *m, ATTR_RECORD *a, FILE_NAME_ATTR *fn) { if (!pctx) return; pctx->ni = ni; pctx->na = na; pctx->ctx = ctx; pctx->ictx = ictx; pctx->m = m; pctx->a = a; pctx->fn = fn; } BOOL ntfs_fix_problem(ntfs_volume *vol, problem_code_t code, problem_context_t *pctx) { struct ntfs_problem *p; int suppress = 0; int repair = FALSE; const char *message; p = find_problem(code); if (!p) { ntfs_log_error("Unhandled error code (0x%x)!\n", code); return FALSE; } if ((p->flags & PR_PREEN_NOMSG) && (vol->option_flags & NTFS_MNT_FS_PREEN_REPAIR)) { suppress++; repair = TRUE; } if ((p->flags & PR_NO_NOMSG) && (vol->option_flags & NTFS_MNT_FS_NO_REPAIR)) { suppress++; repair = FALSE; } if (suppress) return repair; if (pctx) pctx->err_code = code; message = p->desc; print_message(pctx, message); fprintf(stderr, " Fix it? "); fflush(stderr); /* TODO: add flags and check about all errors */ return ntfs_ask_repair(vol); } ntfsprogs-plus-1.0.0/libntfs/realpath.c000066400000000000000000000045151507404161300201310ustar00rootroot00000000000000/* * realpath.c - realpath() aware of device mapper * Originated from the util-linux project. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #ifdef HAVE_LIMITS_H #include #endif #ifdef HAVE_CTYPE_H #include #endif #include "param.h" #include "realpath.h" /* If there is no realpath() on the system, provide a dummy one. */ #ifndef HAVE_REALPATH char *ntfs_realpath(const char *path, char *resolved_path) { strncpy(resolved_path, path, PATH_MAX); resolved_path[PATH_MAX] = '\0'; return resolved_path; } #endif #ifdef linux /* * Converts private "dm-N" names to "/dev/mapper/" * * Since 2.6.29 (patch 784aae735d9b0bba3f8b9faef4c8b30df3bf0128) kernel sysfs * provides the real DM device names in /sys/block//dm/name */ static char * canonicalize_dm_name(const char *ptname, char *canonical) { FILE *f; size_t sz; char name[MAPPERNAMELTH + 16]; char path[sizeof(name) + 16]; char *res = NULL; snprintf(path, sizeof(path), "/sys/block/%s/dm/name", ptname); if (!(f = fopen(path, "r"))) return NULL; /* read "\n" from sysfs */ if (fgets(name, sizeof(name), f) && (sz = strlen(name)) > 1) { name[sz - 1] = '\0'; snprintf(path, sizeof(path), "/dev/mapper/%s", name); res = strcpy(canonical, path); } fclose(f); return res; } /* * Canonicalize a device path * * Workaround from "basinilya" for fixing device mapper paths. * * Background (Phillip Susi, 2011-04-09) * - ntfs-3g canonicalizes the device name so that if you mount with * /dev/mapper/foo, the device name listed in mtab is /dev/dm-n, * so you can not umount /dev/mapper/foo * - umount won't even recognize and translate /dev/dm-n to the mount * point, apparently because of the '-' involved. Editing mtab and * removing the '-' allows you to umount /dev/dmn successfully. * * This code restores the devmapper name after canonicalization, * until a proper fix is implemented. */ char *ntfs_realpath_canonicalize(const char *path, char *canonical) { char *p; if (path == NULL) return NULL; if (!ntfs_realpath(path, canonical)) return NULL; p = strrchr(canonical, '/'); if (p && strncmp(p, "/dm-", 4) == 0 && isdigit(*(p + 4))) { p = canonicalize_dm_name(p+1, canonical); if (p) return p; } return canonical; } #endif ntfsprogs-plus-1.0.0/libntfs/reparse.c000066400000000000000000001104321507404161300177660ustar00rootroot00000000000000/** * reparse.c - Processing of reparse points * * This module is part of ntfs-3g library * * Copyright (c) 2008-2021 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef MAJOR_IN_MKDEV #include #endif #ifdef MAJOR_IN_SYSMACROS #include #endif #include "compat.h" #include "types.h" #include "debug.h" #include "layout.h" #include "attrib.h" #include "inode.h" #include "dir.h" #include "volume.h" #include "mft.h" #include "index.h" #include "lcnalloc.h" #include "logging.h" #include "misc.h" #include "reparse.h" #include "xattrs.h" #include "ea.h" struct MOUNT_POINT_REPARSE_DATA { /* reparse data for junctions */ le16 subst_name_offset; le16 subst_name_length; le16 print_name_offset; le16 print_name_length; char path_buffer[0]; /* above data assume this is char array */ } ; struct SYMLINK_REPARSE_DATA { /* reparse data for symlinks */ le16 subst_name_offset; le16 subst_name_length; le16 print_name_offset; le16 print_name_length; le32 flags; /* 1 for full target, otherwise 0 */ char path_buffer[0]; /* above data assume this is char array */ } ; struct WSL_LINK_REPARSE_DATA { le32 type; char link[0]; } ; struct REPARSE_INDEX { /* index entry in $Extend/$Reparse */ INDEX_ENTRY_HEADER header; REPARSE_INDEX_KEY key; le32 filling; } ; static const ntfschar dir_junction_head[] = { const_cpu_to_le16('\\'), const_cpu_to_le16('?'), const_cpu_to_le16('?'), const_cpu_to_le16('\\') } ; static const ntfschar vol_junction_head[] = { const_cpu_to_le16('\\'), const_cpu_to_le16('?'), const_cpu_to_le16('?'), const_cpu_to_le16('\\'), const_cpu_to_le16('V'), const_cpu_to_le16('o'), const_cpu_to_le16('l'), const_cpu_to_le16('u'), const_cpu_to_le16('m'), const_cpu_to_le16('e'), const_cpu_to_le16('{'), } ; static ntfschar reparse_index_name[] = { const_cpu_to_le16('$'), const_cpu_to_le16('R') }; static const char mappingdir[] = ".NTFS-3G/"; /* * Fix a file name with doubtful case in some directory index * and return the name with the casing used in directory. * * Should only be used to translate paths stored with case insensitivity * (such as directory junctions) when no case conflict is expected. * If there some ambiguity, the name which collates first is returned. * * The name is converted to upper case and searched the usual way. * The collation rules for file names are such that we should get the * first candidate if any. */ static u64 ntfs_fix_file_name(ntfs_inode *dir_ni, ntfschar *uname, int uname_len) { ntfs_volume *vol = dir_ni->vol; ntfs_index_context *icx; u64 mref; le64 lemref; int lkup; int olderrno; int i; u32 cpuchar; INDEX_ENTRY *entry; FILE_NAME_ATTR *found; struct { FILE_NAME_ATTR attr; ntfschar file_name[NTFS_MAX_NAME_LEN + 1]; } find; mref = (u64)-1; /* default return (not found) */ icx = ntfs_index_ctx_get(dir_ni, NTFS_INDEX_I30, 4); if (icx) { if (uname_len > NTFS_MAX_NAME_LEN) uname_len = NTFS_MAX_NAME_LEN; find.attr.file_name_length = uname_len; for (i=0; iupcase_len) && (le16_to_cpu(vol->upcase[cpuchar]) < cpuchar)) find.attr.file_name[i] = vol->upcase[cpuchar]; else find.attr.file_name[i] = uname[i]; } olderrno = errno; lkup = ntfs_index_lookup((char*)&find, uname_len, icx); if (errno == ENOENT) errno = olderrno; /* * We generally only get the first matching candidate, * so we still have to check whether this is a real match */ if (icx->entry && (icx->entry->ie_flags & INDEX_ENTRY_END)) /* get next entry if reaching end of block */ entry = ntfs_index_next(icx->entry, icx); else entry = icx->entry; if (entry) { found = &entry->key.file_name; if (lkup && ntfs_names_are_equal(find.attr.file_name, find.attr.file_name_length, found->file_name, found->file_name_length, IGNORE_CASE, vol->upcase, vol->upcase_len)) lkup = 0; if (!lkup) { /* * name found : * fix original name and return inode */ lemref = entry->indexed_file; mref = le64_to_cpu(lemref); if (NVolCaseSensitive(vol) || !vol->locase) { for (i=0; ifile_name_length; i++) uname[i] = found->file_name[i]; } else { for (i=0; ifile_name_length; i++) uname[i] = vol->locase[le16_to_cpu(found->file_name[i])]; } } } ntfs_index_ctx_put(icx); } return (mref); } /* * Search for a directory junction or a symbolic link * along the target path, with target defined as a full absolute path * * Returns the path translated to a Linux path * or NULL if the path is not valid */ static char *search_absolute(ntfs_volume *vol, ntfschar *path, int count, BOOL isdir) { ntfs_inode *ni; u64 inum; char *target; int start; int len; target = (char*)NULL; /* default return */ ni = ntfs_inode_open(vol, (MFT_REF)FILE_root); if (ni) { start = 0; /* * Examine and translate the path, until we reach either * - the end, * - an unknown item * - a non-directory * - another reparse point, * A reparse point is not dereferenced, it will be * examined later when the translated path is dereferenced, * however the final part of the path will not be adjusted * to correct case. */ do { len = 0; while (((start + len) < count) && (path[start + len] != const_cpu_to_le16('\\'))) len++; inum = ntfs_fix_file_name(ni, &path[start], len); ntfs_inode_close(ni); ni = (ntfs_inode*)NULL; if (inum != (u64)-1) { inum = MREF(inum); ni = ntfs_inode_open(vol, inum); start += len; if (start < count) path[start++] = const_cpu_to_le16('/'); } } while (ni && (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) && !(ni->flags & FILE_ATTR_REPARSE_POINT) && (start < count)); if (ni && ((ni->mrec->flags & MFT_RECORD_IS_DIRECTORY ? isdir : !isdir) || (ni->flags & FILE_ATTR_REPARSE_POINT))) if (ntfs_ucstombs(path, count, &target, 0) < 0) { if (target) ntfs_attr_name_free(&target); } if (ni) ntfs_inode_close(ni); } return (target); } /* * Search for a symbolic link along the target path, * with the target defined as a relative path * * Note : the path used to access the current inode, may be * different from the one implied in the target definition, * when an inode has names in several directories. * * Returns the path translated to a Linux path * or NULL if the path is not valid */ static char *search_relative(ntfs_inode *ni, ntfschar *path, int count) { char *target = (char*)NULL; ntfs_inode *curni; ntfs_inode *newni; u64 inum; int pos; int lth; BOOL ok; BOOL morelinks; int max = 32; /* safety */ pos = 0; ok = TRUE; morelinks = FALSE; curni = ntfs_dir_parent_inode(ni); /* * Examine and translate the path, until we reach either * - the end, * - an unknown item * - a non-directory * - another reparse point, * A reparse point is not dereferenced, it will be * examined later when the translated path is dereferenced, * however the final part of the path will not be adjusted * to correct case. */ while (curni && ok && !morelinks && (pos < (count - 1)) && --max) { if ((count >= (pos + 2)) && (path[pos] == const_cpu_to_le16('.')) && (path[pos+1] == const_cpu_to_le16('\\'))) { path[pos+1] = const_cpu_to_le16('/'); pos += 2; } else { if ((count >= (pos + 3)) && (path[pos] == const_cpu_to_le16('.')) &&(path[pos+1] == const_cpu_to_le16('.')) && (path[pos+2] == const_cpu_to_le16('\\'))) { path[pos+2] = const_cpu_to_le16('/'); pos += 3; newni = ntfs_dir_parent_inode(curni); if (curni != ni) ntfs_inode_close(curni); curni = newni; if (!curni) ok = FALSE; } else { lth = 0; while (((pos + lth) < count) && (path[pos + lth] != const_cpu_to_le16('\\'))) lth++; if (lth > 0) inum = ntfs_fix_file_name(curni,&path[pos],lth); else inum = (u64)-1; if (!lth || ((curni != ni) && ntfs_inode_close(curni)) || (inum == (u64)-1)) ok = FALSE; else { curni = ntfs_inode_open(ni->vol, MREF(inum)); if (!curni) ok = FALSE; else { if (curni->flags & FILE_ATTR_REPARSE_POINT) morelinks = TRUE; if (ok && ((pos + lth) < count)) { path[pos + lth] = const_cpu_to_le16('/'); pos += lth + 1; if (morelinks && ntfs_inode_close(curni)) ok = FALSE; } else { pos += lth; if (!morelinks && (ni->mrec->flags ^ curni->mrec->flags) & MFT_RECORD_IS_DIRECTORY) ok = FALSE; if (ntfs_inode_close(curni)) ok = FALSE; } } } } } } if (ok && (ntfs_ucstombs(path, count, &target, 0) < 0)) ntfs_attr_name_free(&target); return (target); } /* * Check whether a drive letter has been defined in .NTFS-3G * * Returns 1 if found, * 0 if not found, * -1 if there was an error (described by errno) */ static int ntfs_drive_letter(ntfs_volume *vol, ntfschar letter) { char defines[NTFS_MAX_NAME_LEN + 5]; char *drive; int ret; int sz; int olderrno; ntfs_inode *ni; ret = -1; drive = (char*)NULL; sz = ntfs_ucstombs(&letter, 1, &drive, 0); if (sz > 0) { strcpy(defines,mappingdir); if ((*drive >= 'a') && (*drive <= 'z')) *drive += 'A' - 'a'; strcat(defines,drive); strcat(defines,":"); olderrno = errno; ni = ntfs_pathname_to_inode(vol, NULL, defines); if (ni && !ntfs_inode_close(ni)) ret = 1; else if (errno == ENOENT) { ret = 0; /* avoid errno pollution */ errno = olderrno; } } if (drive) ntfs_attr_name_free(&drive); return (ret); } /* * Check whether reparse data describes a valid wsl special file * which is either a socket, a fifo, or a character or block device * * Return zero if valid, otherwise returns a negative error code */ int ntfs_reparse_check_wsl(ntfs_inode *ni, const REPARSE_POINT *reparse) { int res; res = -EOPNOTSUPP; switch (reparse->reparse_tag) { case IO_REPARSE_TAG_AF_UNIX : case IO_REPARSE_TAG_LX_FIFO : case IO_REPARSE_TAG_LX_CHR : case IO_REPARSE_TAG_LX_BLK : if (!reparse->reparse_data_length && (ni->flags & FILE_ATTRIBUTE_RECALL_ON_OPEN)) res = 0; break; default : break; } if (res) errno = EOPNOTSUPP; return (res); } /* * Do some sanity checks on reparse data * * Microsoft reparse points have an 8-byte header whereas * non-Microsoft reparse points have a 24-byte header. In each case, * 'reparse_data_length' must equal the number of non-header bytes. * * If the reparse data looks like a junction point or symbolic * link, more checks can be done. * */ static BOOL valid_reparse_data(ntfs_inode *ni, const REPARSE_POINT *reparse_attr, size_t size) { BOOL ok; unsigned int offs; unsigned int lth; const struct MOUNT_POINT_REPARSE_DATA *mount_point_data; const struct SYMLINK_REPARSE_DATA *symlink_data; const struct WSL_LINK_REPARSE_DATA *wsl_reparse_data; ok = ni && reparse_attr && (size >= sizeof(REPARSE_POINT)) && (reparse_attr->reparse_tag != IO_REPARSE_TAG_RESERVED_ZERO) && (((size_t)le16_to_cpu(reparse_attr->reparse_data_length) + sizeof(REPARSE_POINT) + ((reparse_attr->reparse_tag & IO_REPARSE_TAG_IS_MICROSOFT) ? 0 : sizeof(GUID))) == size); if (ok) { switch (reparse_attr->reparse_tag) { case IO_REPARSE_TAG_MOUNT_POINT : if (size < sizeof(REPARSE_POINT) + sizeof(struct MOUNT_POINT_REPARSE_DATA)) { ok = FALSE; break; } mount_point_data = (const struct MOUNT_POINT_REPARSE_DATA*) reparse_attr->reparse_data; offs = le16_to_cpu(mount_point_data->subst_name_offset); lth = le16_to_cpu(mount_point_data->subst_name_length); /* consistency checks */ if (!(ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) || ((size_t)((sizeof(REPARSE_POINT) + sizeof(struct MOUNT_POINT_REPARSE_DATA) + offs + lth)) > size)) ok = FALSE; break; case IO_REPARSE_TAG_SYMLINK : if (size < sizeof(REPARSE_POINT) + sizeof(struct SYMLINK_REPARSE_DATA)) { ok = FALSE; break; } symlink_data = (const struct SYMLINK_REPARSE_DATA*) reparse_attr->reparse_data; offs = le16_to_cpu(symlink_data->subst_name_offset); lth = le16_to_cpu(symlink_data->subst_name_length); if ((size_t)((sizeof(REPARSE_POINT) + sizeof(struct SYMLINK_REPARSE_DATA) + offs + lth)) > size) ok = FALSE; break; case IO_REPARSE_TAG_LX_SYMLINK : wsl_reparse_data = (const struct WSL_LINK_REPARSE_DATA*) reparse_attr->reparse_data; if ((le16_to_cpu(reparse_attr->reparse_data_length) <= sizeof(wsl_reparse_data->type)) || (wsl_reparse_data->type != const_cpu_to_le32(2))) ok = FALSE; break; case IO_REPARSE_TAG_AF_UNIX : case IO_REPARSE_TAG_LX_FIFO : case IO_REPARSE_TAG_LX_CHR : case IO_REPARSE_TAG_LX_BLK : if (reparse_attr->reparse_data_length || !(ni->flags & FILE_ATTRIBUTE_RECALL_ON_OPEN)) ok = FALSE; break; default : break; } } if (!ok) errno = EINVAL; return (ok); } /* * Check and translate the target of a junction point or * a full absolute symbolic link. * * A full target definition begins with "\??\" or "\\?\" * * The fully defined target is redefined as a relative link, * - either to the target if found on the same device. * - or into the /.NTFS-3G directory for the user to define * In the first situation, the target is translated to case-sensitive path. * * returns the target converted to a relative symlink * or NULL if there were some problem, as described by errno */ static char *ntfs_get_fulllink(ntfs_volume *vol, ntfschar *junction, int count, const char *mnt_point, BOOL isdir) { char *target; char *fulltarget; int sz; char *q; enum { DIR_JUNCTION, VOL_JUNCTION, NO_JUNCTION } kind; target = (char*)NULL; fulltarget = (char*)NULL; /* * For a valid directory junction we want \??\x:\ * where \ is an individual char and x a non-null char */ if ((count >= 7) && !memcmp(junction,dir_junction_head,8) && junction[4] && (junction[5] == const_cpu_to_le16(':')) && (junction[6] == const_cpu_to_le16('\\'))) kind = DIR_JUNCTION; else /* * For a valid volume junction we want \\?\Volume{ * and a final \ (where \ is an individual char) */ if ((count >= 12) && !memcmp(junction,vol_junction_head,22) && (junction[count-1] == const_cpu_to_le16('\\'))) kind = VOL_JUNCTION; else kind = NO_JUNCTION; /* * Directory junction with an explicit path and * no specific definition for the drive letter : * try to interpret as a target on the same volume */ if ((kind == DIR_JUNCTION) && (count >= 7) && junction[7] && !ntfs_drive_letter(vol, junction[4])) { target = search_absolute(vol,&junction[7],count - 7, isdir); if (target) { fulltarget = (char*)ntfs_malloc(strlen(mnt_point) + strlen(target) + 2); if (fulltarget) { strcpy(fulltarget,mnt_point); strcat(fulltarget,"/"); strcat(fulltarget,target); } ntfs_attr_name_free(&target); } } /* * Volume junctions or directory junctions with * target not found on current volume : * link to /.NTFS-3G/target which the user can * define as a symbolic link to the real target */ if (((kind == DIR_JUNCTION) && !fulltarget) || (kind == VOL_JUNCTION)) { sz = ntfs_ucstombs(&junction[4], (kind == VOL_JUNCTION ? count - 5 : count - 4), &target, 0); if ((sz > 0) && target) { /* reverse slashes */ for (q=target; *q; q++) if (*q == '\\') *q = '/'; /* force uppercase drive letter */ if ((target[1] == ':') && (target[0] >= 'a') && (target[0] <= 'z')) target[0] += 'A' - 'a'; fulltarget = (char*)ntfs_malloc(strlen(mnt_point) + sizeof(mappingdir) + strlen(target) + 1); if (fulltarget) { strcpy(fulltarget,mnt_point); strcat(fulltarget,"/"); strcat(fulltarget,mappingdir); strcat(fulltarget,target); } } if (target) ntfs_attr_name_free(&target); } return (fulltarget); } /* * Check and translate the target of an absolute symbolic link. * * An absolute target definition begins with "\" or "x:\" * * The absolute target is redefined as a relative link, * - either to the target if found on the same device. * - or into the /.NTFS-3G directory for the user to define * In the first situation, the target is translated to case-sensitive path. * * returns the target converted to a relative symlink * or NULL if there were some problem, as described by errno */ char *ntfs_get_abslink(ntfs_volume *vol, ntfschar *junction, int count, const char *mnt_point __attribute__((unused)), BOOL isdir) { char *target; char *fulltarget; int sz; char *q; enum { FULL_PATH, ABS_PATH, REJECTED_PATH } kind; target = (char*)NULL; fulltarget = (char*)NULL; /* * For a full valid path we want x:\ * where \ is an individual char and x a non-null char */ if ((count >= 3) && junction[0] && (junction[1] == const_cpu_to_le16(':')) && (junction[2] == const_cpu_to_le16('\\'))) kind = FULL_PATH; else /* * For an absolute path we want an initial \ */ if ((count >= 0) && (junction[0] == const_cpu_to_le16('\\'))) kind = ABS_PATH; else kind = REJECTED_PATH; /* * Full path, with a drive letter and * no specific definition for the drive letter : * try to interpret as a target on the same volume. * Do the same for an abs path with no drive letter. */ if (((kind == FULL_PATH) && (count >= 3) && junction[3] && !ntfs_drive_letter(vol, junction[0])) || (kind == ABS_PATH)) { if (kind == ABS_PATH) target = search_absolute(vol, &junction[1], count - 1, isdir); else target = search_absolute(vol, &junction[3], count - 3, isdir); if (target) { fulltarget = (char*)ntfs_malloc( strlen(vol->abs_mnt_point) + strlen(target) + 2); if (fulltarget) { strcpy(fulltarget,vol->abs_mnt_point); strcat(fulltarget,"/"); strcat(fulltarget,target); } ntfs_attr_name_free(&target); } } /* * full path with target not found on current volume : * link to /.NTFS-3G/target which the user can * define as a symbolic link to the real target */ if ((kind == FULL_PATH) && !fulltarget) { sz = ntfs_ucstombs(&junction[0], count,&target, 0); if ((sz > 0) && target) { /* reverse slashes */ for (q=target; *q; q++) if (*q == '\\') *q = '/'; /* force uppercase drive letter */ if ((target[1] == ':') && (target[0] >= 'a') && (target[0] <= 'z')) target[0] += 'A' - 'a'; fulltarget = (char*)ntfs_malloc( strlen(vol->abs_mnt_point) + sizeof(mappingdir) + strlen(target) + 1); if (fulltarget) { strcpy(fulltarget,vol->abs_mnt_point); strcat(fulltarget,"/"); strcat(fulltarget,mappingdir); strcat(fulltarget,target); } } if (target) ntfs_attr_name_free(&target); } return (fulltarget); } /* * Check and translate the target of a relative symbolic link. * * A relative target definition does not begin with "\" * * The original definition of relative target is kept, it is just * translated to a case-sensitive path. * * returns the target converted to a relative symlink * or NULL if there were some problem, as described by errno */ static char *ntfs_get_rellink(ntfs_inode *ni, ntfschar *junction, int count) { char *target; target = search_relative(ni,junction,count); return (target); } /* * Get the target for a junction point or symbolic link * Should only be called for files or directories with reparse data * * returns the target converted to a relative path, or NULL * if some error occurred, as described by errno * errno is EOPNOTSUPP if the reparse point is not a valid * symbolic link or directory junction */ char *ntfs_make_symlink(ntfs_inode *ni, const char *mnt_point) { s64 attr_size = 0; char *target; unsigned int offs; unsigned int lth; ntfs_volume *vol; REPARSE_POINT *reparse_attr; struct MOUNT_POINT_REPARSE_DATA *mount_point_data; struct SYMLINK_REPARSE_DATA *symlink_data; struct WSL_LINK_REPARSE_DATA *wsl_link_data; enum { FULL_TARGET, ABS_TARGET, REL_TARGET } kind; ntfschar *p; BOOL bad; BOOL isdir; target = (char*)NULL; bad = TRUE; isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); vol = ni->vol; reparse_attr = (REPARSE_POINT*)ntfs_attr_readall(ni, AT_REPARSE_POINT,(ntfschar*)NULL, 0, &attr_size); if (reparse_attr && attr_size && valid_reparse_data(ni, reparse_attr, attr_size)) { switch (reparse_attr->reparse_tag) { case IO_REPARSE_TAG_MOUNT_POINT : mount_point_data = (struct MOUNT_POINT_REPARSE_DATA*) reparse_attr->reparse_data; offs = le16_to_cpu(mount_point_data->subst_name_offset); lth = le16_to_cpu(mount_point_data->subst_name_length); /* reparse data consistency has been checked */ target = ntfs_get_fulllink(vol, (ntfschar*)&mount_point_data->path_buffer[offs], lth/2, mnt_point, isdir); if (target) bad = FALSE; break; case IO_REPARSE_TAG_SYMLINK : symlink_data = (struct SYMLINK_REPARSE_DATA*) reparse_attr->reparse_data; offs = le16_to_cpu(symlink_data->subst_name_offset); lth = le16_to_cpu(symlink_data->subst_name_length); p = (ntfschar*)&symlink_data->path_buffer[offs]; /* * Predetermine the kind of target, * the called function has to make a full check */ if (*p++ == const_cpu_to_le16('\\')) { if ((*p == const_cpu_to_le16('?')) || (*p == const_cpu_to_le16('\\'))) kind = FULL_TARGET; else kind = ABS_TARGET; } else if (*p == const_cpu_to_le16(':')) kind = ABS_TARGET; else kind = REL_TARGET; p--; /* reparse data consistency has been checked */ switch (kind) { case FULL_TARGET : if (!(symlink_data->flags & const_cpu_to_le32(1))) { target = ntfs_get_fulllink(vol, p, lth/2, mnt_point, isdir); if (target) bad = FALSE; } break; case ABS_TARGET : if (symlink_data->flags & const_cpu_to_le32(1)) { target = ntfs_get_abslink(vol, p, lth/2, mnt_point, isdir); if (target) bad = FALSE; } break; case REL_TARGET : if (symlink_data->flags & const_cpu_to_le32(1)) { target = ntfs_get_rellink(ni, p, lth/2); if (target) bad = FALSE; } break; } break; case IO_REPARSE_TAG_LX_SYMLINK : wsl_link_data = (struct WSL_LINK_REPARSE_DATA*) reparse_attr->reparse_data; if (wsl_link_data->type == const_cpu_to_le32(2)) { lth = le16_to_cpu( reparse_attr->reparse_data_length) - sizeof(wsl_link_data->type); target = (char*)ntfs_malloc(lth + 1); if (target) { memcpy(target, wsl_link_data->link, lth); target[lth] = 0; bad = FALSE; } } break; } free(reparse_attr); } if (bad) errno = EOPNOTSUPP; return (target); } /* * Check whether a reparse point looks like a junction point * or a symbolic link. * Should only be called for files or directories with reparse data * * The validity of the target is not checked. */ BOOL ntfs_possible_symlink(ntfs_inode *ni) { s64 attr_size = 0; REPARSE_POINT *reparse_attr; BOOL possible; possible = FALSE; reparse_attr = (REPARSE_POINT*)ntfs_attr_readall(ni, AT_REPARSE_POINT,(ntfschar*)NULL, 0, &attr_size); if (reparse_attr && attr_size) { switch (reparse_attr->reparse_tag) { case IO_REPARSE_TAG_MOUNT_POINT : case IO_REPARSE_TAG_SYMLINK : case IO_REPARSE_TAG_LX_SYMLINK : possible = TRUE; default : ; } free(reparse_attr); } return (possible); } /* * Set the index for new reparse data * * Returns 0 if success * -1 if failure, explained by errno */ static int set_reparse_index(ntfs_inode *ni, ntfs_index_context *xr, le32 reparse_tag) { struct REPARSE_INDEX indx; u64 file_id_cpu; le64 file_id; le16 seqn; seqn = ni->mrec->sequence_number; file_id_cpu = MK_MREF(ni->mft_no,le16_to_cpu(seqn)); file_id = cpu_to_le64(file_id_cpu); indx.header.data_offset = const_cpu_to_le16( sizeof(INDEX_ENTRY_HEADER) + sizeof(REPARSE_INDEX_KEY)); indx.header.data_length = const_cpu_to_le16(0); indx.header.reservedV = const_cpu_to_le32(0); indx.header.length = const_cpu_to_le16( sizeof(struct REPARSE_INDEX)); indx.header.key_length = const_cpu_to_le16( sizeof(REPARSE_INDEX_KEY)); indx.header.flags = const_cpu_to_le16(0); indx.header.reserved = const_cpu_to_le16(0); indx.key.reparse_tag = reparse_tag; /* danger on processors which require proper alignment ! */ memcpy(&indx.key.file_id, &file_id, 8); indx.filling = const_cpu_to_le32(0); ntfs_index_ctx_reinit(xr); return (ntfs_ie_add(xr,(INDEX_ENTRY*)&indx)); } /* * Remove a reparse data index entry if attribute present * * Returns the size of existing reparse data * (the existing reparse tag is returned) * -1 if failure, explained by errno */ static int remove_reparse_index(ntfs_attr *na, ntfs_index_context *xr, le32 *preparse_tag) { REPARSE_INDEX_KEY key; u64 file_id_cpu; le64 file_id; s64 size; le16 seqn; int ret; ret = na->data_size; if (ret) { /* read the existing reparse_tag */ size = ntfs_attr_pread(na, 0, 4, preparse_tag); if (size == 4) { seqn = na->ni->mrec->sequence_number; file_id_cpu = MK_MREF(na->ni->mft_no,le16_to_cpu(seqn)); file_id = cpu_to_le64(file_id_cpu); key.reparse_tag = *preparse_tag; /* danger on processors which require proper alignment ! */ memcpy(&key.file_id, &file_id, 8); if (!ntfs_index_lookup(&key, sizeof(REPARSE_INDEX_KEY), xr) && ntfs_index_rm(xr)) ret = -1; } else { ret = -1; errno = ENODATA; } } return (ret); } /* * Open the $Extend/$Reparse file and its index * * Return the index context if opened * or NULL if an error occurred (errno tells why) * * The index has to be freed and inode closed when not needed any more. */ static ntfs_index_context *open_reparse_index(ntfs_volume *vol) { u64 inum; ntfs_inode *ni; ntfs_inode *dir_ni; ntfs_index_context *xr; /* do not use path_name_to inode - could reopen root */ dir_ni = ntfs_inode_open(vol, FILE_Extend); ni = (ntfs_inode*)NULL; if (dir_ni) { inum = ntfs_inode_lookup_by_mbsname(dir_ni,"$Reparse"); if (inum != (u64)-1) ni = ntfs_inode_open(vol, inum); ntfs_inode_close(dir_ni); } if (ni) { xr = ntfs_index_ctx_get(ni, reparse_index_name, 2); if (!xr) { ntfs_inode_close(ni); } } else xr = (ntfs_index_context*)NULL; return (xr); } /* * Update the reparse data and index * * The reparse data attribute should have been created, and * an existing index is expected if there is an existing value. * * Returns 0 if success * -1 if failure, explained by errno * If could not remove the existing index, nothing is done, * If could not write the new data, no index entry is inserted * If failed to insert the index, data is removed */ static int update_reparse_data(ntfs_inode *ni, ntfs_index_context *xr, const char *value, size_t size) { int res; int written; int oldsize; ntfs_attr *na; le32 reparse_tag; res = 0; na = ntfs_attr_open(ni, AT_REPARSE_POINT, AT_UNNAMED, 0); if (na) { /* remove the existing reparse data */ oldsize = remove_reparse_index(na,xr,&reparse_tag); if (oldsize < 0) res = -1; else { /* resize attribute */ res = ntfs_attr_truncate(na, (s64)size); /* overwrite value if any */ if (!res && value) { written = (int)ntfs_attr_pwrite(na, (s64)0, (s64)size, value); if (written != (s64)size) { ntfs_log_error("Failed to update " "reparse data\n"); errno = EIO; res = -1; } } if (!res && set_reparse_index(ni,xr, ((const REPARSE_POINT*)value)->reparse_tag) && (oldsize > 0)) { /* * If cannot index, try to remove the reparse * data and log the error. There will be an * inconsistency if removal fails. */ ntfs_attr_rm(na); ntfs_log_error("Failed to index reparse data." " Possible corruption.\n"); } } ntfs_attr_close(na); NInoSetDirty(ni); } else res = -1; return (res); } /* * Delete a reparse index entry * * Returns 0 if success * -1 if failure, explained by errno */ int ntfs_delete_reparse_index(ntfs_inode *ni) { ntfs_index_context *xr; ntfs_inode *xrni; ntfs_attr *na; le32 reparse_tag; int res; res = 0; na = ntfs_attr_open(ni, AT_REPARSE_POINT, AT_UNNAMED, 0); if (na) { /* * read the existing reparse data (the tag is enough) * and un-index it */ xr = open_reparse_index(ni->vol); if (xr) { if (remove_reparse_index(na,xr,&reparse_tag) < 0) res = -1; xrni = xr->ni; ntfs_index_entry_mark_dirty(xr); NInoSetDirty(xrni); ntfs_index_ctx_put(xr); ntfs_inode_close(xrni); } ntfs_attr_close(na); } return (res); } /* * Get the ntfs reparse data into an extended attribute * * Returns the reparse data size * and the buffer is updated if it is long enough */ int ntfs_get_ntfs_reparse_data(ntfs_inode *ni, char *value, size_t size) { REPARSE_POINT *reparse_attr; s64 attr_size; attr_size = 0; /* default to no data and no error */ if (ni) { if (ni->flags & FILE_ATTR_REPARSE_POINT) { reparse_attr = (REPARSE_POINT*)ntfs_attr_readall(ni, AT_REPARSE_POINT,(ntfschar*)NULL, 0, &attr_size); if (reparse_attr) { if (attr_size <= (s64)size) { if (value) memcpy(value,reparse_attr, attr_size); else errno = EINVAL; } free(reparse_attr); } } else errno = ENODATA; } return (attr_size ? (int)attr_size : -errno); } /* * Set the reparse data from an extended attribute * * Warning : the new data is not checked * * Returns 0, or -1 if there is a problem */ int ntfs_set_ntfs_reparse_data(ntfs_inode *ni, const char *value, size_t size, int flags) { int res; u8 dummy; ntfs_inode *xrni; ntfs_index_context *xr; res = 0; /* * reparse data compatibily with EA is not checked * any more, it is required by Windows 10, but may * lead to problems with earlier versions. */ if (ni && valid_reparse_data(ni, (const REPARSE_POINT*)value, size)) { xr = open_reparse_index(ni->vol); if (xr) { if (!ntfs_attr_exist(ni,AT_REPARSE_POINT, AT_UNNAMED,0)) { if (!(flags & XATTR_REPLACE)) { /* * no reparse data attribute : add one, * apparently, this does not feed the new value in * Note : NTFS version must be >= 3 */ if (ni->vol->major_ver >= 3) { res = ntfs_attr_add(ni, AT_REPARSE_POINT, AT_UNNAMED,0,&dummy, (s64)0); if (!res) { ni->flags |= FILE_ATTR_REPARSE_POINT; NInoFileNameSetDirty(ni); } NInoSetDirty(ni); } else { errno = EOPNOTSUPP; res = -1; } } else { errno = ENODATA; res = -1; } } else { if (flags & XATTR_CREATE) { errno = EEXIST; res = -1; } } if (!res) { /* update value and index */ res = update_reparse_data(ni,xr,value,size); } xrni = xr->ni; ntfs_index_entry_mark_dirty(xr); NInoSetDirty(xrni); ntfs_index_ctx_put(xr); ntfs_inode_close(xrni); } else { res = -1; } } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } /* * Remove the reparse data * * Returns 0, or -1 if there is a problem */ int ntfs_remove_ntfs_reparse_data(ntfs_inode *ni) { int res; int olderrno; ntfs_attr *na; ntfs_inode *xrni; ntfs_index_context *xr; le32 reparse_tag; res = 0; if (ni) { /* * open and delete the reparse data */ na = ntfs_attr_open(ni, AT_REPARSE_POINT, AT_UNNAMED,0); if (na) { /* first remove index (reparse data needed) */ xr = open_reparse_index(ni->vol); if (xr) { if (remove_reparse_index(na,xr, &reparse_tag) < 0) { res = -1; } else { /* now remove attribute */ res = ntfs_attr_rm(na); if (!res) { ni->flags &= ~FILE_ATTR_REPARSE_POINT; NInoFileNameSetDirty(ni); } else { /* * If we could not remove the * attribute, try to restore the * index and log the error. There * will be an inconsistency if * the reindexing fails. */ set_reparse_index(ni, xr, reparse_tag); ntfs_log_error( "Failed to remove reparse data." " Possible corruption.\n"); } } xrni = xr->ni; ntfs_index_entry_mark_dirty(xr); NInoSetDirty(xrni); ntfs_index_ctx_put(xr); ntfs_inode_close(xrni); } olderrno = errno; ntfs_attr_close(na); /* avoid errno pollution */ if (errno == ENOENT) errno = olderrno; } else { errno = ENODATA; res = -1; } NInoSetDirty(ni); } else { errno = EINVAL; res = -1; } return (res ? -1 : 0); } /* * Set reparse data for a WSL type symlink */ int ntfs_reparse_set_wsl_symlink(ntfs_inode *ni, const ntfschar *target, int target_len) { int res; int len; int reparse_len; char *utarget; REPARSE_POINT *reparse; struct WSL_LINK_REPARSE_DATA *data; res = -1; utarget = (char*)NULL; len = ntfs_ucstombs(target, target_len, &utarget, 0); if (len > 0) { reparse_len = sizeof(REPARSE_POINT) + sizeof(data->type) + len; reparse = (REPARSE_POINT*)malloc(reparse_len); if (reparse) { data = (struct WSL_LINK_REPARSE_DATA*) reparse->reparse_data; reparse->reparse_tag = IO_REPARSE_TAG_LX_SYMLINK; reparse->reparse_data_length = cpu_to_le16(sizeof(data->type) + len); reparse->reserved = const_cpu_to_le16(0); data->type = const_cpu_to_le32(2); memcpy(data->link, utarget, len); res = ntfs_set_ntfs_reparse_data(ni, (char*)reparse, reparse_len, 0); free(reparse); } } ntfs_attr_name_free(&utarget); return (res); } /* * Set reparse data for a WSL special file other than a symlink * (socket, fifo, character or block device) */ int ntfs_reparse_set_wsl_not_symlink(ntfs_inode *ni, mode_t mode) { int res; int len; int reparse_len; le32 reparse_tag; REPARSE_POINT *reparse; res = -1; len = 0; switch (mode) { case S_IFSOCK : reparse_tag = IO_REPARSE_TAG_AF_UNIX; break; case S_IFIFO : reparse_tag = IO_REPARSE_TAG_LX_FIFO; break; case S_IFCHR : reparse_tag = IO_REPARSE_TAG_LX_CHR; break; case S_IFBLK : reparse_tag = IO_REPARSE_TAG_LX_BLK; break; default : len = -1; errno = EOPNOTSUPP; break; } if (len >= 0) { reparse_len = sizeof(REPARSE_POINT) + len; reparse = (REPARSE_POINT*)malloc(reparse_len); if (reparse) { reparse->reparse_tag = reparse_tag; reparse->reparse_data_length = cpu_to_le16(len); reparse->reserved = const_cpu_to_le16(0); res = ntfs_set_ntfs_reparse_data(ni, (char*)reparse, reparse_len, 0); free(reparse); } } return (res); } /* * Get the reparse data into a buffer * * Returns the buffer if the reparse data exists and is valid * NULL otherwise (with errno set according to the cause). * When a buffer is returned, it has to be freed by caller. */ REPARSE_POINT *ntfs_get_reparse_point(ntfs_inode *ni) { s64 attr_size = 0; REPARSE_POINT *reparse_attr; reparse_attr = (REPARSE_POINT*)NULL; if (ni) { reparse_attr = (REPARSE_POINT*)ntfs_attr_readall(ni, AT_REPARSE_POINT,(ntfschar*)NULL, 0, &attr_size); if (reparse_attr && !valid_reparse_data(ni, reparse_attr, attr_size)) { free(reparse_attr); reparse_attr = (REPARSE_POINT*)NULL; errno = EINVAL; } } else errno = EINVAL; return (reparse_attr); } ntfsprogs-plus-1.0.0/libntfs/runlist.c000066400000000000000000002164761507404161300200440ustar00rootroot00000000000000/** * runlist.c - Run list handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2002-2005 Anton Altaparmakov * Copyright (c) 2002-2005 Richard Russon * Copyright (c) 2002-2008 Szabolcs Szakacsits * Copyright (c) 2004 Yura Pakhuchiy * Copyright (c) 2007-2022 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "compat.h" #include "types.h" #include "volume.h" #include "layout.h" #include "debug.h" #include "device.h" #include "logging.h" #include "misc.h" /** * ntfs_rl_mm - runlist memmove * @base: * @dst: * @src: * @size: * * Description... * * Returns: */ static void ntfs_rl_mm(runlist_element *base, int dst, int src, int size) { if ((dst != src) && (size > 0)) memmove(base + dst, base + src, size * sizeof(*base)); } /** * ntfs_rl_mc - runlist memory copy * @dstbase: * @dst: * @srcbase: * @src: * @size: * * Description... * * Returns: */ static void ntfs_rl_mc(runlist_element *dstbase, int dst, runlist_element *srcbase, int src, int size) { if (size > 0) memcpy(dstbase + dst, srcbase + src, size * sizeof(*dstbase)); } /** * ntfs_rl_malloc - Malloc memory for runlists */ static runlist_element *ntfs_rl_malloc(int size) { runlist_element *rl; size = (size * sizeof(runlist_element) + 0xfff) & ~0xfff; rl = ntfs_calloc(size); return rl; } /** * ntfs_rl_realloc - Reallocate memory for runlists * @rl: original runlist * @old_size: number of runlist elements in the original runlist @rl * @new_size: number of runlist elements we need space for * * As the runlists grow, more memory will be required. To prevent large * numbers of small reallocations of memory, this function returns a 4kiB block * of memory. * * N.B. If the new allocation doesn't require a different number of 4kiB * blocks in memory, the function will return the original pointer. * * On success, return a pointer to the newly allocated, or recycled, memory. * On error, return NULL with errno set to the error code. */ static runlist_element *ntfs_rl_realloc(runlist_element *rl, int old_size, int new_size) { old_size = (old_size * sizeof(runlist_element) + 0xfff) & ~0xfff; new_size = (new_size * sizeof(runlist_element) + 0xfff) & ~0xfff; if (old_size == new_size) return rl; return realloc(rl, new_size); } /* * Extend a runlist by some entry count * The runlist may have to be reallocated * * Returns the reallocated runlist * or NULL if reallocation was not possible (with errno set) * the runlist is left unchanged if the reallocation fails */ runlist_element *ntfs_rl_extend(ntfs_attr *na, runlist_element *rl, int more_entries) { runlist_element *newrl; int last; int irl; if (na->rl && rl) { irl = (int)(rl - na->rl); last = irl; while (na->rl[last].length) last++; newrl = ntfs_rl_realloc(na->rl,last+1,last+more_entries+1); if (!newrl) { errno = ENOMEM; rl = (runlist_element*)NULL; } else { na->rl = newrl; rl = &newrl[irl]; } } else { ntfs_log_error("Cannot extend unmapped runlist"); errno = EIO; rl = (runlist_element*)NULL; } return (rl); } /** * ntfs_rl_are_mergeable - test if two runlists can be joined together * @dst: original runlist * @src: new runlist to test for mergeability with @dst * * Test if two runlists can be joined together. For this, their VCNs and LCNs * must be adjacent. * * Return: TRUE Success, the runlists can be merged. * FALSE Failure, the runlists cannot be merged. */ static BOOL ntfs_rl_are_mergeable(runlist_element *dst, runlist_element *src) { if (!dst || !src) { ntfs_log_debug("Eeek. ntfs_rl_are_mergeable() invoked with NULL " "pointer!\n"); return FALSE; } /* We can merge unmapped regions even if they are misaligned. */ if ((dst->lcn == LCN_RL_NOT_MAPPED) && (src->lcn == LCN_RL_NOT_MAPPED)) return TRUE; /* If the runs are misaligned, we cannot merge them. */ if ((dst->vcn + dst->length) != src->vcn) return FALSE; /* If both runs are non-sparse and contiguous, we can merge them. */ if ((dst->lcn >= 0) && (src->lcn >= 0) && ((dst->lcn + dst->length) == src->lcn)) return TRUE; /* If we are merging two holes, we can merge them. */ if ((dst->lcn == LCN_HOLE) && (src->lcn == LCN_HOLE)) return TRUE; /* Cannot merge. */ return FALSE; } /** * __ntfs_rl_merge - merge two runlists without testing if they can be merged * @dst: original, destination runlist * @src: new runlist to merge with @dst * * Merge the two runlists, writing into the destination runlist @dst. The * caller must make sure the runlists can be merged or this will corrupt the * destination runlist. */ static void __ntfs_rl_merge(runlist_element *dst, runlist_element *src) { dst->length += src->length; } /** * ntfs_rl_append - append a runlist after a given element * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) * @src: runlist to be inserted into @dst * @ssize: number of elements in @src (excluding end marker) * @loc: append the new runlist @src after this element in @dst * * Append the runlist @src after element @loc in @dst. Merge the right end of * the new runlist, if necessary. Adjust the size of the hole before the * appended runlist. * * On success, return a pointer to the new, combined, runlist. Note, both * runlists @dst and @src are deallocated before returning so you cannot use * the pointers for anything any more. (Strictly speaking the returned runlist * may be the same as @dst but this is irrelevant.) * * On error, return NULL, with errno set to the error code. Both runlists are * left unmodified. */ static runlist_element *ntfs_rl_append(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc) { BOOL right = FALSE; /* Right end of @src needs merging */ int marker; /* End of the inserted runs */ if (!dst || !src) { ntfs_log_debug("Eeek. ntfs_rl_append() invoked with NULL " "pointer!\n"); errno = EINVAL; return NULL; } /* First, check if the right hand end needs merging. */ if ((loc + 1) < dsize) right = ntfs_rl_are_mergeable(src + ssize - 1, dst + loc + 1); /* Space required: @dst size + @src size, less one if we merged. */ dst = ntfs_rl_realloc(dst, dsize, dsize + ssize - right); if (!dst) return NULL; /* * We are guaranteed to succeed from here so can start modifying the * original runlists. */ /* First, merge the right hand end, if necessary. */ if (right) __ntfs_rl_merge(src + ssize - 1, dst + loc + 1); /* marker - First run after the @src runs that have been inserted */ marker = loc + ssize + 1; /* Move the tail of @dst out of the way, then copy in @src. */ ntfs_rl_mm(dst, marker, loc + 1 + right, dsize - loc - 1 - right); ntfs_rl_mc(dst, loc + 1, src, 0, ssize); /* Adjust the size of the preceding hole. */ dst[loc].length = dst[loc + 1].vcn - dst[loc].vcn; /* We may have changed the length of the file, so fix the end marker */ if (dst[marker].lcn == LCN_ENOENT) dst[marker].vcn = dst[marker-1].vcn + dst[marker-1].length; return dst; } /** * ntfs_rl_insert - insert a runlist into another * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) * @src: new runlist to be inserted * @ssize: number of elements in @src (excluding end marker) * @loc: insert the new runlist @src before this element in @dst * * Insert the runlist @src before element @loc in the runlist @dst. Merge the * left end of the new runlist, if necessary. Adjust the size of the hole * after the inserted runlist. * * On success, return a pointer to the new, combined, runlist. Note, both * runlists @dst and @src are deallocated before returning so you cannot use * the pointers for anything any more. (Strictly speaking the returned runlist * may be the same as @dst but this is irrelevant.) * * On error, return NULL, with errno set to the error code. Both runlists are * left unmodified. */ static runlist_element *ntfs_rl_insert(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc) { BOOL left = FALSE; /* Left end of @src needs merging */ BOOL disc = FALSE; /* Discontinuity between @dst and @src */ int marker; /* End of the inserted runs */ if (!dst || !src) { ntfs_log_debug("Eeek. ntfs_rl_insert() invoked with NULL " "pointer!\n"); errno = EINVAL; return NULL; } /* disc => Discontinuity between the end of @dst and the start of @src. * This means we might need to insert a "notmapped" run. */ if (loc == 0) disc = (src[0].vcn > 0); else { s64 merged_length; left = ntfs_rl_are_mergeable(dst + loc - 1, src); merged_length = dst[loc - 1].length; if (left) merged_length += src->length; disc = (src[0].vcn > dst[loc - 1].vcn + merged_length); } /* Space required: @dst size + @src size, less one if we merged, plus * one if there was a discontinuity. */ dst = ntfs_rl_realloc(dst, dsize, dsize + ssize - left + disc); if (!dst) return NULL; /* * We are guaranteed to succeed from here so can start modifying the * original runlist. */ if (left) __ntfs_rl_merge(dst + loc - 1, src); /* * marker - First run after the @src runs that have been inserted * Nominally: marker = @loc + @ssize (location + number of runs in @src) * If "left", then the first run in @src has been merged with one in @dst. * If "disc", then @dst and @src don't meet and we need an extra run to fill the gap. */ marker = loc + ssize - left + disc; /* Move the tail of @dst out of the way, then copy in @src. */ ntfs_rl_mm(dst, marker, loc, dsize - loc); ntfs_rl_mc(dst, loc + disc, src, left, ssize - left); /* Adjust the VCN of the first run after the insertion ... */ dst[marker].vcn = dst[marker - 1].vcn + dst[marker - 1].length; /* ... and the length. */ if (dst[marker].lcn == LCN_HOLE || dst[marker].lcn == LCN_RL_NOT_MAPPED) dst[marker].length = dst[marker + 1].vcn - dst[marker].vcn; /* Writing beyond the end of the file and there's a discontinuity. */ if (disc) { if (loc > 0) { dst[loc].vcn = dst[loc - 1].vcn + dst[loc - 1].length; dst[loc].length = dst[loc + 1].vcn - dst[loc].vcn; } else { dst[loc].vcn = 0; dst[loc].length = dst[loc + 1].vcn; } dst[loc].lcn = LCN_RL_NOT_MAPPED; } return dst; } /** * ntfs_rl_replace - overwrite a runlist element with another runlist * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) * @src: new runlist to be inserted * @ssize: number of elements in @src (excluding end marker) * @loc: index in runlist @dst to overwrite with @src * * Replace the runlist element @dst at @loc with @src. Merge the left and * right ends of the inserted runlist, if necessary. * * On success, return a pointer to the new, combined, runlist. Note, both * runlists @dst and @src are deallocated before returning so you cannot use * the pointers for anything any more. (Strictly speaking the returned runlist * may be the same as @dst but this is irrelevant.) * * On error, return NULL, with errno set to the error code. Both runlists are * left unmodified. */ runlist_element *ntfs_rl_replace(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc) { signed delta; BOOL left = FALSE; /* Left end of @src needs merging */ BOOL right = FALSE; /* Right end of @src needs merging */ int tail; /* Start of tail of @dst */ int marker; /* End of the inserted runs */ if (!dst || !src) { ntfs_log_debug("Eeek. ntfs_rl_replace() invoked with NULL " "pointer!\n"); errno = EINVAL; return NULL; } /* First, see if the left and right ends need merging. */ if ((loc + 1) < dsize) right = ntfs_rl_are_mergeable(src + ssize - 1, dst + loc + 1); if (loc > 0) left = ntfs_rl_are_mergeable(dst + loc - 1, src); /* Allocate some space. We'll need less if the left, right, or both * ends get merged. The -1 accounts for the run being replaced. */ delta = ssize - 1 - left - right; if (delta > 0) { dst = ntfs_rl_realloc(dst, dsize, dsize + delta); if (!dst) return NULL; } /* * We are guaranteed to succeed from here so can start modifying the * original runlists. */ /* First, merge the left and right ends, if necessary. */ if (right) __ntfs_rl_merge(src + ssize - 1, dst + loc + 1); if (left) __ntfs_rl_merge(dst + loc - 1, src); /* * tail - Offset of the tail of @dst * Nominally: @tail = @loc + 1 (location, skipping the replaced run) * If "right", then one of @dst's runs is already merged into @src. */ tail = loc + right + 1; /* * marker - First run after the @src runs that have been inserted * Nominally: @marker = @loc + @ssize (location + number of runs in @src) * If "left", then the first run in @src has been merged with one in @dst. */ marker = loc + ssize - left; /* Move the tail of @dst out of the way, then copy in @src. */ ntfs_rl_mm(dst, marker, tail, dsize - tail); ntfs_rl_mc(dst, loc, src, left, ssize - left); /* We may have changed the length of the file, so fix the end marker */ if (((dsize - tail) > 0) && (dst[marker].lcn == LCN_ENOENT)) dst[marker].vcn = dst[marker - 1].vcn + dst[marker - 1].length; return dst; } /** * ntfs_rl_split - insert a runlist into the centre of a hole * @dst: original runlist to be worked on * @dsize: number of elements in @dst (including end marker) * @src: new runlist to be inserted * @ssize: number of elements in @src (excluding end marker) * @loc: index in runlist @dst at which to split and insert @src * * Split the runlist @dst at @loc into two and insert @new in between the two * fragments. No merging of runlists is necessary. Adjust the size of the * holes either side. * * On success, return a pointer to the new, combined, runlist. Note, both * runlists @dst and @src are deallocated before returning so you cannot use * the pointers for anything any more. (Strictly speaking the returned runlist * may be the same as @dst but this is irrelevant.) * * On error, return NULL, with errno set to the error code. Both runlists are * left unmodified. */ static runlist_element *ntfs_rl_split(runlist_element *dst, int dsize, runlist_element *src, int ssize, int loc) { if (!dst || !src) { ntfs_log_debug("Eeek. ntfs_rl_split() invoked with NULL pointer!\n"); errno = EINVAL; return NULL; } /* Space required: @dst size + @src size + one new hole. */ dst = ntfs_rl_realloc(dst, dsize, dsize + ssize + 1); if (!dst) return dst; /* * We are guaranteed to succeed from here so can start modifying the * original runlists. */ /* Move the tail of @dst out of the way, then copy in @src. */ ntfs_rl_mm(dst, loc + 1 + ssize, loc, dsize - loc); ntfs_rl_mc(dst, loc + 1, src, 0, ssize); /* Adjust the size of the holes either size of @src. */ dst[loc].length = dst[loc+1].vcn - dst[loc].vcn; dst[loc+ssize+1].vcn = dst[loc+ssize].vcn + dst[loc+ssize].length; dst[loc+ssize+1].length = dst[loc+ssize+2].vcn - dst[loc+ssize+1].vcn; return dst; } /** * ntfs_runlists_merge_i - see ntfs_runlists_merge */ static runlist_element *ntfs_runlists_merge_i(runlist_element *drl, runlist_element *srl) { int di, si; /* Current index into @[ds]rl. */ int sstart; /* First index with lcn > LCN_RL_NOT_MAPPED. */ int dins; /* Index into @drl at which to insert @srl. */ int dend, send; /* Last index into @[ds]rl. */ int dfinal, sfinal; /* The last index into @[ds]rl with lcn >= LCN_HOLE. */ int marker = 0; VCN marker_vcn = 0; ntfs_log_debug("dst:\n"); ntfs_debug_runlist_dump(drl); ntfs_log_debug("src:\n"); ntfs_debug_runlist_dump(srl); /* Check for silly calling... */ if (!srl) return drl; /* Check for the case where the first mapping is being done now. */ if (!drl) { drl = srl; /* Complete the source runlist if necessary. */ if (drl[0].vcn) { /* Scan to the end of the source runlist. */ for (dend = 0; drl[dend].length; dend++) ; dend++; drl = ntfs_rl_realloc(drl, dend, dend + 1); if (!drl) return drl; /* Insert start element at the front of the runlist. */ ntfs_rl_mm(drl, 1, 0, dend); drl[0].vcn = 0; drl[0].lcn = LCN_RL_NOT_MAPPED; drl[0].length = drl[1].vcn; } goto finished; } si = di = 0; /* Skip any unmapped start element(s) in the source runlist. */ while (srl[si].length && srl[si].lcn < (LCN)LCN_HOLE) si++; /* Can't have an entirely unmapped source runlist. */ if (!srl[si].length) { errno = EINVAL; ntfs_log_perror("%s: unmapped source runlist", __FUNCTION__); return NULL; } /* Record the starting points. */ sstart = si; /* * Skip forward in @drl until we reach the position where @srl needs to * be inserted. If we reach the end of @drl, @srl just needs to be * appended to @drl. */ for (; drl[di].length; di++) { if (drl[di].vcn + drl[di].length > srl[sstart].vcn) break; } dins = di; /* Sanity check for illegal overlaps. */ if ((drl[di].vcn == srl[si].vcn) && (drl[di].lcn >= 0) && (srl[si].lcn >= 0)) { errno = ERANGE; ntfs_log_perror("Run lists overlap. Cannot merge"); return NULL; } /* Scan to the end of both runlists in order to know their sizes. */ for (send = si; srl[send].length; send++) ; for (dend = di; drl[dend].length; dend++) ; if (srl[send].lcn == (LCN)LCN_ENOENT) marker_vcn = srl[marker = send].vcn; /* Scan to the last element with lcn >= LCN_HOLE. */ for (sfinal = send; sfinal >= 0 && srl[sfinal].lcn < LCN_HOLE; sfinal--) ; for (dfinal = dend; dfinal >= 0 && drl[dfinal].lcn < LCN_HOLE; dfinal--) ; { BOOL start; BOOL finish; int ds = dend + 1; /* Number of elements in drl & srl */ int ss = sfinal - sstart + 1; start = ((drl[dins].lcn < LCN_RL_NOT_MAPPED) || /* End of file */ (drl[dins].vcn == srl[sstart].vcn)); /* Start of hole */ finish = ((drl[dins].lcn >= LCN_RL_NOT_MAPPED) && /* End of file */ ((drl[dins].vcn + drl[dins].length) <= /* End of hole */ (srl[send - 1].vcn + srl[send - 1].length))); /* Or we'll lose an end marker */ if (finish && !drl[dins].length) ss++; if (marker && (drl[dins].vcn + drl[dins].length > srl[send - 1].vcn)) finish = FALSE; ntfs_log_debug("dfinal = %i, dend = %i\n", dfinal, dend); ntfs_log_debug("sstart = %i, sfinal = %i, send = %i\n", sstart, sfinal, send); ntfs_log_debug("start = %i, finish = %i\n", start, finish); ntfs_log_debug("ds = %i, ss = %i, dins = %i\n", ds, ss, dins); if (start) { if (finish) drl = ntfs_rl_replace(drl, ds, srl + sstart, ss, dins); else drl = ntfs_rl_insert(drl, ds, srl + sstart, ss, dins); } else { if (finish) drl = ntfs_rl_append(drl, ds, srl + sstart, ss, dins); else drl = ntfs_rl_split(drl, ds, srl + sstart, ss, dins); } if (!drl) { ntfs_log_perror("Merge failed"); return drl; } free(srl); if (marker) { ntfs_log_debug("Triggering marker code.\n"); for (ds = dend; drl[ds].length; ds++) ; /* We only need to care if @srl ended after @drl. */ if (drl[ds].vcn <= marker_vcn) { int slots = 0; if (drl[ds].vcn == marker_vcn) { ntfs_log_debug("Old marker = %lli, replacing with " "LCN_ENOENT.\n", (long long)drl[ds].lcn); drl[ds].lcn = (LCN)LCN_ENOENT; goto finished; } /* * We need to create an unmapped runlist element in * @drl or extend an existing one before adding the * ENOENT terminator. */ if (drl[ds].lcn == (LCN)LCN_ENOENT) { ds--; slots = 1; } if (drl[ds].lcn != (LCN)LCN_RL_NOT_MAPPED) { /* Add an unmapped runlist element. */ if (!slots) { /* FIXME/TODO: We need to have the * extra memory already! (AIA) */ drl = ntfs_rl_realloc(drl, ds, ds + 2); if (!drl) goto critical_error; slots = 2; } ds++; /* Need to set vcn if it isn't set already. */ if (slots != 1) drl[ds].vcn = drl[ds - 1].vcn + drl[ds - 1].length; drl[ds].lcn = (LCN)LCN_RL_NOT_MAPPED; /* We now used up a slot. */ slots--; } drl[ds].length = marker_vcn - drl[ds].vcn; /* Finally add the ENOENT terminator. */ ds++; if (!slots) { /* FIXME/TODO: We need to have the extra * memory already! (AIA) */ drl = ntfs_rl_realloc(drl, ds, ds + 1); if (!drl) goto critical_error; } drl[ds].vcn = marker_vcn; drl[ds].lcn = (LCN)LCN_ENOENT; drl[ds].length = (s64)0; } } } finished: /* The merge was completed successfully. */ ntfs_log_debug("Merged runlist:\n"); ntfs_debug_runlist_dump(drl); return drl; critical_error: /* Critical error! We cannot afford to fail here. */ ntfs_log_perror("libntfs: Critical error"); ntfs_log_debug("Forcing segmentation fault!\n"); marker_vcn = ((runlist*)NULL)->lcn; return drl; } /** * ntfs_runlists_merge - merge two runlists into one * @drl: original runlist to be worked on * @srl: new runlist to be merged into @drl * * First we sanity check the two runlists @srl and @drl to make sure that they * are sensible and can be merged. The runlist @srl must be either after the * runlist @drl or completely within a hole (or unmapped region) in @drl. * * Merging of runlists is necessary in two cases: * 1. When attribute lists are used and a further extent is being mapped. * 2. When new clusters are allocated to fill a hole or extend a file. * * There are four possible ways @srl can be merged. It can: * - be inserted at the beginning of a hole, * - split the hole in two and be inserted between the two fragments, * - be appended at the end of a hole, or it can * - replace the whole hole. * It can also be appended to the end of the runlist, which is just a variant * of the insert case. * * On success, return a pointer to the new, combined, runlist. Note, both * runlists @drl and @srl are deallocated before returning so you cannot use * the pointers for anything any more. (Strictly speaking the returned runlist * may be the same as @dst but this is irrelevant.) * * On error, return NULL, with errno set to the error code. Both runlists are * left unmodified. The following error codes are defined: * ENOMEM Not enough memory to allocate runlist array. * EINVAL Invalid parameters were passed in. * ERANGE The runlists overlap and cannot be merged. */ runlist_element *ntfs_runlists_merge(runlist_element *drl, runlist_element *srl) { runlist_element *rl; ntfs_log_enter("Entering\n"); rl = ntfs_runlists_merge_i(drl, srl); ntfs_log_leave("\n"); return rl; } /** * ntfs_mapping_pairs_decompress_i - convert mapping pairs array to runlist * @vol: ntfs volume on which the attribute resides * @attr: attribute record whose mapping pairs array to decompress * @old_rl: optional runlist in which to insert @attr's runlist * @part_rl: not used in normal case. when this function return error * on fsck, part_rl will be output variable to preserve previous * 'rl' data. * * Decompress the attribute @attr's mapping pairs array into a runlist. On * success, return the decompressed runlist. * * If @old_rl is not NULL, decompressed runlist is inserted into the * appropriate place in @old_rl and the resultant, combined runlist is * returned. The original @old_rl is deallocated. * * On error, return NULL with errno set to the error code. @old_rl is left * unmodified in that case. * * The following error codes are defined: * ENOMEM Not enough memory to allocate runlist array. * EIO Corrupt runlist. * EINVAL Invalid parameters were passed in. * ERANGE The two runlists overlap. * * FIXME: For now we take the conceptionally simplest approach of creating the * new runlist disregarding the already existing one and then splicing the * two into one, if that is possible (we check for overlap and discard the new * runlist if overlap present before returning NULL, with errno = ERANGE). * * This function also can be called on fsck. * On error on fsck, return NULL with errno and part_rl will preserve generated 'rl' * data before error occurred. */ runlist_element *ntfs_mapping_pairs_decompress_i(const ntfs_volume *vol, const ATTR_RECORD *attr, runlist_element *old_rl, runlist_element **part_rl) { VCN vcn; /* Current vcn. */ LCN lcn; /* Current lcn. */ s64 deltaxcn; /* Change in [vl]cn. */ runlist_element *rl; /* The output runlist. */ runlist_element *temp_rl; /* for free when error occurred */ const u8 *buf; /* Current position in mapping pairs array. */ const u8 *attr_end; /* End of attribute. */ int err, rlsize; /* Size of runlist buffer. */ u16 rlpos; /* Current runlist position in units of runlist_elements. */ u8 b; /* Current byte offset in buf. */ ntfs_log_trace("Entering for attr 0x%x.\n", (unsigned)le32_to_cpu(attr->type)); /* Make sure attr exists and is non-resident. */ if (!attr || !attr->non_resident || sle64_to_cpu(attr->lowest_vcn) < (VCN)0) { errno = EINVAL; return NULL; } /* Start at vcn = lowest_vcn and lcn 0. */ vcn = sle64_to_cpu(attr->lowest_vcn); lcn = 0; /* Get start of the mapping pairs array. */ buf = (const u8*)attr + le16_to_cpu(attr->mapping_pairs_offset); attr_end = (const u8*)attr + le32_to_cpu(attr->length); if (buf < (const u8*)attr || buf > attr_end) { ntfs_log_debug("Corrupt attribute.\n"); errno = EIO; return NULL; } /* Current position in runlist array. */ rlpos = 0; /* Allocate first 4kiB block and set current runlist size to 4kiB. */ rlsize = 0x1000; rl = ntfs_malloc(rlsize); if (!rl) return NULL; /* Insert unmapped starting element if necessary. */ if (vcn) { ntfs_log_debug("Start vcn(%llu) is not zero\n", (unsigned long long)vcn); rl->vcn = (VCN)0; rl->lcn = (LCN)LCN_RL_NOT_MAPPED; rl->length = vcn; rlpos++; } while (buf < attr_end && *buf) { /* * Allocate more memory if needed, including space for the * not-mapped and terminator elements. */ if ((int)((rlpos + 3) * sizeof(*old_rl)) > rlsize) { runlist_element *rl2; rlsize += 0x1000; rl2 = realloc(rl, rlsize); if (!rl2) { int eo = errno; free(rl); errno = eo; return NULL; } rl = rl2; } /* Enter the current vcn into the current runlist element. */ rl[rlpos].vcn = vcn; /* * Get the change in vcn, i.e. the run length in clusters. * Doing it this way ensures that we signextend negative values. * A negative run length doesn't make any sense, but hey, I * didn't make up the NTFS specs and Windows NT4 treats the run * length as a signed value so that's how it is... */ b = *buf & 0xf; if (b) { if (buf + b > attr_end) goto io_error; for (deltaxcn = (s8)buf[b--]; b; b--) deltaxcn = (deltaxcn << 8) + buf[b]; } else { /* The length entry is compulsory. */ ntfs_log_error("Missing length entry in mapping pairs array.\n"); deltaxcn = (s64)-1; } /* * Assume a negative length to indicate data corruption and * hence clean-up and return NULL. */ if (deltaxcn < 0) { ntfs_log_error("Invalid length in mapping pairs array.\n"); goto err_out; } /* * Enter the current run length into the current runlist * element. */ rl[rlpos].length = deltaxcn; /* Increment the current vcn by the current run length. */ vcn += deltaxcn; /* * There might be no lcn change at all, as is the case for * sparse clusters on NTFS 3.0+, in which case we set the lcn * to LCN_HOLE. */ if (!(*buf & 0xf0)) rl[rlpos].lcn = (LCN)LCN_HOLE; else { /* Get the lcn change which really can be negative. */ u8 b2 = *buf & 0xf; if (!b2) { ntfs_log_error("Invalid length in mapping pairs array.\n"); goto err_out; } b = b2 + ((*buf >> 4) & 0xf); if (buf + b > attr_end) goto io_error; for (deltaxcn = (s8)buf[b--]; b > b2; b--) deltaxcn = (deltaxcn << 8) + buf[b]; /* * normally if deltaxcn is zero, it is corrupted. * but deltaxcn can be 0, if it is the first entry of * $Bitmap/$Data cluster run. * Problem: How to distinguish corrupted offset(zero) and * first offset of $Bitmap/$Data cluster run. * now we will check it out of this function (caller). */ if (NVolIsOnFsck(vol)) { if (deltaxcn == 0 && rlpos != 0) { rl[rlpos].length = 0; ntfs_debug_runlist_dump(rl); } } /* Change the current lcn to it's new value. */ lcn += deltaxcn; #ifdef DEBUG /* * On NTFS 1.2-, apparently can have lcn == -1 to * indicate a hole. But we haven't verified ourselves * whether it is really the lcn or the deltaxcn that is * -1. So if either is found give us a message so we * can investigate it further! */ if (vol->major_ver < 3) { if (deltaxcn == (LCN)-1) ntfs_log_debug("lcn delta == -1\n"); if (lcn == (LCN)-1) ntfs_log_debug("lcn == -1\n"); } #endif /* Check lcn is not below -1. */ if (lcn < (LCN)-1) { ntfs_log_error("Invalid LCN < -1 in mapping pairs array.\n"); goto err_out; } /* chkdsk accepts zero-sized runs only for holes */ if ((lcn != (LCN)-1) && !rl[rlpos].length) { ntfs_log_error("Invalid zero-sized data run.\n"); goto err_out; } /* Enter the current lcn into the runlist element. */ rl[rlpos].lcn = lcn; } /* Get to the next runlist element, skipping zero-sized holes */ if (rl[rlpos].length) rlpos++; /* Increment the buffer position to the next mapping pair. */ buf += (*buf & 0xf) + ((*buf >> 4) & 0xf) + 1; } if (buf >= attr_end) goto io_error; /* * If there is a highest_vcn specified, it must be equal to the final * vcn in the runlist - 1, or something has gone badly wrong. */ deltaxcn = sle64_to_cpu(attr->highest_vcn); if (deltaxcn && vcn - 1 != deltaxcn) { mpa_err: ntfs_log_error("Corrupt mapping pairs array in non-resident attribute.\n"); goto err_out; } /* * If this is the base of runlist (if 'lowest_vcn' is 0), then * 'allocated_size' is valid, and we can use it to compute the total * number of clusters across all extents. If the runlist covers all * clusters, then it fits into a single extent and we can terminate * the runlist with LCN_NOENT. Otherwise, we must terminate the runlist * with LCN_RL_NOT_MAPPED and let the caller look for more extents. */ if (!attr->lowest_vcn) { VCN num_clusters; num_clusters = ((sle64_to_cpu(attr->allocated_size) + vol->cluster_size - 1) >> vol->cluster_size_bits); if (num_clusters > vcn) { /* * The runlist doesn't cover all the clusters, so there * must be more extents. */ ntfs_log_debug("More extents to follow; vcn = 0x%llx, " "num_clusters = 0x%llx\n", (long long)vcn, (long long)num_clusters); rl[rlpos].vcn = vcn; vcn += rl[rlpos].length = num_clusters - vcn; rl[rlpos].lcn = (LCN)LCN_RL_NOT_MAPPED; rlpos++; } else if (vcn > num_clusters) { /* * There are more VCNs in the runlist than expected, so * the runlist is corrupt. */ ntfs_log_error("Corrupt attribute. vcn = 0x%llx, " "num_clusters = 0x%llx\n", (long long)vcn, (long long)num_clusters); goto mpa_err; } rl[rlpos].lcn = (LCN)LCN_ENOENT; } else { /* Not the base extent. There may be more extents to follow. */ rl[rlpos].lcn = (LCN)LCN_RL_NOT_MAPPED; ntfs_log_debug("There may be more extents to follow(%llu,%llu,%llu), vcn:%llu\n", (unsigned long long)rl[rlpos].vcn, (unsigned long long)rl[rlpos].lcn, (unsigned long long)rl[rlpos].length, (unsigned long long)vcn); } /* Setup terminating runlist element. */ rl[rlpos].vcn = vcn; rl[rlpos].length = (s64)0; /* If no existing runlist was specified, we are done. */ if (!old_rl || !old_rl[0].length) { ntfs_log_debug("Mapping pairs array successfully decompressed:\n"); ntfs_debug_runlist_dump(rl); if (old_rl) free(old_rl); return rl; } /* Now combine the new and old runlists checking for overlaps. */ if (rl[0].length) { /* * rl freed in ntfs_runlists_merge() when success, * but in case of failure, nothing to free. * should handle this case. */ temp_rl = old_rl; old_rl = ntfs_runlists_merge(old_rl, rl); if (!old_rl) { if (NVolIsOnFsck(vol)) goto err_out_fsck; else free(temp_rl); } } else free(rl); if (old_rl) return old_rl; err = errno; free(rl); ntfs_log_error("Failed to merge runlists.\n"); errno = err; return NULL; io_error: ntfs_log_error("Cluster run list value is corrupted.\n"); err_out: ntfs_log_debug("Failed to make runlist normally(%llu, %llu, %llu) vcn:%llu\n", (unsigned long long)rl[rlpos].lcn, (unsigned long long)rl[rlpos].vcn, (unsigned long long)rl[rlpos].length, (unsigned long long)vcn); if (NVolIsOnFsck(vol)) { /* Setup terminating runlist element */ rl[rlpos].lcn = (LCN)LCN_ENOENT; rl[rlpos].vcn = rlpos ? rl[rlpos - 1].vcn + rl[rlpos - 1].length : 0; rl[rlpos].length = (s64)0; if (old_rl && old_rl[0].length && rl[0].length) { /* * rl freed in ntfs_runlists_merge() when success, * but in case of failure, nothing to free. * should handle this case. */ temp_rl = old_rl; old_rl = ntfs_runlists_merge(old_rl, rl); if (old_rl) rl = old_rl; else { err_out_fsck: free(rl); rl = temp_rl; } } ntfs_debug_runlist_dump(rl); if (part_rl) *part_rl = rl; else if (rl) free(rl); } else if (rl) free(rl); errno = EIO; return NULL; } runlist_element *ntfs_mapping_pairs_decompress(const ntfs_volume *vol, const ATTR_RECORD *attr, runlist_element *old_rl) { runlist_element *rle; ntfs_log_enter("Entering\n"); rle = ntfs_mapping_pairs_decompress_i(vol, attr, old_rl, NULL); ntfs_log_leave("\n"); return rle; } runlist *ntfs_decompress_cluster_run(const ntfs_volume *vol, const ATTR_RECORD *attr, runlist *old_rl, runlist **part_rl) { runlist *rle; ntfs_log_enter("Entering\n"); rle = ntfs_mapping_pairs_decompress_i(vol, attr, old_rl, part_rl); if (!rle) { /* * decompress cluster-run failed, * but part of cluster-run may be preserved in part_rl */ if (!*part_rl) { *part_rl = ntfs_calloc(sizeof(runlist)); if (!*part_rl) return NULL; (*part_rl)->vcn = 0; (*part_rl)->lcn = LCN_ENOENT; (*part_rl)->length = 0; } rle = *part_rl; } ntfs_log_leave("\n"); return rle; } /** * ntfs_rl_vcn_to_lcn - convert a vcn into a lcn given a runlist * @rl: runlist to use for conversion * @vcn: vcn to convert * * Convert the virtual cluster number @vcn of an attribute into a logical * cluster number (lcn) of a device using the runlist @rl to map vcns to their * corresponding lcns. * * Since lcns must be >= 0, we use negative return values with special meaning: * * Return value Meaning / Description * ================================================== * -1 = LCN_HOLE Hole / not allocated on disk. * -2 = LCN_RL_NOT_MAPPED This is part of the runlist which has not been * inserted into the runlist yet. * -3 = LCN_ENOENT There is no such vcn in the attribute. * -4 = LCN_EINVAL Input parameter error. */ LCN ntfs_rl_vcn_to_lcn(const runlist_element *rl, const VCN vcn) { int i; if (vcn < (VCN)0) return (LCN)LCN_EINVAL; /* * If rl is NULL, assume that we have found an unmapped runlist. The * caller can then attempt to map it and fail appropriately if * necessary. */ if (!rl) return (LCN)LCN_RL_NOT_MAPPED; /* Catch out of lower bounds vcn. */ if (vcn < rl[0].vcn) return (LCN)LCN_ENOENT; for (i = 0; rl[i].length; i++) { if (vcn < rl[i+1].vcn) { if (rl[i].lcn >= (LCN)0) return rl[i].lcn + (vcn - rl[i].vcn); return rl[i].lcn; } } /* * The terminator element is setup to the correct value, i.e. one of * LCN_HOLE, LCN_RL_NOT_MAPPED, or LCN_ENOENT. */ if (rl[i].lcn < (LCN)0) return rl[i].lcn; /* Just in case... We could replace this with BUG() some day. */ return (LCN)LCN_ENOENT; } /** * ntfs_rl_find_vcn - find a vcn in a runlist * @rl: runlist to search * @vcn: vcn to find * * Find the virtual cluster number @vcn in the runlist @rl and return the * address of the runlist element containing the @vcn on success. * * Return NULL if @rl is NULL or @vcn is in an unmapped part/out of bounds of * the runlist. * */ runlist_element *ntfs_rl_find_vcn(runlist_element *rl, const VCN vcn) { if (vcn < 0) return NULL; if (!rl || vcn < rl[0].vcn) return NULL; while (rl->length) { if (vcn < rl[1].vcn) { if (rl->lcn >= LCN_HOLE) return rl; return NULL; } rl++; } if (rl->lcn == LCN_ENOENT) return rl; return NULL; } /** * ntfs_rl_pread - gather read from disk * @vol: ntfs volume to read from * @rl: runlist specifying where to read the data from * @pos: byte position within runlist @rl at which to begin the read * @count: number of bytes to read * @b: data buffer into which to read from disk * * This function will read @count bytes from the volume @vol to the data buffer * @b gathering the data as specified by the runlist @rl. The read begins at * offset @pos into the runlist @rl. * * On success, return the number of successfully read bytes. If this number is * lower than @count this means that the read reached end of file or that an * error was encountered during the read so that the read is partial. 0 means * nothing was read (also return 0 when @count is 0). * * On error and nothing has been read, return -1 with errno set appropriately * to the return code of ntfs_pread(), or to EINVAL in case of invalid * arguments. * * NOTE: If we encounter EOF while reading we return EIO because we assume that * the run list must point to valid locations within the ntfs volume. */ s64 ntfs_rl_pread(const ntfs_volume *vol, const runlist_element *rl, const s64 pos, s64 count, void *b) { s64 bytes_read, to_read, ofs, total; int err = EIO; if (!vol || !rl || pos < 0 || count < 0) { errno = EINVAL; ntfs_log_perror("Failed to read runlist [vol: %p rl: %p " "pos: %lld count: %lld]", vol, rl, (long long)pos, (long long)count); return -1; } if (!count) return count; /* Seek in @rl to the run containing @pos. */ for (ofs = 0; rl->length && (ofs + (rl->length << vol->cluster_size_bits) <= pos); rl++) ofs += (rl->length << vol->cluster_size_bits); /* Offset in the run at which to begin reading. */ ofs = pos - ofs; for (total = 0LL; count; rl++, ofs = 0) { if (!rl->length) goto rl_err_out; if (rl->lcn < (LCN)0) { if (rl->lcn != (LCN)LCN_HOLE) goto rl_err_out; /* It is a hole. Just fill buffer @b with zeroes. */ to_read = min(count, (rl->length << vol->cluster_size_bits) - ofs); memset(b, 0, to_read); /* Update counters and proceed with next run. */ total += to_read; count -= to_read; b = (u8*)b + to_read; continue; } /* It is a real lcn, read it from the volume. */ to_read = min(count, (rl->length << vol->cluster_size_bits) - ofs); retry: bytes_read = ntfs_pread(vol->dev, (rl->lcn << vol->cluster_size_bits) + ofs, to_read, b); /* If everything ok, update progress counters and continue. */ if (bytes_read > 0) { total += bytes_read; count -= bytes_read; b = (u8*)b + bytes_read; continue; } /* If the syscall was interrupted, try again. */ if (bytes_read == (s64)-1 && errno == EINTR) goto retry; if (bytes_read == (s64)-1) err = errno; goto rl_err_out; } /* Finally, return the number of bytes read. */ return total; rl_err_out: if (total) return total; errno = err; return -1; } /** * ntfs_rl_pwrite - scatter write to disk * @vol: ntfs volume to write to * @rl: runlist entry specifying where to write the data to * @ofs: offset in file for runlist element indicated in @rl * @pos: byte position from runlist beginning at which to begin the write * @count: number of bytes to write * @b: data buffer to write to disk * * This function will write @count bytes from data buffer @b to the volume @vol * scattering the data as specified by the runlist @rl. The write begins at * offset @pos into the runlist @rl. If a run is sparse then the related buffer * data is ignored which means that the caller must ensure they are consistent. * * On success, return the number of successfully written bytes. If this number * is lower than @count this means that the write has been interrupted in * flight or that an error was encountered during the write so that the write * is partial. 0 means nothing was written (also return 0 when @count is 0). * * On error and nothing has been written, return -1 with errno set * appropriately to the return code of ntfs_pwrite(), or to to EINVAL in case * of invalid arguments. */ s64 ntfs_rl_pwrite(const ntfs_volume *vol, const runlist_element *rl, s64 ofs, const s64 pos, s64 count, void *b) { s64 written, to_write, total = 0; int err = EIO; if (!vol || !rl || pos < 0 || count < 0) { errno = EINVAL; ntfs_log_perror("Failed to write runlist [vol: %p rl: %p " "pos: %lld count: %lld]", vol, rl, (long long)pos, (long long)count); goto errno_set; } if (!count) goto out; /* Seek in @rl to the run containing @pos. */ while (rl->length && (ofs + (rl->length << vol->cluster_size_bits) <= pos)) { ofs += (rl->length << vol->cluster_size_bits); rl++; } /* Offset in the run at which to begin writing. */ ofs = pos - ofs; for (total = 0LL; count; rl++, ofs = 0) { if (!rl->length) goto rl_err_out; if (rl->lcn < (LCN)0) { if (rl->lcn != (LCN)LCN_HOLE) goto rl_err_out; to_write = min(count, (rl->length << vol->cluster_size_bits) - ofs); total += to_write; count -= to_write; b = (u8*)b + to_write; continue; } /* It is a real lcn, write it to the volume. */ to_write = min(count, (rl->length << vol->cluster_size_bits) - ofs); retry: if (!NVolReadOnly(vol)) written = ntfs_pwrite(vol->dev, (rl->lcn << vol->cluster_size_bits) + ofs, to_write, b); else written = to_write; /* If everything ok, update progress counters and continue. */ if (written > 0) { total += written; count -= written; b = (u8*)b + written; continue; } /* If the syscall was interrupted, try again. */ if (written == (s64)-1 && errno == EINTR) goto retry; if (written == (s64)-1) err = errno; goto rl_err_out; } out: return total; rl_err_out: if (total) goto out; errno = err; errno_set: total = -1; goto out; } /** * ntfs_get_nr_significant_bytes - get number of bytes needed to store a number * @n: number for which to get the number of bytes for * * Return the number of bytes required to store @n unambiguously as * a signed number. * * This is used in the context of the mapping pairs array to determine how * many bytes will be needed in the array to store a given logical cluster * number (lcn) or a specific run length. * * Return the number of bytes written. This function cannot fail. */ int ntfs_get_nr_significant_bytes(const s64 n) { u64 l; int i; l = (n < 0 ? ~n : n); i = 1; if (l >= 128) { l >>= 7; do { i++; l >>= 8; } while (l); } return i; } /** * ntfs_get_size_for_mapping_pairs - get bytes needed for mapping pairs array * @vol: ntfs volume (needed for the ntfs version) * @rl: runlist for which to determine the size of the mapping pairs * @start_vcn: vcn at which to start the mapping pairs array * * Walk the runlist @rl and calculate the size in bytes of the mapping pairs * array corresponding to the runlist @rl, starting at vcn @start_vcn. This * for example allows us to allocate a buffer of the right size when building * the mapping pairs array. * * If @rl is NULL, just return 1 (for the single terminator byte). * * Return the calculated size in bytes on success. On error, return -1 with * errno set to the error code. The following error codes are defined: * EINVAL - Run list contains unmapped elements. Make sure to only pass * fully mapped runlists to this function. * - @start_vcn is invalid. * EIO - The runlist is corrupt. */ int ntfs_get_size_for_mapping_pairs(const ntfs_volume *vol, const runlist_element *rl, const VCN start_vcn, int max_size) { LCN prev_lcn; int rls; if (start_vcn < 0) { ntfs_log_trace("start_vcn %lld (should be >= 0)\n", (long long) start_vcn); errno = EINVAL; goto errno_set; } if (!rl) { if (start_vcn) { ntfs_log_trace("rl NULL, start_vcn %lld (should be > 0)\n", (long long) start_vcn); errno = EINVAL; goto errno_set; } rls = 1; goto out; } /* Skip to runlist element containing @start_vcn. */ while (rl->length && start_vcn >= rl[1].vcn) rl++; if ((!rl->length && start_vcn > rl->vcn) || start_vcn < rl->vcn) { errno = EINVAL; goto errno_set; } prev_lcn = 0; /* Always need the terminating zero byte. */ rls = 1; /* Do the first partial run if present. */ if (start_vcn > rl->vcn) { s64 delta; /* We know rl->length != 0 already. */ if (rl->length < 0 || rl->lcn < LCN_HOLE) goto err_out; delta = start_vcn - rl->vcn; /* Header byte + length. */ rls += 1 + ntfs_get_nr_significant_bytes(rl->length - delta); /* * If the logical cluster number (lcn) denotes a hole and we * are on NTFS 3.0+, we don't store it at all, i.e. we need * zero space. On earlier NTFS versions we just store the lcn. * Note: this assumes that on NTFS 1.2-, holes are stored with * an lcn of -1 and not a delta_lcn of -1 (unless both are -1). */ if (rl->lcn >= 0 || vol->major_ver < 3) { prev_lcn = rl->lcn; if (rl->lcn >= 0) prev_lcn += delta; /* Change in lcn. */ rls += ntfs_get_nr_significant_bytes(prev_lcn); } /* Go to next runlist element. */ rl++; } /* Do the full runs. */ for (; rl->length && (rls <= max_size); rl++) { if (rl->length < 0 || rl->lcn < LCN_HOLE) goto err_out; /* Header byte + length. */ rls += 1 + ntfs_get_nr_significant_bytes(rl->length); /* * If the logical cluster number (lcn) denotes a hole and we * are on NTFS 3.0+, we don't store it at all, i.e. we need * zero space. On earlier NTFS versions we just store the lcn. * Note: this assumes that on NTFS 1.2-, holes are stored with * an lcn of -1 and not a delta_lcn of -1 (unless both are -1). */ if (rl->lcn >= 0 || vol->major_ver < 3) { /* Change in lcn. */ rls += ntfs_get_nr_significant_bytes(rl->lcn - prev_lcn); prev_lcn = rl->lcn; } } out: return rls; err_out: if (rl->lcn == LCN_RL_NOT_MAPPED) errno = EINVAL; else errno = EIO; errno_set: rls = -1; goto out; } /** * ntfs_write_significant_bytes - write the significant bytes of a number * @dst: destination buffer to write to * @dst_max: pointer to last byte of destination buffer for bounds checking * @n: number whose significant bytes to write * * Store in @dst, the minimum bytes of the number @n which are required to * identify @n unambiguously as a signed number, taking care not to exceed * @dest_max, the maximum position within @dst to which we are allowed to * write. * * This is used when building the mapping pairs array of a runlist to compress * a given logical cluster number (lcn) or a specific run length to the minimum * size possible. * * Return the number of bytes written on success. On error, i.e. the * destination buffer @dst is too small, return -1 with errno set ENOSPC. */ int ntfs_write_significant_bytes(u8 *dst, const u8 *dst_max, const s64 n) { s64 l = n; int i; i = 0; if (dst > dst_max) goto err_out; *dst++ = l; i++; while ((l > 0x7f) || (l < -0x80)) { if (dst > dst_max) goto err_out; l >>= 8; *dst++ = l; i++; } return i; err_out: errno = ENOSPC; return -1; } /** * ntfs_mapping_pairs_build - build the mapping pairs array from a runlist * @vol: ntfs volume (needed for the ntfs version) * @dst: destination buffer to which to write the mapping pairs array * @dst_len: size of destination buffer @dst in bytes * @rl: runlist for which to build the mapping pairs array * @start_vcn: vcn at which to start the mapping pairs array * @stop_vcn: first vcn outside destination buffer on success or ENOSPC error * * Create the mapping pairs array from the runlist @rl, starting at vcn * @start_vcn and save the array in @dst. @dst_len is the size of @dst in * bytes and it should be at least equal to the value obtained by calling * ntfs_get_size_for_mapping_pairs(). * * If @rl is NULL, just write a single terminator byte to @dst. * * On success or ENOSPC error, if @stop_vcn is not NULL, *@stop_vcn is set to * the first vcn outside the destination buffer. Note that on error @dst has * been filled with all the mapping pairs that will fit, thus it can be treated * as partial success, in that a new attribute extent needs to be created or the * next extent has to be used and the mapping pairs build has to be continued * with @start_vcn set to *@stop_vcn. * * Return 0 on success. On error, return -1 with errno set to the error code. * The following error codes are defined: * EINVAL - Run list contains unmapped elements. Make sure to only pass * fully mapped runlists to this function. * - @start_vcn is invalid. * EIO - The runlist is corrupt. * ENOSPC - The destination buffer is too small. */ int ntfs_mapping_pairs_build(const ntfs_volume *vol, u8 *dst, const int dst_len, const runlist_element *rl, const VCN start_vcn, runlist_element const **stop_rl) { LCN prev_lcn; u8 *dst_max, *dst_next; s8 len_len, lcn_len; int ret = 0; if (start_vcn < 0) goto val_err; if (!rl) { if (start_vcn) goto val_err; if (stop_rl) *stop_rl = rl; if (dst_len < 1) goto nospc_err; goto ok; } /* Skip to runlist element containing @start_vcn. */ while (rl->length && start_vcn >= rl[1].vcn) rl++; if ((!rl->length && start_vcn > rl->vcn) || start_vcn < rl->vcn) goto val_err; /* * @dst_max is used for bounds checking in * ntfs_write_significant_bytes(). */ dst_max = dst + dst_len - 1; prev_lcn = 0; /* Do the first partial run if present. */ if (start_vcn > rl->vcn) { s64 delta; /* We know rl->length != 0 already. */ if (rl->length < 0 || rl->lcn < LCN_HOLE) goto err_out; delta = start_vcn - rl->vcn; /* Write length. */ len_len = ntfs_write_significant_bytes(dst + 1, dst_max, rl->length - delta); if (len_len < 0) goto size_err; /* * If the logical cluster number (lcn) denotes a hole and we * are on NTFS 3.0+, we don't store it at all, i.e. we need * zero space. On earlier NTFS versions we just write the lcn * change. FIXME: Do we need to write the lcn change or just * the lcn in that case? Not sure as I have never seen this * case on NT4. - We assume that we just need to write the lcn * change until someone tells us otherwise... (AIA) */ if (rl->lcn >= 0 || vol->major_ver < 3) { prev_lcn = rl->lcn; if (rl->lcn >= 0) prev_lcn += delta; /* Write change in lcn. */ lcn_len = ntfs_write_significant_bytes(dst + 1 + len_len, dst_max, prev_lcn); if (lcn_len < 0) goto size_err; } else lcn_len = 0; dst_next = dst + len_len + lcn_len + 1; if (dst_next > dst_max) goto size_err; /* Update header byte. */ *dst = lcn_len << 4 | len_len; /* Position at next mapping pairs array element. */ dst = dst_next; /* Go to next runlist element. */ rl++; } /* Do the full runs. */ for (; rl->length; rl++) { if (rl->length < 0 || rl->lcn < LCN_HOLE) goto err_out; /* Write length. */ len_len = ntfs_write_significant_bytes(dst + 1, dst_max, rl->length); if (len_len < 0) goto size_err; /* * If the logical cluster number (lcn) denotes a hole and we * are on NTFS 3.0+, we don't store it at all, i.e. we need * zero space. On earlier NTFS versions we just write the lcn * change. FIXME: Do we need to write the lcn change or just * the lcn in that case? Not sure as I have never seen this * case on NT4. - We assume that we just need to write the lcn * change until someone tells us otherwise... (AIA) */ if (rl->lcn >= 0 || vol->major_ver < 3) { /* Write change in lcn. */ lcn_len = ntfs_write_significant_bytes(dst + 1 + len_len, dst_max, rl->lcn - prev_lcn); if (lcn_len < 0) goto size_err; prev_lcn = rl->lcn; } else lcn_len = 0; dst_next = dst + len_len + lcn_len + 1; if (dst_next > dst_max) goto size_err; /* Update header byte. */ *dst = lcn_len << 4 | len_len; /* Position at next mapping pairs array element. */ dst += 1 + len_len + lcn_len; } /* Set stop vcn. */ if (stop_rl) *stop_rl = rl; ok: /* Add terminator byte. */ *dst = 0; out: return ret; size_err: /* Set stop vcn. */ if (stop_rl) *stop_rl = rl; /* Add terminator byte. */ *dst = 0; nospc_err: errno = ENOSPC; goto errno_set; val_err: errno = EINVAL; goto errno_set; err_out: if (rl->lcn == LCN_RL_NOT_MAPPED) errno = EINVAL; else errno = EIO; errno_set: ret = -1; goto out; } /** * ntfs_rl_truncate - truncate a runlist starting at a specified vcn * @arl: address of runlist to truncate * @start_vcn: first vcn which should be cut off * * Truncate the runlist *@arl starting at vcn @start_vcn as well as the memory * buffer holding the runlist. * * Return 0 on success and -1 on error with errno set to the error code. * * NOTE: @arl is the address of the runlist. We need the address so we can * modify the pointer to the runlist with the new, reallocated memory buffer. */ int ntfs_rl_truncate(runlist **arl, const VCN start_vcn) { runlist *rl; /* BOOL is_end = FALSE; */ if (!arl || !*arl) { errno = EINVAL; if (!arl) ntfs_log_perror("rl_truncate error: arl: %p", arl); else ntfs_log_perror("rl_truncate error:" " arl: %p *arl: %p", arl, *arl); return -1; } rl = *arl; if (start_vcn < rl->vcn) { errno = EINVAL; ntfs_log_perror("Start_vcn lies outside front of runlist"); return -1; } /* Find the starting vcn in the run list. */ while (rl->length) { if (start_vcn < rl[1].vcn) break; rl++; } if (!rl->length) { errno = EIO; ntfs_log_trace("Truncating already truncated runlist?\n"); return -1; } /* Truncate the run. */ rl->length = start_vcn - rl->vcn; /* * If a run was partially truncated, make the following runlist * element a terminator instead of the truncated runlist * element itself. */ if (rl->length) { ++rl; /* if (!rl->length) is_end = TRUE; */ rl->vcn = start_vcn; rl->length = 0; } rl->lcn = (LCN)LCN_ENOENT; /** * Reallocate memory if necessary. * FIXME: Below code is broken, because runlist allocations must be * a multiple of 4096. The code caused crashes and corruptions. */ /* if (!is_end) { size_t new_size = (rl - *arl + 1) * sizeof(runlist_element); rl = realloc(*arl, new_size); if (rl) *arl = rl; } */ return 0; } /** * ntfs_rl_sparse - check whether runlist have sparse regions or not. * @rl: runlist to check * * Return 1 if have, 0 if not, -1 on error with errno set to the error code. */ int ntfs_rl_sparse(runlist *rl) { runlist *rlc; if (!rl) { errno = EINVAL; ntfs_log_perror("%s: ", __FUNCTION__); return -1; } for (rlc = rl; rlc->length; rlc++) if (rlc->lcn < 0) { if (rlc->lcn != LCN_HOLE) { errno = EINVAL; ntfs_log_perror("%s: bad runlist(%llu, %llu, %llu)", __func__, (unsigned long long)rlc->vcn, (unsigned long long)rlc->lcn, (unsigned long long)rlc->length); return -1; } return 1; } return 0; } /** * ntfs_rl_get_compressed_size - calculate length of non sparse regions * @vol: ntfs volume (need for cluster size) * @rl: runlist to calculate for * * Return compressed size or -1 on error with errno set to the error code. */ s64 ntfs_rl_get_compressed_size(ntfs_volume *vol, runlist *rl) { runlist *rlc; s64 ret = 0; if (!rl) { errno = EINVAL; ntfs_log_perror("%s: ", __FUNCTION__); return -1; } for (rlc = rl; rlc->length; rlc++) { if (rlc->lcn < 0) { if (rlc->lcn != LCN_HOLE) { errno = EINVAL; ntfs_log_perror("%s: bad runlist", __FUNCTION__); return -1; } } else ret += rlc->length; } return ret << vol->cluster_size_bits; } runlist_element *ntfs_rl_punch_hole(runlist_element *dst_rl, int dst_cnt, VCN start_vcn, s64 len, runlist_element **punch_rl) { runlist_element *s_rl, *e_rl, *new_rl, *dst_3rd_rl, hole_rl[1]; VCN end_vcn; int new_1st_cnt, dst_3rd_cnt, new_cnt, punch_cnt, merge_cnt; BOOL begin_split, end_split, one_split_3; if (dst_cnt < 2 || dst_rl[dst_cnt - 1].length != 0) return NULL; end_vcn = min(start_vcn + len - 1, dst_rl[dst_cnt - 2].vcn + dst_rl[dst_cnt - 2].length - 1); s_rl = ntfs_rl_find_vcn(dst_rl, start_vcn); if (!s_rl || s_rl->lcn <= LCN_ENOENT) return NULL; begin_split = s_rl->vcn != start_vcn ? TRUE : FALSE; e_rl = ntfs_rl_find_vcn(dst_rl, end_vcn); if (!e_rl || e_rl->lcn <= LCN_ENOENT) return NULL; end_split = e_rl->vcn + e_rl->length - 1 != end_vcn ? TRUE : FALSE; /* @s_rl has to be split into left, punched hole, and right */ one_split_3 = e_rl == s_rl && begin_split && end_split ? TRUE : FALSE; punch_cnt = (int)(e_rl - s_rl) + 1; new_cnt = dst_cnt - punch_cnt + 3; new_rl = ntfs_rl_malloc(new_cnt); if (!new_rl) return NULL; new_1st_cnt = (int)(s_rl - dst_rl) + 1; if (punch_rl) { *punch_rl = ntfs_rl_malloc(punch_cnt + 1); if (!*punch_rl) { free(new_rl); return NULL; } ntfs_rl_mc(*punch_rl, 0, dst_rl, new_1st_cnt - 1, punch_cnt); (*punch_rl)[punch_cnt].lcn = LCN_ENOENT; (*punch_rl)[punch_cnt].length = 0; } if (!begin_split) new_1st_cnt--; dst_3rd_rl = e_rl; dst_3rd_cnt = (int)(&dst_rl[dst_cnt - 1] - e_rl) + 1; if (!end_split) { dst_3rd_rl++; dst_3rd_cnt--; } /* Copy the 1st part of @dst_rl into @new_rl */ ntfs_rl_mc(new_rl, 0, dst_rl, 0, new_1st_cnt); if (begin_split) { /* * the @e_rl has to be splited and copied into the last of @new_rl * and the first of @punch_rl if @punch_rl is not null. */ VCN first_cnt = start_vcn - dst_rl[new_1st_cnt - 1].vcn; if (new_1st_cnt) new_rl[new_1st_cnt - 1].length = first_cnt; if (punch_rl) { (*punch_rl)[0].vcn = start_vcn; (*punch_rl)[0].length -= first_cnt; if ((*punch_rl)[0].lcn > LCN_HOLE) (*punch_rl)[0].lcn += first_cnt; } } /* Copy a hole into @new_rl */ hole_rl[0].vcn = start_vcn; hole_rl[0].length = (s64)len; hole_rl[0].lcn = LCN_HOLE; ntfs_rl_mc(new_rl, new_1st_cnt, hole_rl, 0, 1); /* Copy the 3rd part of @dst_rl into @new_rl */ ntfs_rl_mc(new_rl, new_1st_cnt + 1, dst_3rd_rl, 0, dst_3rd_cnt); if (end_split) { /* the @e_rl has to be splited and copied into the first of * @new_rl and the last of @punch_rl if @punch_rl is not null. */ VCN first_cnt = end_vcn - dst_3rd_rl[0].vcn + 1; new_rl[new_1st_cnt + 1].vcn = end_vcn + 1; new_rl[new_1st_cnt + 1].length -= first_cnt; if (new_rl[new_1st_cnt + 1].lcn > LCN_HOLE) new_rl[new_1st_cnt + 1].lcn += first_cnt; if (punch_rl) { if (one_split_3) (*punch_rl)[punch_cnt - 1].length -= new_rl[new_1st_cnt + 1].length; else (*punch_rl)[punch_cnt - 1].length = first_cnt; } } /* Merge left and hole, or hole and right in @new_rl, if left or right * consists of holes. */ merge_cnt = 0; if (new_1st_cnt > 0 && new_rl[new_1st_cnt - 1].lcn == LCN_HOLE) { /* Merge right and hole */ s_rl = &new_rl[new_1st_cnt - 1]; s_rl->length += s_rl[1].length; merge_cnt = 1; /* Merge left and right */ if (new_1st_cnt + 1 < new_cnt && new_rl[new_1st_cnt + 1].lcn == LCN_HOLE) { s_rl->length += s_rl[2].length; merge_cnt++; } } else if (new_1st_cnt + 1 < new_cnt && new_rl[new_1st_cnt + 1].lcn == LCN_HOLE) { /* Merge left and hole */ s_rl = &new_rl[new_1st_cnt]; s_rl->length += s_rl[1].length; merge_cnt = 1; } if (merge_cnt) { runlist_element *d_rl, *src_rl; d_rl = s_rl + 1; src_rl = s_rl + 1 + merge_cnt; ntfs_rl_mm(new_rl, (int)(d_rl - new_rl), (int)(src_rl - new_rl), (int)(&new_rl[new_cnt - 1] - src_rl) + 1); } if (punch_rl) { (*punch_rl)[punch_cnt].vcn = (*punch_rl)[punch_cnt - 1].vcn + (*punch_rl)[punch_cnt - 1].length; } ntfs_free(dst_rl); return new_rl; } #define MAX_CLUSTER_COPY_SIZE(vol) (vol->cluster_size * 4) #define MAX_CLUSTER_COPY_NUM(vol) (MAX_CLUSTER_COPY_SIZE(vol) >> (vol)->cluster_size_bits) runlist *ntfs_copy_rl_clusters(ntfs_volume *vol, runlist *new_rl, int new_cnt, runlist *orig_rl, int orig_cnt) { u8 *buf; s64 rpos; s64 rcnt, wcnt; s64 rbuf_offset, wpos_offset; s64 max_rsize; if (!vol) return NULL; max_rsize = MAX_CLUSTER_COPY_SIZE(vol); buf = ntfs_calloc(max_rsize); if (!buf) { ntfs_log_error("Error, failed to allocate memory\n"); return NULL; } rpos = 0; wpos_offset = 0; ntfs_log_debug("copy_rl_clusters orig_rl dump\n"); ntfs_debug_runlist_dump(orig_rl); ntfs_debug_runlist_dump(new_rl); for (;;) { rcnt = ntfs_rl_pread(vol, orig_rl, rpos, max_rsize, buf); if (rcnt <= 0) break; rpos += rcnt; rbuf_offset = 0; while (rcnt) { ntfs_log_trace("before write : rpos(%"PRIu64") wpos_offset(%"PRIu64") " "rcnt(%"PRIu64") rbuf_offset(%"PRIu64")\n", rpos, wpos_offset, rcnt, rbuf_offset); wcnt = ntfs_rl_pwrite(vol, new_rl, 0, wpos_offset, rcnt, buf + rbuf_offset); if (wcnt < 0) { ntfs_log_error("Failed to write new runlist data\n"); free(buf); return NULL; } wpos_offset += wcnt; rbuf_offset += wcnt; rcnt -= wcnt; ntfs_log_trace("after write : wcnt(%"PRIu64") wpos_offset(%"PRIu64") " "rcnt(%"PRIu64") rbuf_offset(%"PRIu64")\n", wcnt, wpos_offset, rcnt, rbuf_offset); } } free(buf); return new_rl; } #ifdef NTFS_TEST /** * test_rl_helper */ #define MKRL(R,V,L,S) \ (R)->vcn = V; \ (R)->lcn = L; \ (R)->length = S; /* } */ /** * test_rl_dump_runlist - Runlist test: Display the contents of a runlist * @rl: * * Description... * * Returns: */ static void test_rl_dump_runlist(const runlist_element *rl) { int abbr = 0; /* abbreviate long lists */ int len = 0; int i; const char *lcn_str[5] = { "HOLE", "NOTMAP", "ENOENT", "XXXX" }; if (!rl) { printf(" Run list not present.\n"); return; } if (abbr) for (len = 0; rl[len].length; len++) ; printf(" VCN LCN len\n"); for (i = 0; ; i++, rl++) { LCN lcn = rl->lcn; if ((abbr) && (len > 20)) { if (i == 4) printf(" ...\n"); if ((i > 3) && (i < (len - 3))) continue; } if (lcn < (LCN)0) { int ind = -lcn - 1; if (ind > -LCN_ENOENT - 1) ind = 3; printf("%8lld %8s %8lld\n", rl->vcn, lcn_str[ind], rl->length); } else printf("%8lld %8lld %8lld\n", rl->vcn, rl->lcn, rl->length); if (!rl->length) break; } if ((abbr) && (len > 20)) printf(" (%d entries)\n", len+1); printf("\n"); } /** * test_rl_runlists_merge - Runlist test: Merge two runlists * @drl: * @srl: * * Description... * * Returns: */ static runlist_element * test_rl_runlists_merge(runlist_element *drl, runlist_element *srl) { runlist_element *res = NULL; printf("dst:\n"); test_rl_dump_runlist(drl); printf("src:\n"); test_rl_dump_runlist(srl); res = ntfs_runlists_merge(drl, srl); printf("res:\n"); test_rl_dump_runlist(res); return res; } /** * test_rl_read_buffer - Runlist test: Read a file containing a runlist * @file: * @buf: * @bufsize: * * Description... * * Returns: */ static int test_rl_read_buffer(const char *file, u8 *buf, int bufsize) { FILE *fptr; fptr = fopen(file, "r"); if (!fptr) { printf("open %s\n", file); return 0; } if (fread(buf, bufsize, 1, fptr) == 99) { printf("read %s\n", file); fclose(fptr); return 0; } fclose(fptr); return 1; } /** * test_rl_pure_src - Runlist test: Complicate the simple tests a little * @contig: * @multi: * @vcn: * @len: * * Description... * * Returns: */ static runlist_element * test_rl_pure_src(BOOL contig, BOOL multi, int vcn, int len) { runlist_element *result; int fudge; if (contig) fudge = 0; else fudge = 999; result = ntfs_malloc(4096); if (!result) return NULL; if (multi) { MKRL(result+0, vcn + (0*len/4), fudge + vcn + 1000 + (0*len/4), len / 4) MKRL(result+1, vcn + (1*len/4), fudge + vcn + 1000 + (1*len/4), len / 4) MKRL(result+2, vcn + (2*len/4), fudge + vcn + 1000 + (2*len/4), len / 4) MKRL(result+3, vcn + (3*len/4), fudge + vcn + 1000 + (3*len/4), len / 4) MKRL(result+4, vcn + (4*len/4), LCN_RL_NOT_MAPPED, 0) } else { MKRL(result+0, vcn, fudge + vcn + 1000, len) MKRL(result+1, vcn + len, LCN_RL_NOT_MAPPED, 0) } return result; } /** * test_rl_pure_test - Runlist test: Perform tests using simple runlists * @test: * @contig: * @multi: * @vcn: * @len: * @file: * @size: * * Description... * * Returns: */ static void test_rl_pure_test(int test, BOOL contig, BOOL multi, int vcn, int len, runlist_element *file, int size) { runlist_element *src; runlist_element *dst; runlist_element *res; src = test_rl_pure_src(contig, multi, vcn, len); dst = ntfs_malloc(4096); if (!src || !dst) { printf("Test %2d ---------- FAILED! (no free memory?)\n", test); return; } memcpy(dst, file, size); printf("Test %2d ----------\n", test); res = test_rl_runlists_merge(dst, src); free(res); } /** * test_rl_pure - Runlist test: Create tests using simple runlists * @contig: * @multi: * * Description... * * Returns: */ static void test_rl_pure(char *contig, char *multi) { /* VCN, LCN, len */ static runlist_element file1[] = { { 0, -1, 100 }, /* HOLE */ { 100, 1100, 100 }, /* DATA */ { 200, -1, 100 }, /* HOLE */ { 300, 1300, 100 }, /* DATA */ { 400, -1, 100 }, /* HOLE */ { 500, -3, 0 } /* NOENT */ }; static runlist_element file2[] = { { 0, 1000, 100 }, /* DATA */ { 100, -1, 100 }, /* HOLE */ { 200, -3, 0 } /* NOENT */ }; static runlist_element file3[] = { { 0, 1000, 100 }, /* DATA */ { 100, -3, 0 } /* NOENT */ }; static runlist_element file4[] = { { 0, -3, 0 } /* NOENT */ }; static runlist_element file5[] = { { 0, -2, 100 }, /* NOTMAP */ { 100, 1100, 100 }, /* DATA */ { 200, -2, 100 }, /* NOTMAP */ { 300, 1300, 100 }, /* DATA */ { 400, -2, 100 }, /* NOTMAP */ { 500, -3, 0 } /* NOENT */ }; static runlist_element file6[] = { { 0, 1000, 100 }, /* DATA */ { 100, -2, 100 }, /* NOTMAP */ { 200, -3, 0 } /* NOENT */ }; BOOL c, m; if (strcmp(contig, "contig") == 0) c = TRUE; else if (strcmp(contig, "noncontig") == 0) c = FALSE; else { printf("rl pure [contig|noncontig] [single|multi]\n"); return; } if (strcmp(multi, "multi") == 0) m = TRUE; else if (strcmp(multi, "single") == 0) m = FALSE; else { printf("rl pure [contig|noncontig] [single|multi]\n"); return; } test_rl_pure_test(1, c, m, 0, 40, file1, sizeof(file1)); test_rl_pure_test(2, c, m, 40, 40, file1, sizeof(file1)); test_rl_pure_test(3, c, m, 60, 40, file1, sizeof(file1)); test_rl_pure_test(4, c, m, 0, 100, file1, sizeof(file1)); test_rl_pure_test(5, c, m, 200, 40, file1, sizeof(file1)); test_rl_pure_test(6, c, m, 240, 40, file1, sizeof(file1)); test_rl_pure_test(7, c, m, 260, 40, file1, sizeof(file1)); test_rl_pure_test(8, c, m, 200, 100, file1, sizeof(file1)); test_rl_pure_test(9, c, m, 400, 40, file1, sizeof(file1)); test_rl_pure_test(10, c, m, 440, 40, file1, sizeof(file1)); test_rl_pure_test(11, c, m, 460, 40, file1, sizeof(file1)); test_rl_pure_test(12, c, m, 400, 100, file1, sizeof(file1)); test_rl_pure_test(13, c, m, 160, 100, file2, sizeof(file2)); test_rl_pure_test(14, c, m, 100, 140, file2, sizeof(file2)); test_rl_pure_test(15, c, m, 200, 40, file2, sizeof(file2)); test_rl_pure_test(16, c, m, 240, 40, file2, sizeof(file2)); test_rl_pure_test(17, c, m, 100, 40, file3, sizeof(file3)); test_rl_pure_test(18, c, m, 140, 40, file3, sizeof(file3)); test_rl_pure_test(19, c, m, 0, 40, file4, sizeof(file4)); test_rl_pure_test(20, c, m, 40, 40, file4, sizeof(file4)); test_rl_pure_test(21, c, m, 0, 40, file5, sizeof(file5)); test_rl_pure_test(22, c, m, 40, 40, file5, sizeof(file5)); test_rl_pure_test(23, c, m, 60, 40, file5, sizeof(file5)); test_rl_pure_test(24, c, m, 0, 100, file5, sizeof(file5)); test_rl_pure_test(25, c, m, 200, 40, file5, sizeof(file5)); test_rl_pure_test(26, c, m, 240, 40, file5, sizeof(file5)); test_rl_pure_test(27, c, m, 260, 40, file5, sizeof(file5)); test_rl_pure_test(28, c, m, 200, 100, file5, sizeof(file5)); test_rl_pure_test(29, c, m, 400, 40, file5, sizeof(file5)); test_rl_pure_test(30, c, m, 440, 40, file5, sizeof(file5)); test_rl_pure_test(31, c, m, 460, 40, file5, sizeof(file5)); test_rl_pure_test(32, c, m, 400, 100, file5, sizeof(file5)); test_rl_pure_test(33, c, m, 160, 100, file6, sizeof(file6)); test_rl_pure_test(34, c, m, 100, 140, file6, sizeof(file6)); } /** * test_rl_zero - Runlist test: Merge a zero-length runlist * * Description... * * Returns: */ static void test_rl_zero(void) { runlist_element *jim = NULL; runlist_element *bob = NULL; bob = calloc(3, sizeof(runlist_element)); if (!bob) return; MKRL(bob+0, 10, 99, 5) MKRL(bob+1, 15, LCN_RL_NOT_MAPPED, 0) jim = test_rl_runlists_merge(jim, bob); if (!jim) return; free(jim); } /** * test_rl_frag_combine - Runlist test: Perform tests using fragmented files * @vol: * @attr1: * @attr2: * @attr3: * * Description... * * Returns: */ static void test_rl_frag_combine(ntfs_volume *vol, ATTR_RECORD *attr1, ATTR_RECORD *attr2, ATTR_RECORD *attr3) { runlist_element *run1; runlist_element *run2; runlist_element *run3; run1 = ntfs_mapping_pairs_decompress(vol, attr1, NULL); if (!run1) return; run2 = ntfs_mapping_pairs_decompress(vol, attr2, NULL); if (!run2) return; run1 = test_rl_runlists_merge(run1, run2); run3 = ntfs_mapping_pairs_decompress(vol, attr3, NULL); if (!run3) return; run1 = test_rl_runlists_merge(run1, run3); free(run1); } /** * test_rl_frag - Runlist test: Create tests using very fragmented files * @test: * * Description... * * Returns: */ static void test_rl_frag(char *test) { ntfs_volume vol; ATTR_RECORD *attr1 = ntfs_malloc(1024); ATTR_RECORD *attr2 = ntfs_malloc(1024); ATTR_RECORD *attr3 = ntfs_malloc(1024); if (!attr1 || !attr2 || !attr3) goto out; vol.sb = NULL; vol.sector_size_bits = 9; vol.cluster_size = 2048; vol.cluster_size_bits = 11; vol.major_ver = 3; if (!test_rl_read_buffer("runlist-data/attr1.bin", (u8*) attr1, 1024)) goto out; if (!test_rl_read_buffer("runlist-data/attr2.bin", (u8*) attr2, 1024)) goto out; if (!test_rl_read_buffer("runlist-data/attr3.bin", (u8*) attr3, 1024)) goto out; if (strcmp(test, "123") == 0) test_rl_frag_combine(&vol, attr1, attr2, attr3); else if (strcmp(test, "132") == 0) test_rl_frag_combine(&vol, attr1, attr3, attr2); else if (strcmp(test, "213") == 0) test_rl_frag_combine(&vol, attr2, attr1, attr3); else if (strcmp(test, "231") == 0) test_rl_frag_combine(&vol, attr2, attr3, attr1); else if (strcmp(test, "312") == 0) test_rl_frag_combine(&vol, attr3, attr1, attr2); else if (strcmp(test, "321") == 0) test_rl_frag_combine(&vol, attr3, attr2, attr1); else printf("Frag: No such test '%s'\n", test); out: free(attr1); free(attr2); free(attr3); } /** * test_rl_main - Runlist test: Program start (main) * @argc: * @argv: * * Description... * * Returns: */ int test_rl_main(int argc, char *argv[]) { if ((argc == 2) && (strcmp(argv[1], "zero") == 0)) test_rl_zero(); else if ((argc == 3) && (strcmp(argv[1], "frag") == 0)) test_rl_frag(argv[2]); else if ((argc == 4) && (strcmp(argv[1], "pure") == 0)) test_rl_pure(argv[2], argv[3]); else printf("rl [zero|frag|pure] {args}\n"); return 0; } #endif ntfsprogs-plus-1.0.0/libntfs/security.c000066400000000000000000004251161507404161300202040ustar00rootroot00000000000000/** * security.c - Handling security/ACLs in NTFS. Originated from the Linux-NTFS project. * * Copyright (c) 2004 Anton Altaparmakov * Copyright (c) 2005-2006 Szabolcs Szakacsits * Copyright (c) 2006 Yura Pakhuchiy * Copyright (c) 2007-2015 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #include #include #include #include "compat.h" #include "param.h" #include "types.h" #include "layout.h" #include "attrib.h" #include "index.h" #include "dir.h" #include "bitmap.h" #include "security.h" #include "acls.h" #include "cache.h" #include "misc.h" #include "xattrs.h" #include "lib_utils.h" /* * JPA NTFS constants or structs * should be moved to layout.h */ #define ALIGN_SDS_BLOCK 0x40000 /* Alignment for a $SDS block */ #define ALIGN_SDS_ENTRY 16 /* Alignment for a $SDS entry */ #define STUFFSZ 0x4000 /* unitary stuffing size for $SDS */ #define FIRST_SECURITY_ID 0x100 /* Lowest security id */ /* Mask for attributes which can be forced */ #define FILE_ATTR_SETTABLE ( FILE_ATTR_READONLY \ | FILE_ATTR_HIDDEN \ | FILE_ATTR_SYSTEM \ | FILE_ATTR_ARCHIVE \ | FILE_ATTR_TEMPORARY \ | FILE_ATTR_OFFLINE \ | FILE_ATTR_NOT_CONTENT_INDEXED ) struct SII { /* this is an image of an $SII index entry */ le16 offs; le16 size; le32 fill1; le16 indexsz; le16 indexksz; le16 flags; le16 fill2; le32 keysecurid; /* did not find official description for the following */ le32 hash; le32 securid; le32 dataoffsl; /* documented as badly aligned */ le32 dataoffsh; le32 datasize; } ; struct SDH { /* this is an image of an $SDH index entry */ le16 offs; le16 size; le32 fill1; le16 indexsz; le16 indexksz; le16 flags; le16 fill2; le32 keyhash; le32 keysecurid; /* did not find official description for the following */ le32 hash; le32 securid; le32 dataoffsl; le32 dataoffsh; le32 datasize; le32 fill3; } ; /* * A few useful constants */ static ntfschar sii_stream[] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('I'), const_cpu_to_le16('I'), const_cpu_to_le16(0) }; static ntfschar sdh_stream[] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('D'), const_cpu_to_le16('H'), const_cpu_to_le16(0) }; /* * null SID (S-1-0-0) */ extern const SID *nullsid; /* * The zero GUID. */ static const GUID __zero_guid = { const_cpu_to_le32(0), const_cpu_to_le16(0), const_cpu_to_le16(0), { 0, 0, 0, 0, 0, 0, 0, 0 } }; static const GUID *const zero_guid = &__zero_guid; /** * ntfs_guid_is_zero - check if a GUID is zero * @guid: [IN] guid to check * * Return TRUE if @guid is a valid pointer to a GUID and it is the zero GUID * and FALSE otherwise. */ BOOL ntfs_guid_is_zero(const GUID *guid) { return (memcmp(guid, zero_guid, sizeof(*zero_guid))); } /** * ntfs_guid_to_mbs - convert a GUID to a multi byte string * @guid: [IN] guid to convert * @guid_str: [OUT] string in which to return the GUID (optional) * * Convert the GUID pointed to by @guid to a multi byte string of the form * "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX". Therefore, @guid_str (if not NULL) * needs to be able to store at least 37 bytes. * * If @guid_str is not NULL it will contain the converted GUID on return. If * it is NULL a string will be allocated and this will be returned. The caller * is responsible for free()ing the string in that case. * * On success return the converted string and on failure return NULL with errno * set to the error code. */ char *ntfs_guid_to_mbs(const GUID *guid, char *guid_str) { char *_guid_str; int res; if (!guid) { errno = EINVAL; return NULL; } _guid_str = guid_str; if (!_guid_str) { _guid_str = (char*)ntfs_malloc(37); if (!_guid_str) return _guid_str; } res = snprintf(_guid_str, 37, "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x", (unsigned int)le32_to_cpu(guid->data1), le16_to_cpu(guid->data2), le16_to_cpu(guid->data3), guid->data4[0], guid->data4[1], guid->data4[2], guid->data4[3], guid->data4[4], guid->data4[5], guid->data4[6], guid->data4[7]); if (res == 36) return _guid_str; if (!guid_str) free(_guid_str); errno = EINVAL; return NULL; } /** * ntfs_sid_to_mbs_size - determine maximum size for the string of a SID * @sid: [IN] SID for which to determine the maximum string size * * Determine the maximum multi byte string size in bytes which is needed to * store the standard textual representation of the SID pointed to by @sid. * See ntfs_sid_to_mbs(), below. * * On success return the maximum number of bytes needed to store the multi byte * string and on failure return -1 with errno set to the error code. */ int ntfs_sid_to_mbs_size(const SID *sid) { int size, i; if (!ntfs_valid_sid(sid)) { errno = EINVAL; return -1; } /* Start with "S-". */ size = 2; /* * Add the SID_REVISION. Hopefully the compiler will optimize this * away as SID_REVISION is a constant. */ for (i = SID_REVISION; i > 0; i /= 10) size++; /* Add the "-". */ size++; /* * Add the identifier authority. If it needs to be in decimal, the * maximum is 2^32-1 = 4294967295 = 10 characters. If it needs to be * in hexadecimal, then maximum is 0x665544332211 = 14 characters. */ if (!sid->identifier_authority.high_part) size += 10; else size += 14; /* * Finally, add the sub authorities. For each we have a "-" followed * by a decimal which can be up to 2^32-1 = 4294967295 = 10 characters. */ size += (1 + 10) * sid->sub_authority_count; /* We need the zero byte at the end, too. */ size++; return size * sizeof(char); } /** * ntfs_sid_to_mbs - convert a SID to a multi byte string * @sid: [IN] SID to convert * @sid_str: [OUT] string in which to return the SID (optional) * @sid_str_size: [IN] size in bytes of @sid_str * * Convert the SID pointed to by @sid to its standard textual representation. * @sid_str (if not NULL) needs to be able to store at least * ntfs_sid_to_mbs_size() bytes. @sid_str_size is the size in bytes of * @sid_str if @sid_str is not NULL. * * The standard textual representation of the SID is of the form: * S-R-I-S-S... * Where: * - The first "S" is the literal character 'S' identifying the following * digits as a SID. * - R is the revision level of the SID expressed as a sequence of digits * in decimal. * - I is the 48-bit identifier_authority, expressed as digits in decimal, * if I < 2^32, or hexadecimal prefixed by "0x", if I >= 2^32. * - S... is one or more sub_authority values, expressed as digits in * decimal. * * If @sid_str is not NULL it will contain the converted SUID on return. If it * is NULL a string will be allocated and this will be returned. The caller is * responsible for free()ing the string in that case. * * On success return the converted string and on failure return NULL with errno * set to the error code. */ char *ntfs_sid_to_mbs(const SID *sid, char *sid_str, size_t sid_str_size) { u64 u; le32 leauth; char *s; int i, j, cnt; /* * No need to check @sid if !@sid_str since ntfs_sid_to_mbs_size() will * check @sid, too. 8 is the minimum SID string size. */ if (sid_str && (sid_str_size < 8 || !ntfs_valid_sid(sid))) { errno = EINVAL; return NULL; } /* Allocate string if not provided. */ if (!sid_str) { cnt = ntfs_sid_to_mbs_size(sid); if (cnt < 0) return NULL; s = (char*)ntfs_malloc(cnt); if (!s) return s; sid_str = s; /* So we know we allocated it. */ sid_str_size = 0; } else { s = sid_str; cnt = sid_str_size; } /* Start with "S-R-". */ i = snprintf(s, cnt, "S-%hhu-", (unsigned char)sid->revision); if (i < 0 || i >= cnt) goto err_out; s += i; cnt -= i; /* Add the identifier authority. */ for (u = i = 0, j = 40; i < 6; i++, j -= 8) u += (u64)sid->identifier_authority.value[i] << j; if (!sid->identifier_authority.high_part) i = snprintf(s, cnt, "%lu", (unsigned long)u); else i = snprintf(s, cnt, "0x%llx", (unsigned long long)u); if (i < 0 || i >= cnt) goto err_out; s += i; cnt -= i; /* Finally, add the sub authorities. */ for (j = 0; j < sid->sub_authority_count; j++) { leauth = sid->sub_authority[j]; i = snprintf(s, cnt, "-%u", (unsigned int) le32_to_cpu(leauth)); if (i < 0 || i >= cnt) goto err_out; s += i; cnt -= i; } return sid_str; err_out: if (i >= cnt) i = EMSGSIZE; else i = errno; if (!sid_str_size) free(sid_str); errno = i; return NULL; } /** * ntfs_generate_guid - generatates a random current guid. * @guid: [OUT] pointer to a GUID struct to hold the generated guid. * * perhaps not a very good random number generator though... */ void ntfs_generate_guid(GUID *guid) { unsigned int i; u8 *p = (u8 *)guid; /* this is called at most once from mkntfs */ srandom(time((time_t*)NULL) ^ (getpid() << 16)); for (i = 0; i < sizeof(GUID); i++) { p[i] = (u8)(random() & 0xFF); if (i == 7) p[7] = (p[7] & 0x0F) | 0x40; if (i == 8) p[8] = (p[8] & 0x3F) | 0x80; } } /** * ntfs_security_hash - calculate the hash of a security descriptor * @sd: self-relative security descriptor whose hash to calculate * @length: size in bytes of the security descritor @sd * * Calculate the hash of the self-relative security descriptor @sd of length * @length bytes. * * This hash is used in the $Secure system file as the primary key for the $SDH * index and is also stored in the header of each security descriptor in the * $SDS data stream as well as in the index data of both the $SII and $SDH * indexes. In all three cases it forms part of the SDS_ENTRY_HEADER * structure. * * Return the calculated security hash in little endian. */ le32 ntfs_security_hash(const SECURITY_DESCRIPTOR_RELATIVE *sd, const u32 len) { const le32 *pos = (const le32*)sd; const le32 *end = pos + (len >> 2); u32 hash = 0; while (pos < end) { hash = le32_to_cpup(pos) + ntfs_rol32(hash, 3); pos++; } return cpu_to_le32(hash); } /* * Get the first entry of current index block * cut and pasted form ntfs_ie_get_first() in index.c */ static INDEX_ENTRY *ntfs_ie_get_first(INDEX_HEADER *ih) { return (INDEX_ENTRY*)((u8*)ih + le32_to_cpu(ih->entries_offset)); } /* * Stuff a 256KB block into $SDS before writing descriptors * into the block. * * This prevents $SDS from being automatically declared as sparse * when the second copy of the first security descriptor is written * 256KB further ahead. * * Having $SDS declared as a sparse file is not wrong by itself * and chkdsk leaves it as a sparse file. It does however complain * and add a sparse flag (0x0200) into field file_attributes of * STANDARD_INFORMATION of $Secure. This probably means that a * sparse attribute (ATTR_IS_SPARSE) is only allowed in sparse * files (FILE_ATTR_SPARSE_FILE). * * Windows normally does not convert to sparse attribute or sparse * file. Stuffing is just a way to get to the same result. */ static int entersecurity_stuff(ntfs_volume *vol, off_t offs) { int res; int written; unsigned long total; char *stuff; res = 0; total = 0; stuff = (char*)ntfs_malloc(STUFFSZ); if (stuff) { memset(stuff, 0, STUFFSZ); do { written = ntfs_attr_data_write(vol->secure_ni, STREAM_SDS, 4, stuff, STUFFSZ, offs); if (written == STUFFSZ) { total += STUFFSZ; offs += STUFFSZ; } else { errno = ENOSPC; res = -1; } } while (!res && (total < ALIGN_SDS_BLOCK)); free(stuff); } else { errno = ENOMEM; res = -1; } return (res); } /* * Enter a new security descriptor into $Secure (data only) * it has to be written twice with an offset of 256KB * * Should only be called by entersecurityattr() to ensure consistency * * Returns zero if sucessful */ static int entersecurity_data(ntfs_volume *vol, const SECURITY_DESCRIPTOR_RELATIVE *attr, s64 attrsz, le32 hash, le32 keyid, off_t offs, int gap) { int res; int written1; int written2; char *fullattr; int fullsz; SECURITY_DESCRIPTOR_HEADER *phsds; res = -1; fullsz = attrsz + gap + sizeof(SECURITY_DESCRIPTOR_HEADER); fullattr = (char*)ntfs_malloc(fullsz); if (fullattr) { /* * Clear the gap from previous descriptor * this could be useful for appending the second * copy to the end of file. When creating a new * 256K block, the gap is cleared while writing * the first copy */ if (gap) memset(fullattr,0,gap); memcpy(&fullattr[gap + sizeof(SECURITY_DESCRIPTOR_HEADER)], attr,attrsz); phsds = (SECURITY_DESCRIPTOR_HEADER*)&fullattr[gap]; phsds->hash = hash; phsds->security_id = keyid; phsds->offset = cpu_to_le64(offs); phsds->length = cpu_to_le32(fullsz - gap); written1 = ntfs_attr_data_write(vol->secure_ni, STREAM_SDS, 4, fullattr, fullsz, offs - gap); written2 = ntfs_attr_data_write(vol->secure_ni, STREAM_SDS, 4, fullattr, fullsz, offs - gap + ALIGN_SDS_BLOCK); if ((written1 == fullsz) && (written2 == written1)) { /* * Make sure the data size for $SDS marks the end * of the last security attribute. Windows uses * this to determine where the next attribute will * be written, which causes issues if chkdsk had * previously deleted the last entries without * adjusting the size. */ res = ntfs_attr_shrink_size(vol->secure_ni,STREAM_SDS, 4, offs - gap + ALIGN_SDS_BLOCK + fullsz); } else errno = ENOSPC; free(fullattr); } else errno = ENOMEM; return (res); } /* * Enter a new security descriptor in $Secure (indexes only) * * Should only be called by entersecurityattr() to ensure consistency * * Returns zero if sucessful */ static int entersecurity_indexes(ntfs_volume *vol, s64 attrsz, le32 hash, le32 keyid, off_t offs) { union { struct { le32 dataoffsl; le32 dataoffsh; } parts; le64 all; } realign; int res; ntfs_index_context *xsii; ntfs_index_context *xsdh; struct SII newsii; struct SDH newsdh; res = -1; /* enter a new $SII record */ xsii = vol->secure_xsii; ntfs_index_ctx_reinit(xsii); newsii.offs = const_cpu_to_le16(20); newsii.size = const_cpu_to_le16(sizeof(struct SII) - 20); newsii.fill1 = const_cpu_to_le32(0); newsii.indexsz = const_cpu_to_le16(sizeof(struct SII)); newsii.indexksz = const_cpu_to_le16(sizeof(SII_INDEX_KEY)); newsii.flags = const_cpu_to_le16(0); newsii.fill2 = const_cpu_to_le16(0); newsii.keysecurid = keyid; newsii.hash = hash; newsii.securid = keyid; realign.all = cpu_to_le64(offs); newsii.dataoffsh = realign.parts.dataoffsh; newsii.dataoffsl = realign.parts.dataoffsl; newsii.datasize = cpu_to_le32(attrsz + sizeof(SECURITY_DESCRIPTOR_HEADER)); if (!ntfs_ie_add(xsii,(INDEX_ENTRY*)&newsii)) { /* enter a new $SDH record */ xsdh = vol->secure_xsdh; ntfs_index_ctx_reinit(xsdh); newsdh.offs = const_cpu_to_le16(24); newsdh.size = const_cpu_to_le16( sizeof(SECURITY_DESCRIPTOR_HEADER)); newsdh.fill1 = const_cpu_to_le32(0); newsdh.indexsz = const_cpu_to_le16( sizeof(struct SDH)); newsdh.indexksz = const_cpu_to_le16( sizeof(SDH_INDEX_KEY)); newsdh.flags = const_cpu_to_le16(0); newsdh.fill2 = const_cpu_to_le16(0); newsdh.keyhash = hash; newsdh.keysecurid = keyid; newsdh.hash = hash; newsdh.securid = keyid; newsdh.dataoffsh = realign.parts.dataoffsh; newsdh.dataoffsl = realign.parts.dataoffsl; newsdh.datasize = cpu_to_le32(attrsz + sizeof(SECURITY_DESCRIPTOR_HEADER)); /* special filler value, Windows generally */ /* fills with 0x00490049, sometimes with zero */ newsdh.fill3 = const_cpu_to_le32(0x00490049); if (!ntfs_ie_add(xsdh,(INDEX_ENTRY*)&newsdh)) res = 0; } return (res); } /* * Enter a new security descriptor in $Secure (data and indexes) * Returns id of entry, or zero if there is a problem. * (should not be called for NTFS version < 3.0) * * important : calls have to be serialized, however no locking is * needed while fuse is not multithreaded */ static le32 entersecurityattr(ntfs_volume *vol, const SECURITY_DESCRIPTOR_RELATIVE *attr, s64 attrsz, le32 hash) { union { struct { le32 dataoffsl; le32 dataoffsh; } parts; le64 all; } realign; le32 securid; le32 keyid; u32 newkey; off_t offs; int gap; int size; BOOL found; struct SII *psii; INDEX_ENTRY *entry; INDEX_ENTRY *next; ntfs_index_context *xsii; int retries; ntfs_attr *na; int olderrno; /* find the first available securid beyond the last key */ /* in $Secure:$SII. This also determines the first */ /* available location in $Secure:$SDS, as this stream */ /* is always appended to and the id's are allocated */ /* in sequence */ securid = const_cpu_to_le32(0); xsii = vol->secure_xsii; ntfs_index_ctx_reinit(xsii); offs = size = 0; keyid = const_cpu_to_le32(-1); olderrno = errno; found = !ntfs_index_lookup((char*)&keyid, sizeof(SII_INDEX_KEY), xsii); if (!found && (errno != ENOENT)) { ntfs_log_perror("Inconsistency in index $SII"); psii = (struct SII*)NULL; } else { /* restore errno to avoid misinterpretation */ errno = olderrno; entry = xsii->entry; psii = (struct SII*)xsii->entry; } if (psii) { /* * Get last entry in block, but must get first one * one first, as we should already be beyond the * last one. For some reason the search for the last * entry sometimes does not return the last block... * we assume this can only happen in root block */ if (xsii->is_in_root) entry = ntfs_ie_get_first ((INDEX_HEADER*)&xsii->ir->index); else entry = ntfs_ie_get_first ((INDEX_HEADER*)&xsii->ib->index); /* * All index blocks should be at least half full * so there always is a last entry but one, * except when creating the first entry in index root. * This was however found not to be true : chkdsk * sometimes deletes all the (unused) keys in the last * index block without rebalancing the tree. * When this happens, a new search is restarted from * the smallest key. */ keyid = const_cpu_to_le32(0); retries = 0; while (entry) { next = ntfs_index_next(entry,xsii); if (next) { psii = (struct SII*)next; /* save last key and */ /* available position */ keyid = psii->keysecurid; realign.parts.dataoffsh = psii->dataoffsh; realign.parts.dataoffsl = psii->dataoffsl; offs = le64_to_cpu(realign.all); size = le32_to_cpu(psii->datasize); } entry = next; if (!entry && !keyid && !retries) { /* search failed, retry from smallest key */ ntfs_index_ctx_reinit(xsii); found = !ntfs_index_lookup((char*)&keyid, sizeof(SII_INDEX_KEY), xsii); if (!found && (errno != ENOENT)) { ntfs_log_perror("Index $SII is broken"); psii = (struct SII*)NULL; } else { /* restore errno */ errno = olderrno; entry = xsii->entry; psii = (struct SII*)entry; } if (psii && !(psii->flags & INDEX_ENTRY_END)) { /* save first key and */ /* available position */ keyid = psii->keysecurid; realign.parts.dataoffsh = psii->dataoffsh; realign.parts.dataoffsl = psii->dataoffsl; offs = le64_to_cpu(realign.all); size = le32_to_cpu(psii->datasize); } retries++; } } } if (!keyid) { /* * could not find any entry, before creating the first * entry, make a double check by making sure size of $SII * is less than needed for one entry */ securid = const_cpu_to_le32(0); na = ntfs_attr_open(vol->secure_ni,AT_INDEX_ROOT,sii_stream,4); if (na) { if ((size_t)na->data_size < (sizeof(struct SII) + sizeof(INDEX_ENTRY_HEADER))) { ntfs_log_error("Creating the first security_id\n"); securid = const_cpu_to_le32(FIRST_SECURITY_ID); } ntfs_attr_close(na); } if (!securid) { ntfs_log_error("Error creating a security_id\n"); errno = EIO; } } else { newkey = le32_to_cpu(keyid) + 1; securid = cpu_to_le32(newkey); } /* * The security attr has to be written twice 256KB * apart. This implies that offsets like * 0x40000*odd_integer must be left available for * the second copy. So align to next block when * the last byte overflows on a wrong block. */ if (securid) { gap = (-size) & (ALIGN_SDS_ENTRY - 1); offs += gap + size; if ((offs + attrsz + sizeof(SECURITY_DESCRIPTOR_HEADER) - 1) & ALIGN_SDS_BLOCK) { offs = ((offs + attrsz + sizeof(SECURITY_DESCRIPTOR_HEADER) - 1) | (ALIGN_SDS_BLOCK - 1)) + 1; } if (!(offs & (ALIGN_SDS_BLOCK - 1))) entersecurity_stuff(vol, offs); /* * now write the security attr to storage : * first data, then SII, then SDH * If failure occurs while writing SDS, data will never * be accessed through indexes, and will be overwritten * by the next allocated descriptor * If failure occurs while writing SII, the id has not * recorded and will be reallocated later * If failure occurs while writing SDH, the space allocated * in SDS or SII will not be reused, an inconsistency * will persist with no significant consequence */ if (entersecurity_data(vol, attr, attrsz, hash, securid, offs, gap) || entersecurity_indexes(vol, attrsz, hash, securid, offs)) securid = const_cpu_to_le32(0); } /* inode now is dirty, synchronize it all */ ntfs_index_entry_mark_dirty(vol->secure_xsii); ntfs_index_ctx_reinit(vol->secure_xsii); ntfs_index_entry_mark_dirty(vol->secure_xsdh); ntfs_index_ctx_reinit(vol->secure_xsdh); NInoSetDirty(vol->secure_ni); if (ntfs_inode_sync(vol->secure_ni)) ntfs_log_perror("Could not sync $Secure\n"); return (securid); } /* * Find a matching security descriptor in $Secure, * if none, allocate a new id and write the descriptor to storage * Returns id of entry, or zero if there is a problem. * * important : calls have to be serialized, however no locking is * needed while fuse is not multithreaded */ static le32 setsecurityattr(ntfs_volume *vol, const SECURITY_DESCRIPTOR_RELATIVE *attr, s64 attrsz) { struct SDH *psdh; /* this is an image of index (le) */ union { struct { le32 dataoffsl; le32 dataoffsh; } parts; le64 all; } realign; BOOL found; BOOL collision; size_t size; size_t rdsize; s64 offs; int res; ntfs_index_context *xsdh; char *oldattr; SDH_INDEX_KEY key; INDEX_ENTRY *entry; le32 securid; le32 hash; int olderrno; hash = ntfs_security_hash(attr,attrsz); oldattr = (char*)NULL; securid = const_cpu_to_le32(0); res = 0; xsdh = vol->secure_xsdh; if (vol->secure_ni && xsdh && !vol->secure_reentry++) { ntfs_index_ctx_reinit(xsdh); /* * find the nearest key as (hash,0) * (do not search for partial key : in case of collision, * it could return a key which is not the first one which * collides) */ key.hash = hash; key.security_id = const_cpu_to_le32(0); olderrno = errno; found = !ntfs_index_lookup((char*)&key, sizeof(SDH_INDEX_KEY), xsdh); if (!found && (errno != ENOENT)) ntfs_log_perror("Inconsistency in index $SDH"); else { /* restore errno to avoid misinterpretation */ errno = olderrno; entry = xsdh->entry; found = FALSE; /* * lookup() may return a node with no data, * if so get next */ if (entry->ie_flags & INDEX_ENTRY_END) entry = ntfs_index_next(entry,xsdh); do { collision = FALSE; psdh = (struct SDH*)entry; if (psdh) size = (size_t) le32_to_cpu(psdh->datasize) - sizeof(SECURITY_DESCRIPTOR_HEADER); else size = 0; /* if hash is not the same, the key is not present */ if (psdh && (size > 0) && (psdh->keyhash == hash)) { /* if hash is the same */ /* check the whole record */ realign.parts.dataoffsh = psdh->dataoffsh; realign.parts.dataoffsl = psdh->dataoffsl; offs = le64_to_cpu(realign.all) + sizeof(SECURITY_DESCRIPTOR_HEADER); oldattr = (char*)ntfs_malloc(size); if (oldattr) { rdsize = ntfs_attr_data_read( vol->secure_ni, STREAM_SDS, 4, oldattr, size, offs); found = (rdsize == size) && !memcmp(oldattr,attr,size); free(oldattr); /* if the records do not compare */ /* (hash collision), try next one */ if (!found) { entry = ntfs_index_next( entry,xsdh); collision = TRUE; } } else res = ENOMEM; } } while (collision && entry); if (found) securid = psdh->keysecurid; else { if (res) { errno = res; securid = const_cpu_to_le32(0); } else { /* * no matching key : * have to build a new one */ securid = entersecurityattr(vol, attr, attrsz, hash); } } } } if (--vol->secure_reentry) ntfs_log_perror("Reentry error, check no multithreading\n"); return (securid); } /* * Update the security descriptor of a file * Either as an attribute (complying with pre v3.x NTFS version) * or, when possible, as an entry in $Secure (for NTFS v3.x) * * returns 0 if success */ static int update_secur_descr(ntfs_volume *vol, char *newattr, ntfs_inode *ni) { int newattrsz; int written; int res; ntfs_attr *na; newattrsz = ntfs_attr_size(newattr); #if !FORCE_FORMAT_v1x if ((vol->major_ver < 3) || !vol->secure_ni) { #endif /* update for NTFS format v1.x */ /* update the old security attribute */ na = ntfs_attr_open(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0); if (na) { /* resize attribute */ res = ntfs_attr_truncate(na, (s64) newattrsz); /* overwrite value */ if (!res) { written = (int)ntfs_attr_pwrite(na, (s64) 0, (s64) newattrsz, newattr); if (written != newattrsz) { ntfs_log_error("Failed to update " "a v1.x security descriptor\n"); errno = EIO; res = -1; } } ntfs_attr_close(na); /* if old security attribute was found, also */ /* truncate standard information attribute to v1.x */ /* this is needed when security data is wanted */ /* as v1.x though volume is formatted for v3.x */ na = ntfs_attr_open(ni, AT_STANDARD_INFORMATION, AT_UNNAMED, 0); if (na) { clear_nino_flag(ni, v3_Extensions); /* * Truncating the record does not sweep extensions * from copy in memory. Clear security_id to be safe */ ni->security_id = const_cpu_to_le32(0); res = ntfs_attr_truncate(na, (s64)48); ntfs_attr_close(na); clear_nino_flag(ni, v3_Extensions); } } else { /* * insert the new security attribute if there * were none */ res = ntfs_attr_add(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0, (u8*)newattr, (s64) newattrsz); } #if !FORCE_FORMAT_v1x } else { /* update for NTFS format v3.x */ le32 securid; securid = setsecurityattr(vol, (const SECURITY_DESCRIPTOR_RELATIVE*)newattr, (s64)newattrsz); if (securid) { na = ntfs_attr_open(ni, AT_STANDARD_INFORMATION, AT_UNNAMED, 0); if (na) { res = 0; if (!test_nino_flag(ni, v3_Extensions)) { /* expand standard information attribute to v3.x */ res = ntfs_attr_truncate(na, (s64)sizeof(STANDARD_INFORMATION)); ni->owner_id = const_cpu_to_le32(0); ni->quota_charged = const_cpu_to_le64(0); ni->usn = const_cpu_to_le64(0); ntfs_attr_remove(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0); } set_nino_flag(ni, v3_Extensions); ni->security_id = securid; ntfs_attr_close(na); } else { ntfs_log_error("Failed to update " "standard informations\n"); errno = EIO; res = -1; } } else res = -1; } #endif /* mark node as dirty */ NInoSetDirty(ni); return (res); } /* * Upgrade the security descriptor of a file * This is intended to allow graceful upgrades for files which * were created in previous versions, with a security attributes * and no security id. * * It will allocate a security id and replace the individual * security attribute by a reference to the global one * * Special files are not upgraded (currently / and files in * directories /$*) * * Though most code is similar to update_secur_desc() it has * been kept apart to facilitate the further processing of * special cases or even to remove it if found dangerous. * * returns 0 if success, * 1 if not upgradable. This is not an error. * -1 if there is a problem */ static int upgrade_secur_desc(ntfs_volume *vol, const char *attr, ntfs_inode *ni) { int attrsz; int res; le32 securid; ntfs_attr *na; /* * upgrade requires NTFS format v3.x * also refuse upgrading for special files. */ if ((vol->major_ver >= 3) && (!utils_is_metadata(ni))) { attrsz = ntfs_attr_size(attr); securid = setsecurityattr(vol, (const SECURITY_DESCRIPTOR_RELATIVE*)attr, (s64)attrsz); if (securid) { na = ntfs_attr_open(ni, AT_STANDARD_INFORMATION, AT_UNNAMED, 0); if (na) { /* expand standard information attribute to v3.x */ res = ntfs_attr_truncate(na, (s64)sizeof(STANDARD_INFORMATION)); ni->owner_id = const_cpu_to_le32(0); ni->quota_charged = const_cpu_to_le64(0); ni->usn = const_cpu_to_le64(0); ntfs_attr_remove(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0); set_nino_flag(ni, v3_Extensions); ni->security_id = securid; ntfs_attr_close(na); } else { ntfs_log_error("Failed to upgrade " "standard informations\n"); errno = EIO; res = -1; } } else res = -1; /* mark node as dirty */ NInoSetDirty(ni); } else res = 1; return (res); } /* * Optional simplified checking of group membership * * This only takes into account the groups defined in * /etc/group at initialization time. * It does not take into account the groups dynamically set by * setgroups() nor the changes in /etc/group since initialization * * This optional method could be useful if standard checking * leads to a performance concern. * * Should not be called for user root, however the group may be root * */ static BOOL staticgroupmember(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid) { BOOL ingroup; int grcnt; gid_t *groups; struct MAPPING *user; ingroup = FALSE; if (uid) { user = scx->mapping[MAPUSERS]; while (user && ((uid_t)user->xid != uid)) user = user->next; if (user) { groups = user->groups; grcnt = user->grcnt; while ((--grcnt >= 0) && (groups[grcnt] != gid)) { } ingroup = (grcnt >= 0); } } return (ingroup); } #if defined(__sun) && defined (__SVR4) /* * Check whether current thread owner is member of file group * Solaris/OpenIndiana version * Should not be called for user root, however the group may be root * * The group list is available in "/proc/$PID/cred" * */ static BOOL groupmember(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid) { typedef struct prcred { uid_t pr_euid; /* effective user id */ uid_t pr_ruid; /* real user id */ uid_t pr_suid; /* saved user id (from exec) */ gid_t pr_egid; /* effective group id */ gid_t pr_rgid; /* real group id */ gid_t pr_sgid; /* saved group id (from exec) */ int pr_ngroups; /* number of supplementary groups */ gid_t pr_groups[1]; /* array of supplementary groups */ } prcred_t; enum { readset = 16 }; prcred_t basecreds; gid_t groups[readset]; char filename[64]; int fd; int k; int cnt; gid_t *p; BOOL ismember; int got; pid_t tid; if (scx->vol->secure_flags & (1 << SECURITY_STATICGRPS)) ismember = staticgroupmember(scx, uid, gid); else { ismember = FALSE; /* default return */ tid = scx->tid; sprintf(filename,"/proc/%u/cred",tid); fd = open(filename,O_RDONLY); if (fd >= 0) { got = read(fd, &basecreds, sizeof(prcred_t)); if (got == sizeof(prcred_t)) { if (basecreds.pr_egid == gid) ismember = TRUE; p = basecreds.pr_groups; cnt = 1; k = 0; while (!ismember && (k < basecreds.pr_ngroups) && (cnt > 0) && (*p != gid)) { k++; cnt--; p++; if (cnt <= 0) { got = read(fd, groups, readset*sizeof(gid_t)); cnt = got/sizeof(gid_t); p = groups; } } if ((cnt > 0) && (k < basecreds.pr_ngroups)) ismember = TRUE; } close(fd); } } return (ismember); } #else /* defined(__sun) && defined (__SVR4) */ /* * Check whether current thread owner is member of file group * Linux version * Should not be called for user root, however the group may be root * * As indicated by Miklos Szeredi : * * The group list is available in * * /proc/$PID/task/$TID/status * * and fuse supplies TID in get_fuse_context()->pid. The only problem is * finding out PID, for which I have no good solution, except to iterate * through all processes. This is rather slow, but may be speeded up * with caching and heuristics (for single threaded programs PID = TID). * * The following implementation gets the group list from * /proc/$TID/task/$TID/status which apparently exists and * contains the same data. */ static BOOL groupmember(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid) { static char key[] = "\nGroups:"; char buf[BUFSZ+1]; char filename[64]; enum { INKEY, INSEP, INNUM, INEND } state; int fd; char c; int matched; BOOL ismember; int got; char *p; gid_t grp; pid_t tid; if (scx->vol->secure_flags & (1 << SECURITY_STATICGRPS)) ismember = staticgroupmember(scx, uid, gid); else { ismember = FALSE; /* default return */ tid = scx->tid; sprintf(filename,"/proc/%u/task/%u/status",tid,tid); fd = open(filename,O_RDONLY); if (fd >= 0) { got = read(fd, buf, BUFSZ); if (got <= 0) { close(fd); return FALSE; } buf[got] = 0; state = INKEY; matched = 0; p = buf; grp = 0; /* * A simple automaton to process lines like * Groups: 14 500 513 */ do { c = *p++; if (!c) { /* refill buffer */ got = read(fd, buf, BUFSZ); if (got <= 0) { close(fd); return FALSE; } buf[got] = 0; p = buf; c = *p++; /* 0 at end of file */ } switch (state) { case INKEY : if (key[matched] == c) { if (!key[++matched]) state = INSEP; } else if (key[0] == c) matched = 1; else matched = 0; break; case INSEP : if ((c >= '0') && (c <= '9')) { grp = c - '0'; state = INNUM; } else if ((c != ' ') && (c != '\t')) state = INEND; break; case INNUM : if ((c >= '0') && (c <= '9')) grp = grp*10 + c - '0'; else { ismember = (grp == gid); if ((c != ' ') && (c != '\t')) state = INEND; else state = INSEP; } default : break; } } while (!ismember && c && (state != INEND)); close(fd); if (!c) ntfs_log_error("No group record found in %s\n",filename); } else ntfs_log_error("Could not open %s\n",filename); } return (ismember); } #endif /* defined(__sun) && defined (__SVR4) */ #if POSIXACLS /* * Extract the basic permissions from a Posix ACL * * This is only to be used when Posix ACLs are compiled in, * but not enabled in the mount options. * * it replaces the permission mask by the group permissions. * If special groups are mapped, they are also considered as world. */ static int ntfs_basic_perms(const struct SECURITY_CONTEXT *scx, const struct POSIX_SECURITY *pxdesc) { int k; int perms; const struct POSIX_ACE *pace; const struct MAPPING* group; k = 0; perms = pxdesc->mode; for (k=0; k < pxdesc->acccnt; k++) { pace = &pxdesc->acl.ace[k]; if (pace->tag == POSIX_ACL_GROUP_OBJ) perms = (perms & 07707) | ((pace->perms & 7) << 3); else if (pace->tag == POSIX_ACL_GROUP) { group = scx->mapping[MAPGROUPS]; while (group && (group->xid != pace->id)) group = group->next; if (group && group->grcnt && (*(group->groups) == (gid_t)pace->id)) perms |= pace->perms & 7; } } return (perms); } #endif /* POSIXACLS */ /* * Cacheing is done two-way : * - from uid, gid and perm to securid (CACHED_SECURID) * - from a securid to uid, gid and perm (CACHED_PERMISSIONS) * * CACHED_SECURID data is kept in a most-recent-first list * which should not be too long to be efficient. Its optimal * size is depends on usage and is hard to determine. * * CACHED_PERMISSIONS data is kept in a two-level indexed array. It * is optimal at the expense of storage. Use of a most-recent-first * list would save memory and provide similar performances for * standard usage, but not for file servers with too many file * owners * * CACHED_PERMISSIONS_LEGACY is a special case for CACHED_PERMISSIONS * for legacy directories which were not allocated a security_id * it is organized in a most-recent-first list. * * In main caches, data is never invalidated, as the meaning of * a security_id only changes when user mapping is changed, which * current implies remounting. However returned entries may be * overwritten at next update, so data has to be copied elsewhere * before another cache update is made. * In legacy cache, data has to be invalidated when protection is * changed. * * Though the same data may be found in both list, they * must be kept separately : the interpretation of ACL * in both direction are approximations which could be non * reciprocal for some configuration of the user mapping data * * During the process of recompiling ntfs-3g from a tgz archive, * security processing added 7.6% to the cpu time used by ntfs-3g * and 30% if the cache is disabled. */ static struct PERMISSIONS_CACHE *create_caches(struct SECURITY_CONTEXT *scx, u32 securindex) { struct PERMISSIONS_CACHE *cache; unsigned int index1; unsigned int i; cache = (struct PERMISSIONS_CACHE*)NULL; /* create the first permissions blocks */ index1 = securindex >> CACHE_PERMISSIONS_BITS; cache = (struct PERMISSIONS_CACHE*) ntfs_malloc(sizeof(struct PERMISSIONS_CACHE) + index1*sizeof(struct CACHED_PERMISSIONS*)); if (cache) { cache->head.last = index1; cache->head.p_reads = 0; cache->head.p_hits = 0; cache->head.p_writes = 0; *scx->pseccache = cache; for (i=0; i<=index1; i++) cache->cachetable[i] = (struct CACHED_PERMISSIONS*)NULL; } return (cache); } /* * Free memory used by caches * The only purpose is to facilitate the detection of memory leaks */ static void free_caches(struct SECURITY_CONTEXT *scx) { unsigned int index1; struct PERMISSIONS_CACHE *pseccache; pseccache = *scx->pseccache; if (pseccache) { for (index1=0; index1<=pseccache->head.last; index1++) if (pseccache->cachetable[index1]) { #if POSIXACLS struct CACHED_PERMISSIONS *cacheentry; unsigned int index2; for (index2=0; index2<(1<< CACHE_PERMISSIONS_BITS); index2++) { cacheentry = &pseccache->cachetable[index1][index2]; if (cacheentry->valid && cacheentry->pxdesc) free(cacheentry->pxdesc); } #endif free(pseccache->cachetable[index1]); } free(pseccache); } } static int compare(const struct CACHED_SECURID *cached, const struct CACHED_SECURID *item) { #if POSIXACLS size_t csize; size_t isize; /* only compare data and sizes */ csize = (cached->variable ? sizeof(struct POSIX_ACL) + (((struct POSIX_SECURITY*)cached->variable)->acccnt + ((struct POSIX_SECURITY*)cached->variable)->defcnt) *sizeof(struct POSIX_ACE) : 0); isize = (item->variable ? sizeof(struct POSIX_ACL) + (((struct POSIX_SECURITY*)item->variable)->acccnt + ((struct POSIX_SECURITY*)item->variable)->defcnt) *sizeof(struct POSIX_ACE) : 0); return ((cached->uid != item->uid) || (cached->gid != item->gid) || (cached->dmode != item->dmode) || (csize != isize) || (csize && isize && memcmp(&((struct POSIX_SECURITY*)cached->variable)->acl, &((struct POSIX_SECURITY*)item->variable)->acl, csize))); #else return ((cached->uid != item->uid) || (cached->gid != item->gid) || (cached->dmode != item->dmode)); #endif } static int leg_compare(const struct CACHED_PERMISSIONS_LEGACY *cached, const struct CACHED_PERMISSIONS_LEGACY *item) { return (cached->mft_no != item->mft_no); } /* * Resize permission cache table * do not call unless resizing is needed * * If allocation fails, the cache size is not updated * Lack of memory is not considered as an error, the cache is left * consistent and errno is not set. */ static void resize_cache(struct SECURITY_CONTEXT *scx, u32 securindex) { struct PERMISSIONS_CACHE *oldcache; struct PERMISSIONS_CACHE *newcache; int newcnt; int oldcnt; unsigned int index1; unsigned int i; oldcache = *scx->pseccache; index1 = securindex >> CACHE_PERMISSIONS_BITS; newcnt = index1 + 1; if (newcnt <= ((CACHE_PERMISSIONS_SIZE + (1 << CACHE_PERMISSIONS_BITS) - 1) >> CACHE_PERMISSIONS_BITS)) { /* expand cache beyond current end, do not use realloc() */ /* to avoid losing data when there is no more memory */ oldcnt = oldcache->head.last + 1; newcache = (struct PERMISSIONS_CACHE*) ntfs_malloc( sizeof(struct PERMISSIONS_CACHE) + (newcnt - 1)*sizeof(struct CACHED_PERMISSIONS*)); if (newcache) { memcpy(newcache,oldcache, sizeof(struct PERMISSIONS_CACHE) + (oldcnt - 1)*sizeof(struct CACHED_PERMISSIONS*)); free(oldcache); /* mark new entries as not valid */ for (i=newcache->head.last+1; i<=index1; i++) newcache->cachetable[i] = (struct CACHED_PERMISSIONS*)NULL; newcache->head.last = index1; *scx->pseccache = newcache; } } } /* * Enter uid, gid and mode into cache, if possible * * returns the updated or created cache entry, * or NULL if not possible (typically if there is no * security id associated) */ #if POSIXACLS static struct CACHED_PERMISSIONS *enter_cache(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, struct POSIX_SECURITY *pxdesc) #else static struct CACHED_PERMISSIONS *enter_cache(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode) #endif { struct CACHED_PERMISSIONS *cacheentry; struct CACHED_PERMISSIONS *cacheblock; struct PERMISSIONS_CACHE *pcache; u32 securindex; #if POSIXACLS int pxsize; struct POSIX_SECURITY *pxcached; #endif unsigned int index1; unsigned int index2; int i; /* cacheing is only possible if a security_id has been defined */ if (test_nino_flag(ni, v3_Extensions) && ni->security_id) { /* * Immediately test the most frequent situation * where the entry exists */ securindex = le32_to_cpu(ni->security_id); index1 = securindex >> CACHE_PERMISSIONS_BITS; index2 = securindex & ((1 << CACHE_PERMISSIONS_BITS) - 1); pcache = *scx->pseccache; if (pcache && (pcache->head.last >= index1) && pcache->cachetable[index1]) { cacheentry = &pcache->cachetable[index1][index2]; cacheentry->uid = uid; cacheentry->gid = gid; #if POSIXACLS if (cacheentry->valid && cacheentry->pxdesc) free(cacheentry->pxdesc); if (pxdesc) { pxsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); pxcached = (struct POSIX_SECURITY*)malloc(pxsize); if (pxcached) { memcpy(pxcached, pxdesc, pxsize); cacheentry->pxdesc = pxcached; } else { cacheentry->valid = 0; cacheentry = (struct CACHED_PERMISSIONS*)NULL; } cacheentry->mode = pxdesc->mode & 07777; } else cacheentry->pxdesc = (struct POSIX_SECURITY*)NULL; #else cacheentry->mode = mode & 07777; #endif cacheentry->inh_fileid = const_cpu_to_le32(0); cacheentry->inh_dirid = const_cpu_to_le32(0); cacheentry->valid = 1; pcache->head.p_writes++; } else { if (!pcache) { /* create the first cache block */ pcache = create_caches(scx, securindex); } else { if (index1 > pcache->head.last) { resize_cache(scx, securindex); pcache = *scx->pseccache; } } /* allocate block, if cache table was allocated */ if (pcache && (index1 <= pcache->head.last)) { cacheblock = (struct CACHED_PERMISSIONS*) malloc(sizeof(struct CACHED_PERMISSIONS) << CACHE_PERMISSIONS_BITS); pcache->cachetable[index1] = cacheblock; for (i=0; i<(1 << CACHE_PERMISSIONS_BITS); i++) cacheblock[i].valid = 0; cacheentry = &cacheblock[index2]; if (cacheentry) { cacheentry->uid = uid; cacheentry->gid = gid; #if POSIXACLS if (pxdesc) { pxsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); pxcached = (struct POSIX_SECURITY*)malloc(pxsize); if (pxcached) { memcpy(pxcached, pxdesc, pxsize); cacheentry->pxdesc = pxcached; } else { cacheentry->valid = 0; cacheentry = (struct CACHED_PERMISSIONS*)NULL; } cacheentry->mode = pxdesc->mode & 07777; } else cacheentry->pxdesc = (struct POSIX_SECURITY*)NULL; #else cacheentry->mode = mode & 07777; #endif cacheentry->inh_fileid = const_cpu_to_le32(0); cacheentry->inh_dirid = const_cpu_to_le32(0); cacheentry->valid = 1; pcache->head.p_writes++; } } else cacheentry = (struct CACHED_PERMISSIONS*)NULL; } } else { cacheentry = (struct CACHED_PERMISSIONS*)NULL; #if CACHE_LEGACY_SIZE if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { struct CACHED_PERMISSIONS_LEGACY wanted; struct CACHED_PERMISSIONS_LEGACY *legacy; wanted.perm.uid = uid; wanted.perm.gid = gid; #if POSIXACLS wanted.perm.mode = pxdesc->mode & 07777; wanted.perm.inh_fileid = const_cpu_to_le32(0); wanted.perm.inh_dirid = const_cpu_to_le32(0); wanted.mft_no = ni->mft_no; wanted.variable = (void*)pxdesc; wanted.varsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); #else wanted.perm.mode = mode & 07777; wanted.perm.inh_fileid = const_cpu_to_le32(0); wanted.perm.inh_dirid = const_cpu_to_le32(0); wanted.mft_no = ni->mft_no; wanted.variable = (void*)NULL; wanted.varsize = 0; #endif legacy = (struct CACHED_PERMISSIONS_LEGACY*)ntfs_enter_cache( scx->vol->legacy_cache, GENERIC(&wanted), (cache_compare)leg_compare); if (legacy) { cacheentry = &legacy->perm; #if POSIXACLS /* * give direct access to the cached pxdesc * in the permissions structure */ cacheentry->pxdesc = legacy->variable; #endif } } #endif } return (cacheentry); } /* * Fetch owner, group and permission of a file, if cached * * Beware : do not use the returned entry after a cache update : * the cache may be relocated making the returned entry meaningless * * returns the cache entry, or NULL if not available */ static struct CACHED_PERMISSIONS *fetch_cache(struct SECURITY_CONTEXT *scx, ntfs_inode *ni) { struct CACHED_PERMISSIONS *cacheentry; struct PERMISSIONS_CACHE *pcache; u32 securindex; unsigned int index1; unsigned int index2; /* cacheing is only possible if a security_id has been defined */ cacheentry = (struct CACHED_PERMISSIONS*)NULL; if (test_nino_flag(ni, v3_Extensions) && (ni->security_id)) { securindex = le32_to_cpu(ni->security_id); index1 = securindex >> CACHE_PERMISSIONS_BITS; index2 = securindex & ((1 << CACHE_PERMISSIONS_BITS) - 1); pcache = *scx->pseccache; if (pcache && (pcache->head.last >= index1) && pcache->cachetable[index1]) { cacheentry = &pcache->cachetable[index1][index2]; /* reject if entry is not valid */ if (!cacheentry->valid) cacheentry = (struct CACHED_PERMISSIONS*)NULL; else pcache->head.p_hits++; if (pcache) pcache->head.p_reads++; } } #if CACHE_LEGACY_SIZE else { cacheentry = (struct CACHED_PERMISSIONS*)NULL; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { struct CACHED_PERMISSIONS_LEGACY wanted; struct CACHED_PERMISSIONS_LEGACY *legacy; wanted.mft_no = ni->mft_no; wanted.variable = (void*)NULL; wanted.varsize = 0; legacy = (struct CACHED_PERMISSIONS_LEGACY*)ntfs_fetch_cache( scx->vol->legacy_cache, GENERIC(&wanted), (cache_compare)leg_compare); if (legacy) cacheentry = &legacy->perm; } } #endif #if POSIXACLS if (cacheentry && !cacheentry->pxdesc) { ntfs_log_error("No Posix descriptor in cache\n"); cacheentry = (struct CACHED_PERMISSIONS*)NULL; } #endif return (cacheentry); } /* * Retrieve a security attribute from $Secure */ static char *retrievesecurityattr(ntfs_volume *vol, SII_INDEX_KEY id) { struct SII *psii; union { struct { le32 dataoffsl; le32 dataoffsh; } parts; le64 all; } realign; int found; size_t size; size_t rdsize; s64 offs; ntfs_inode *ni; ntfs_index_context *xsii; char *securattr; securattr = (char*)NULL; ni = vol->secure_ni; xsii = vol->secure_xsii; if (ni && xsii) { ntfs_index_ctx_reinit(xsii); found = !ntfs_index_lookup((char*)&id, sizeof(SII_INDEX_KEY), xsii); if (found) { psii = (struct SII*)xsii->entry; size = (size_t) le32_to_cpu(psii->datasize) - sizeof(SECURITY_DESCRIPTOR_HEADER); /* work around bad alignment problem */ realign.parts.dataoffsh = psii->dataoffsh; realign.parts.dataoffsl = psii->dataoffsl; offs = le64_to_cpu(realign.all) + sizeof(SECURITY_DESCRIPTOR_HEADER); securattr = (char*)ntfs_malloc(size); if (securattr) { rdsize = ntfs_attr_data_read( ni, STREAM_SDS, 4, securattr, size, offs); if ((rdsize != size) || !ntfs_valid_descr(securattr, rdsize)) { /* error to be logged by caller */ free(securattr); securattr = (char*)NULL; } } } else if (errno != ENOENT) ntfs_log_perror("Inconsistency in index $SII"); } if (!securattr) { ntfs_log_error("Failed to retrieve a security descriptor\n"); errno = EIO; } return (securattr); } /* * Get the security descriptor associated to a file * * Either : * - read the security descriptor attribute (v1.x format) * - or find the descriptor in $Secure:$SDS (v3.x format) * * in both case, sanity checks are done on the attribute and * the descriptor can be assumed safe * * The returned descriptor is dynamically allocated and has to be freed */ static char *getsecurityattr(ntfs_volume *vol, ntfs_inode *ni) { SII_INDEX_KEY securid; char *securattr; s64 readallsz; /* * Warning : in some situations, after fixing by chkdsk, * v3_Extensions are marked present (long standard informations) * with a default security descriptor inserted in an * attribute */ if (test_nino_flag(ni, v3_Extensions) && vol->secure_ni && ni->security_id) { /* get v3.x descriptor in $Secure */ securid.security_id = ni->security_id; securattr = retrievesecurityattr(vol,securid); if (!securattr) ntfs_log_error("Bad security descriptor for 0x%lx\n", (long)le32_to_cpu(ni->security_id)); } else { /* get v1.x security attribute */ readallsz = 0; securattr = ntfs_attr_readall(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0, &readallsz); if (securattr && !ntfs_valid_descr(securattr, readallsz)) { ntfs_log_error("Bad security descriptor for inode %lld\n", (long long)ni->mft_no); free(securattr); securattr = (char*)NULL; } } if (!securattr) { /* * in some situations, there is no security * descriptor, and chkdsk does not detect or fix * anything. This could be a normal situation. * When this happens, simulate a descriptor with * minimum rights, so that a real descriptor can * be created by chown or chmod */ ntfs_log_error("No security descriptor found for inode %lld\n", (long long)ni->mft_no); securattr = ntfs_build_descr(0, 0, adminsid, adminsid); } return (securattr); } #if POSIXACLS /* * Determine which access types to a file are allowed * according to the relation of current process to the file * * When Posix ACLs are compiled in but not enabled in the mount * options POSIX_ACL_USER, POSIX_ACL_GROUP and POSIX_ACL_MASK * are ignored. */ static int access_check_posix(struct SECURITY_CONTEXT *scx, struct POSIX_SECURITY *pxdesc, mode_t request, uid_t uid, gid_t gid) { struct POSIX_ACE *pxace; int userperms; int groupperms; int mask; BOOL somegroup; BOOL needgroups; BOOL noacl; mode_t perms; int i; noacl = !(scx->vol->secure_flags & (1 << SECURITY_ACL)); if (noacl) perms = ntfs_basic_perms(scx, pxdesc); else perms = pxdesc->mode; /* owner and root access */ if (!scx->uid || (uid == scx->uid)) { if (!scx->uid) { /* root access if owner or other execution */ if (perms & 0101) perms |= 01777; else { /* root access if some group execution */ groupperms = 0; mask = 7; for (i=pxdesc->acccnt-1; i>=0 ; i--) { pxace = &pxdesc->acl.ace[i]; switch (pxace->tag) { case POSIX_ACL_USER_OBJ : case POSIX_ACL_GROUP_OBJ : groupperms |= pxace->perms; break; case POSIX_ACL_GROUP : if (!noacl) groupperms |= pxace->perms; break; case POSIX_ACL_MASK : if (!noacl) mask = pxace->perms & 7; break; default : break; } } perms = (groupperms & mask & 1) | 6; } } else perms &= 07700; } else { /* * analyze designated users, get mask * and identify whether we need to check * the group memberships. The groups are * not needed when all groups have the * same permissions as other for the * requested modes. */ userperms = -1; groupperms = -1; needgroups = FALSE; mask = 7; for (i=pxdesc->acccnt-1; i>=0 ; i--) { pxace = &pxdesc->acl.ace[i]; switch (pxace->tag) { case POSIX_ACL_USER : if (!noacl && ((uid_t)pxace->id == scx->uid)) userperms = pxace->perms; break; case POSIX_ACL_MASK : if (!noacl) mask = pxace->perms & 7; break; case POSIX_ACL_GROUP_OBJ : if (((pxace->perms & mask) ^ perms) & (request >> 6) & 7) needgroups = TRUE; break; case POSIX_ACL_GROUP : if (!noacl && (((pxace->perms & mask) ^ perms) & (request >> 6) & 7)) needgroups = TRUE; break; default : break; } } /* designated users */ if (userperms >= 0) perms = (perms & 07000) + (userperms & mask); else if (!needgroups) perms &= 07007; else { /* owning group */ if (!(~(perms >> 3) & request & mask) && ((gid == scx->gid) || groupmember(scx, scx->uid, gid))) perms &= 07070; else if (!noacl) { /* other groups */ groupperms = -1; somegroup = FALSE; for (i=pxdesc->acccnt-1; i>=0 ; i--) { pxace = &pxdesc->acl.ace[i]; if ((pxace->tag == POSIX_ACL_GROUP) && groupmember(scx, scx->uid, pxace->id)) { if (!(~pxace->perms & request & mask)) groupperms = pxace->perms; somegroup = TRUE; } } if (groupperms >= 0) perms = (perms & 07000) + (groupperms & mask); else if (somegroup) perms = 0; else perms &= 07007; } else perms &= 07007; } } return (perms); } /* * Get permissions to access a file * Takes into account the relation of user to file (owner, group, ...) * Do no use as mode of the file * Do no call if default_permissions is set * * returns -1 if there is a problem */ static int ntfs_get_perm(struct SECURITY_CONTEXT *scx, ntfs_inode * ni, mode_t request) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const struct CACHED_PERMISSIONS *cached; char *securattr; const SID *usid; /* owner of file/directory */ const SID *gsid; /* group of file/directory */ uid_t uid; gid_t gid; int perm; BOOL isdir; struct POSIX_SECURITY *pxdesc; if (!scx->mapping[MAPUSERS]) perm = 07777; else { /* check whether available in cache */ cached = fetch_cache(scx,ni); if (cached) { uid = cached->uid; gid = cached->gid; perm = access_check_posix(scx,cached->pxdesc,request,uid,gid); } else { perm = 0; /* default to no permission */ isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); securattr = getsecurityattr(scx->vol, ni); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*) securattr; gsid = (const SID*)& securattr[le32_to_cpu(phead->group)]; gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); #if OWNERFROMACL usid = ntfs_acl_owner(securattr); pxdesc = ntfs_build_permissions_posix(scx->mapping,securattr, usid, gsid, isdir); if (pxdesc) perm = pxdesc->mode & 07777; else perm = -1; uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #else usid = (const SID*)& securattr[le32_to_cpu(phead->owner)]; pxdesc = ntfs_build_permissions_posix(scx,securattr, usid, gsid, isdir); if (pxdesc) perm = pxdesc->mode & 07777; else perm = -1; if (!perm && ntfs_same_sid(usid, adminsid)) { uid = find_tenant(scx, securattr); if (uid) perm = 0700; } else uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #endif /* * Create a security id if there were none * and upgrade option is selected */ if (!test_nino_flag(ni, v3_Extensions) && (perm >= 0) && (scx->vol->secure_flags & (1 << SECURITY_ADDSECURIDS))) { upgrade_secur_desc(scx->vol, securattr, ni); /* * fetch owner and group for cacheing * if there is a securid */ } if (test_nino_flag(ni, v3_Extensions) && (perm >= 0)) { enter_cache(scx, ni, uid, gid, pxdesc); } if (pxdesc) { perm = access_check_posix(scx,pxdesc,request,uid,gid); free(pxdesc); } free(securattr); } else { perm = -1; uid = gid = 0; } } } return (perm); } /* * Get a Posix ACL * * returns size or -errno if there is a problem * if size was too small, no copy is done and errno is not set, * the caller is expected to issue a new call */ int ntfs_get_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name, char *value, size_t size) { const SECURITY_DESCRIPTOR_RELATIVE *phead; struct POSIX_SECURITY *pxdesc; const struct CACHED_PERMISSIONS *cached; char *securattr; const SID *usid; /* owner of file/directory */ const SID *gsid; /* group of file/directory */ uid_t uid; gid_t gid; BOOL isdir; size_t outsize; outsize = 0; /* default to error */ if (!scx->mapping[MAPUSERS]) errno = ENOTSUP; else { /* check whether available in cache */ cached = fetch_cache(scx,ni); if (cached) pxdesc = cached->pxdesc; else { securattr = getsecurityattr(scx->vol, ni); isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*) securattr; gsid = (const SID*)& securattr[le32_to_cpu(phead->group)]; #if OWNERFROMACL usid = ntfs_acl_owner(securattr); #else usid = (const SID*)& securattr[le32_to_cpu(phead->owner)]; #endif pxdesc = ntfs_build_permissions_posix(scx->mapping,securattr, usid, gsid, isdir); /* * fetch owner and group for cacheing */ if (pxdesc) { /* * Create a security id if there were none * and upgrade option is selected */ if (!test_nino_flag(ni, v3_Extensions) && (scx->vol->secure_flags & (1 << SECURITY_ADDSECURIDS))) { upgrade_secur_desc(scx->vol, securattr, ni); } #if OWNERFROMACL uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #else if (!(pxdesc->mode & 07777) && ntfs_same_sid(usid, adminsid)) { uid = find_tenant(scx, securattr); } else uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #endif gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); if (pxdesc->tagsset & POSIX_ACL_EXTENSIONS) enter_cache(scx, ni, uid, gid, pxdesc); } free(securattr); } else pxdesc = (struct POSIX_SECURITY*)NULL; } if (pxdesc) { if (ntfs_valid_posix(pxdesc)) { if (!strcmp(name,"system.posix_acl_default")) { if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) outsize = sizeof(struct POSIX_ACL) + pxdesc->defcnt*sizeof(struct POSIX_ACE); else { /* * getting default ACL from plain file : * return EACCES if size > 0 as * indicated in the man, but return ok * if size == 0, so that ls does not * display an error */ if (size > 0) { outsize = 0; errno = EACCES; } else outsize = sizeof(struct POSIX_ACL); } if (outsize && (outsize <= size)) { memcpy(value,&pxdesc->acl,sizeof(struct POSIX_ACL)); memcpy(&value[sizeof(struct POSIX_ACL)], &pxdesc->acl.ace[pxdesc->firstdef], outsize-sizeof(struct POSIX_ACL)); } } else { outsize = sizeof(struct POSIX_ACL) + pxdesc->acccnt*sizeof(struct POSIX_ACE); if (outsize <= size) memcpy(value,&pxdesc->acl,outsize); } } else { outsize = 0; errno = EIO; ntfs_log_error("Invalid Posix ACL built\n"); } if (!cached) free(pxdesc); } else outsize = 0; } return (outsize ? (int)outsize : -errno); } #else /* POSIXACLS */ /* * Get permissions to access a file * Takes into account the relation of user to file (owner, group, ...) * Do no use as mode of the file * * returns -1 if there is a problem */ static int ntfs_get_perm(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, mode_t request) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const struct CACHED_PERMISSIONS *cached; char *securattr; const SID *usid; /* owner of file/directory */ const SID *gsid; /* group of file/directory */ BOOL isdir; uid_t uid; gid_t gid; int perm; if (!scx->mapping[MAPUSERS] || (!scx->uid && !(request & S_IEXEC))) perm = 07777; else { /* check whether available in cache */ cached = fetch_cache(scx,ni); if (cached) { perm = cached->mode; uid = cached->uid; gid = cached->gid; } else { perm = 0; /* default to no permission */ isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); securattr = getsecurityattr(scx->vol, ni); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*) securattr; gsid = (const SID*)& securattr[le32_to_cpu(phead->group)]; gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); #if OWNERFROMACL usid = ntfs_acl_owner(securattr); perm = ntfs_build_permissions(securattr, usid, gsid, isdir); uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #else usid = (const SID*)& securattr[le32_to_cpu(phead->owner)]; perm = ntfs_build_permissions(securattr, usid, gsid, isdir); if (!perm && ntfs_same_sid(usid, adminsid)) { uid = find_tenant(scx, securattr); if (uid) perm = 0700; } else uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #endif /* * Create a security id if there were none * and upgrade option is selected */ if (!test_nino_flag(ni, v3_Extensions) && (perm >= 0) && (scx->vol->secure_flags & (1 << SECURITY_ADDSECURIDS))) { upgrade_secur_desc(scx->vol, securattr, ni); /* * fetch owner and group for cacheing * if there is a securid */ } if (test_nino_flag(ni, v3_Extensions) && (perm >= 0)) { enter_cache(scx, ni, uid, gid, perm); } free(securattr); } else { perm = -1; uid = gid = 0; } } if (perm >= 0) { if (!scx->uid) { /* root access and execution */ if (perm & 0111) perm |= 01777; else perm = 0; } else if (uid == scx->uid) perm &= 07700; else /* * avoid checking group membership * when the requested perms for group * are the same as perms for other */ if ((gid == scx->gid) || ((((perm >> 3) ^ perm) & (request >> 6) & 7) && groupmember(scx, scx->uid, gid))) perm &= 07070; else perm &= 07007; } } return (perm); } #endif /* POSIXACLS */ /* * Get an NTFS ACL * * Returns size or -errno if there is a problem * if size was too small, no copy is done and errno is not set, * the caller is expected to issue a new call */ int ntfs_get_ntfs_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, char *value, size_t size) { char *securattr; size_t outsize; outsize = 0; /* default to no data and no error */ securattr = getsecurityattr(scx->vol, ni); if (securattr) { outsize = ntfs_attr_size(securattr); if (outsize <= size) { memcpy(value,securattr,outsize); } free(securattr); } return (outsize ? (int)outsize : -errno); } /* * Get owner, group and permissions in an stat structure * returns permissions, or -1 if there is a problem */ int ntfs_get_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode * ni, struct stat *stbuf) { const SECURITY_DESCRIPTOR_RELATIVE *phead; char *securattr; const SID *usid; /* owner of file/directory */ const SID *gsid; /* group of file/directory */ const struct CACHED_PERMISSIONS *cached; int perm; BOOL isdir; #if POSIXACLS struct POSIX_SECURITY *pxdesc; #endif if (!scx->mapping[MAPUSERS]) perm = 07777; else { /* check whether available in cache */ cached = fetch_cache(scx,ni); if (cached) { #if POSIXACLS if (!(scx->vol->secure_flags & (1 << SECURITY_ACL)) && cached->pxdesc) perm = ntfs_basic_perms(scx,cached->pxdesc); else #endif perm = cached->mode; stbuf->st_uid = cached->uid; stbuf->st_gid = cached->gid; stbuf->st_mode = (stbuf->st_mode & ~07777) + perm; } else { perm = -1; /* default to error */ isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); securattr = getsecurityattr(scx->vol, ni); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*) securattr; gsid = (const SID*)& securattr[le32_to_cpu(phead->group)]; #if OWNERFROMACL usid = ntfs_acl_owner(securattr); #else usid = (const SID*)& securattr[le32_to_cpu(phead->owner)]; #endif #if POSIXACLS pxdesc = ntfs_build_permissions_posix( scx->mapping, securattr, usid, gsid, isdir); if (pxdesc) { if (!(scx->vol->secure_flags & (1 << SECURITY_ACL))) perm = ntfs_basic_perms(scx, pxdesc); else perm = pxdesc->mode & 07777; } else perm = -1; #else perm = ntfs_build_permissions(securattr, usid, gsid, isdir); #endif /* * fetch owner and group for cacheing */ if (perm >= 0) { /* * Create a security id if there were none * and upgrade option is selected */ if (!test_nino_flag(ni, v3_Extensions) && (scx->vol->secure_flags & (1 << SECURITY_ADDSECURIDS))) { upgrade_secur_desc(scx->vol, securattr, ni); } #if OWNERFROMACL stbuf->st_uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #else if (!perm && ntfs_same_sid(usid, adminsid)) { stbuf->st_uid = find_tenant(scx, securattr); if (stbuf->st_uid) perm = 0700; } else stbuf->st_uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #endif stbuf->st_gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); stbuf->st_mode = (stbuf->st_mode & ~07777) + perm; #if POSIXACLS enter_cache(scx, ni, stbuf->st_uid, stbuf->st_gid, pxdesc); free(pxdesc); #else enter_cache(scx, ni, stbuf->st_uid, stbuf->st_gid, perm); #endif } free(securattr); } } } return (perm); } #if POSIXACLS /* * Get the base for a Posix inheritance and * build an inherited Posix descriptor */ static struct POSIX_SECURITY *inherit_posix(struct SECURITY_CONTEXT *scx, ntfs_inode *dir_ni, mode_t mode, BOOL isdir) { const struct CACHED_PERMISSIONS *cached; const SECURITY_DESCRIPTOR_RELATIVE *phead; struct POSIX_SECURITY *pxdesc; struct POSIX_SECURITY *pydesc; char *securattr; const SID *usid; const SID *gsid; uid_t uid; gid_t gid; pydesc = (struct POSIX_SECURITY*)NULL; /* check whether parent directory is available in cache */ cached = fetch_cache(scx,dir_ni); if (cached) { uid = cached->uid; gid = cached->gid; pxdesc = cached->pxdesc; if (pxdesc) { if (scx->vol->secure_flags & (1 << SECURITY_ACL)) pydesc = ntfs_build_inherited_posix(pxdesc, mode, scx->umask, isdir); else pydesc = ntfs_build_basic_posix(pxdesc, mode, scx->umask, isdir); } } else { securattr = getsecurityattr(scx->vol, dir_ni); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*) securattr; gsid = (const SID*)& securattr[le32_to_cpu(phead->group)]; gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); #if OWNERFROMACL usid = ntfs_acl_owner(securattr); pxdesc = ntfs_build_permissions_posix(scx->mapping,securattr, usid, gsid, TRUE); uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #else usid = (const SID*)& securattr[le32_to_cpu(phead->owner)]; pxdesc = ntfs_build_permissions_posix(scx->mapping,securattr, usid, gsid, TRUE); if (pxdesc && ntfs_same_sid(usid, adminsid)) { uid = find_tenant(scx, securattr); } else uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); #endif if (pxdesc) { /* * Create a security id if there were none * and upgrade option is selected */ if (!test_nino_flag(dir_ni, v3_Extensions) && (scx->vol->secure_flags & (1 << SECURITY_ADDSECURIDS))) { upgrade_secur_desc(scx->vol, securattr, dir_ni); /* * fetch owner and group for cacheing * if there is a securid */ } if (test_nino_flag(dir_ni, v3_Extensions)) { enter_cache(scx, dir_ni, uid, gid, pxdesc); } if (scx->vol->secure_flags & (1 << SECURITY_ACL)) pydesc = ntfs_build_inherited_posix( pxdesc, mode, scx->umask, isdir); else pydesc = ntfs_build_basic_posix( pxdesc, mode, scx->umask, isdir); free(pxdesc); } free(securattr); } } return (pydesc); } /* * Allocate a security_id for a file being created * * Returns zero if not possible (NTFS v3.x required) */ le32 ntfs_alloc_securid(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid, ntfs_inode *dir_ni, mode_t mode, BOOL isdir) { #if !FORCE_FORMAT_v1x const struct CACHED_SECURID *cached; struct CACHED_SECURID wanted; struct POSIX_SECURITY *pxdesc; char *newattr; int newattrsz; const SID *usid; const SID *gsid; BIGSID defusid; BIGSID defgsid; le32 securid; #endif securid = const_cpu_to_le32(0); #if !FORCE_FORMAT_v1x pxdesc = inherit_posix(scx, dir_ni, mode, isdir); if (pxdesc) { /* check whether target securid is known in cache */ wanted.uid = uid; wanted.gid = gid; wanted.dmode = pxdesc->mode & mode & 07777; if (isdir) wanted.dmode |= 0x10000; wanted.variable = (void*)pxdesc; wanted.varsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); cached = (const struct CACHED_SECURID*)ntfs_fetch_cache( scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); /* quite simple, if we are lucky */ if (cached) securid = cached->securid; /* not in cache : make sure we can create ids */ if (!cached && (scx->vol->major_ver >= 3)) { usid = ntfs_find_usid(scx->mapping[MAPUSERS],uid,(SID*)&defusid); gsid = ntfs_find_gsid(scx->mapping[MAPGROUPS],gid,(SID*)&defgsid); if (!usid || !gsid) { ntfs_log_error("File created by an unmapped user/group %d/%d\n", (int)uid, (int)gid); usid = gsid = adminsid; } newattr = ntfs_build_descr_posix(scx->mapping, pxdesc, isdir, usid, gsid); if (newattr) { newattrsz = ntfs_attr_size(newattr); securid = setsecurityattr(scx->vol, (const SECURITY_DESCRIPTOR_RELATIVE*)newattr, newattrsz); if (securid) { /* update cache, for subsequent use */ wanted.securid = securid; ntfs_enter_cache(scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); } free(newattr); } else { /* * could not build new security attribute * errno set by ntfs_build_descr() */ } } free(pxdesc); } #endif return (securid); } /* * Apply Posix inheritance to a newly created file * (for NTFS 1.x only : no securid) */ int ntfs_set_inherited_posix(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, ntfs_inode *dir_ni, mode_t mode) { struct POSIX_SECURITY *pxdesc; char *newattr; const SID *usid; const SID *gsid; BIGSID defusid; BIGSID defgsid; BOOL isdir; int res; res = -1; isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); pxdesc = inherit_posix(scx, dir_ni, mode, isdir); if (pxdesc) { usid = ntfs_find_usid(scx->mapping[MAPUSERS],uid,(SID*)&defusid); gsid = ntfs_find_gsid(scx->mapping[MAPGROUPS],gid,(SID*)&defgsid); if (!usid || !gsid) { ntfs_log_error("File created by an unmapped user/group %d/%d\n", (int)uid, (int)gid); usid = gsid = adminsid; } newattr = ntfs_build_descr_posix(scx->mapping, pxdesc, isdir, usid, gsid); if (newattr) { /* Adjust Windows read-only flag */ res = update_secur_descr(scx->vol, newattr, ni); if (!res && !isdir) { if (mode & S_IWUSR) ni->flags &= ~FILE_ATTR_READONLY; else ni->flags |= FILE_ATTR_READONLY; } #if CACHE_LEGACY_SIZE /* also invalidate legacy cache */ if (isdir && !ni->security_id) { struct CACHED_PERMISSIONS_LEGACY legacy; legacy.mft_no = ni->mft_no; legacy.variable = pxdesc; legacy.varsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); ntfs_invalidate_cache(scx->vol->legacy_cache, GENERIC(&legacy), (cache_compare)leg_compare,0); } #endif free(newattr); } else { /* * could not build new security attribute * errno set by ntfs_build_descr() */ } } return (res); } #else le32 ntfs_alloc_securid(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid, mode_t mode, BOOL isdir) { #if !FORCE_FORMAT_v1x const struct CACHED_SECURID *cached; struct CACHED_SECURID wanted; char *newattr; int newattrsz; const SID *usid; const SID *gsid; BIGSID defusid; BIGSID defgsid; le32 securid; #endif securid = const_cpu_to_le32(0); #if !FORCE_FORMAT_v1x /* check whether target securid is known in cache */ wanted.uid = uid; wanted.gid = gid; wanted.dmode = mode & 07777; if (isdir) wanted.dmode |= 0x10000; wanted.variable = (void*)NULL; wanted.varsize = 0; cached = (const struct CACHED_SECURID*)ntfs_fetch_cache( scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); /* quite simple, if we are lucky */ if (cached) securid = cached->securid; /* not in cache : make sure we can create ids */ if (!cached && (scx->vol->major_ver >= 3)) { usid = ntfs_find_usid(scx->mapping[MAPUSERS],uid,(SID*)&defusid); gsid = ntfs_find_gsid(scx->mapping[MAPGROUPS],gid,(SID*)&defgsid); if (!usid || !gsid) { ntfs_log_error("File created by an unmapped user/group %d/%d\n", (int)uid, (int)gid); usid = gsid = adminsid; } newattr = ntfs_build_descr(mode, isdir, usid, gsid); if (newattr) { newattrsz = ntfs_attr_size(newattr); securid = setsecurityattr(scx->vol, (const SECURITY_DESCRIPTOR_RELATIVE*)newattr, newattrsz); if (securid) { /* update cache, for subsequent use */ wanted.securid = securid; ntfs_enter_cache(scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); } free(newattr); } else { /* * could not build new security attribute * errno set by ntfs_build_descr() */ } } #endif return (securid); } #endif /* * Update ownership and mode of a file, reusing an existing * security descriptor when possible * * Returns zero if successful */ #if POSIXACLS int ntfs_set_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode, struct POSIX_SECURITY *pxdesc) #else int ntfs_set_owner_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, mode_t mode) #endif { int res; const struct CACHED_SECURID *cached; struct CACHED_SECURID wanted; char *newattr; const SID *usid; const SID *gsid; BIGSID defusid; BIGSID defgsid; BOOL isdir; res = 0; /* check whether target securid is known in cache */ isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); wanted.uid = uid; wanted.gid = gid; wanted.dmode = mode & 07777; if (isdir) wanted.dmode |= 0x10000; #if POSIXACLS wanted.variable = (void*)pxdesc; if (pxdesc) wanted.varsize = sizeof(struct POSIX_SECURITY) + (pxdesc->acccnt + pxdesc->defcnt)*sizeof(struct POSIX_ACE); else wanted.varsize = 0; #else wanted.variable = (void*)NULL; wanted.varsize = 0; #endif if (test_nino_flag(ni, v3_Extensions)) { cached = (const struct CACHED_SECURID*)ntfs_fetch_cache( scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); /* quite simple, if we are lucky */ if (cached) { ni->security_id = cached->securid; NInoSetDirty(ni); /* adjust Windows read-only flag */ if (!isdir) { if (mode & S_IWUSR) ni->flags &= ~FILE_ATTR_READONLY; else ni->flags |= FILE_ATTR_READONLY; NInoFileNameSetDirty(ni); } } } else cached = (struct CACHED_SECURID*)NULL; if (!cached) { /* * Do not use usid and gsid from former attributes, * but recompute them to get repeatable results * which can be kept in cache. */ usid = ntfs_find_usid(scx->mapping[MAPUSERS],uid,(SID*)&defusid); gsid = ntfs_find_gsid(scx->mapping[MAPGROUPS],gid,(SID*)&defgsid); if (!usid || !gsid) { ntfs_log_error("File made owned by an unmapped user/group %d/%d\n", uid, gid); usid = gsid = adminsid; } #if POSIXACLS if (pxdesc) newattr = ntfs_build_descr_posix(scx->mapping, pxdesc, isdir, usid, gsid); else newattr = ntfs_build_descr(mode, isdir, usid, gsid); #else newattr = ntfs_build_descr(mode, isdir, usid, gsid); #endif if (newattr) { res = update_secur_descr(scx->vol, newattr, ni); if (!res) { /* adjust Windows read-only flag */ if (!isdir) { if (mode & S_IWUSR) ni->flags &= ~FILE_ATTR_READONLY; else ni->flags |= FILE_ATTR_READONLY; NInoFileNameSetDirty(ni); } /* update cache, for subsequent use */ if (test_nino_flag(ni, v3_Extensions)) { wanted.securid = ni->security_id; ntfs_enter_cache(scx->vol->securid_cache, GENERIC(&wanted), (cache_compare)compare); } #if CACHE_LEGACY_SIZE /* also invalidate legacy cache */ if (isdir && !ni->security_id) { struct CACHED_PERMISSIONS_LEGACY legacy; legacy.mft_no = ni->mft_no; #if POSIXACLS legacy.variable = wanted.variable; legacy.varsize = wanted.varsize; #else legacy.variable = (void*)NULL; legacy.varsize = 0; #endif ntfs_invalidate_cache(scx->vol->legacy_cache, GENERIC(&legacy), (cache_compare)leg_compare,0); } #endif } free(newattr); } else { /* * could not build new security attribute * errno set by ntfs_build_descr() */ res = -1; } } return (res); } /* * Check whether user has ownership rights on a file * * Returns TRUE if allowed * if not, errno tells why */ BOOL ntfs_allowed_as_owner(struct SECURITY_CONTEXT *scx, ntfs_inode *ni) { const struct CACHED_PERMISSIONS *cached; char *oldattr; const SID *usid; uid_t processuid; uid_t uid; BOOL gotowner; int allowed; processuid = scx->uid; /* TODO : use CAP_FOWNER process capability */ /* * Always allow for root * Also always allow if no mapping has been defined */ if (!scx->mapping[MAPUSERS] || !processuid) allowed = TRUE; else { gotowner = FALSE; /* default */ /* get the owner, either from cache or from old attribute */ cached = fetch_cache(scx, ni); if (cached) { uid = cached->uid; gotowner = TRUE; } else { oldattr = getsecurityattr(scx->vol, ni); if (oldattr) { #if OWNERFROMACL usid = ntfs_acl_owner(oldattr); #else const SECURITY_DESCRIPTOR_RELATIVE *phead; phead = (const SECURITY_DESCRIPTOR_RELATIVE*) oldattr; usid = (const SID*)&oldattr [le32_to_cpu(phead->owner)]; #endif uid = ntfs_find_user(scx->mapping[MAPUSERS], usid); gotowner = TRUE; free(oldattr); } } /* TODO : use CAP_FOWNER process capability */ if (gotowner && (!processuid || (processuid == uid))) allowed = TRUE; else { allowed = FALSE; errno = EPERM; } } return (allowed); } #if POSIXACLS /* * Set a new access or default Posix ACL to a file * (or remove ACL if no input data) * Validity of input data is checked after merging * * Returns 0, or -1 if there is a problem which errno describes */ int ntfs_set_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name, const char *value, size_t size, int flags) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const struct CACHED_PERMISSIONS *cached; char *oldattr; uid_t processuid; const SID *usid; const SID *gsid; uid_t uid; uid_t gid; int res; BOOL isdir; BOOL deflt; BOOL exist; int count; struct POSIX_SECURITY *oldpxdesc; struct POSIX_SECURITY *newpxdesc; /* get the current pxsec, either from cache or from old attribute */ res = -1; deflt = !strcmp(name,"system.posix_acl_default"); if (size) count = (size - sizeof(struct POSIX_ACL)) / sizeof(struct POSIX_ACE); else count = 0; isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); newpxdesc = (struct POSIX_SECURITY*)NULL; if ((!value || (((const struct POSIX_ACL*)value)->version == POSIX_VERSION)) && (!deflt || isdir || (!size && !value))) { cached = fetch_cache(scx, ni); if (cached) { uid = cached->uid; gid = cached->gid; oldpxdesc = cached->pxdesc; if (oldpxdesc) { newpxdesc = ntfs_replace_acl(oldpxdesc, (const struct POSIX_ACL*)value,count,deflt); } } else { oldattr = getsecurityattr(scx->vol, ni); if (oldattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*)oldattr; #if OWNERFROMACL usid = ntfs_acl_owner(oldattr); #else usid = (const SID*)&oldattr[le32_to_cpu(phead->owner)]; #endif gsid = (const SID*)&oldattr[le32_to_cpu(phead->group)]; uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); oldpxdesc = ntfs_build_permissions_posix(scx->mapping, oldattr, usid, gsid, isdir); if (oldpxdesc) { if (deflt) exist = oldpxdesc->defcnt > 0; else exist = oldpxdesc->acccnt > 3; if ((exist && (flags & XATTR_CREATE)) || (!exist && (flags & XATTR_REPLACE))) { errno = (exist ? EEXIST : ENODATA); } else { newpxdesc = ntfs_replace_acl(oldpxdesc, (const struct POSIX_ACL*)value,count,deflt); } free(oldpxdesc); } free(oldattr); } } } else errno = EINVAL; if (newpxdesc) { processuid = scx->uid; /* TODO : use CAP_FOWNER process capability */ if (!processuid || (uid == processuid)) { /* * clear setgid if file group does * not match process group */ if (processuid && (gid != scx->gid) && !groupmember(scx, scx->uid, gid)) { newpxdesc->mode &= ~S_ISGID; } res = ntfs_set_owner_mode(scx, ni, uid, gid, newpxdesc->mode, newpxdesc); } else errno = EPERM; free(newpxdesc); } return (res ? -1 : 0); } /* * Remove a default Posix ACL from a file * * Returns 0, or -1 if there is a problem which errno describes */ int ntfs_remove_posix_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *name) { return (ntfs_set_posix_acl(scx, ni, name, (const char*)NULL, 0, 0)); } #endif /* * Set a new NTFS ACL to a file * * Returns 0, or -1 if there is a problem */ int ntfs_set_ntfs_acl(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, const char *value, size_t size, int flags) { char *attr; int res; res = -1; if ((size > 0) && !(flags & XATTR_CREATE) && ntfs_valid_descr(value,size) && (ntfs_attr_size(value) == size)) { /* need copying in order to write */ attr = (char*)ntfs_malloc(size); if (attr) { memcpy(attr,value,size); res = update_secur_descr(scx->vol, attr, ni); /* * No need to invalidate standard caches : * the relation between a securid and * the associated protection is unchanged, * only the relation between a file and * its securid and protection is changed. */ #if CACHE_LEGACY_SIZE /* * we must however invalidate the legacy * cache, which is based on inode numbers. * For safety, invalidate even if updating * failed. */ if ((ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) && !ni->security_id) { struct CACHED_PERMISSIONS_LEGACY legacy; legacy.mft_no = ni->mft_no; legacy.variable = (char*)NULL; legacy.varsize = 0; ntfs_invalidate_cache(scx->vol->legacy_cache, GENERIC(&legacy), (cache_compare)leg_compare,0); } #endif free(attr); } else errno = ENOMEM; } else errno = EINVAL; return (res ? -1 : 0); } /* * Set new permissions to a file * Checks user mapping has been defined before request for setting * * rejected if request is not originated by owner or root * * returns 0 on success * -1 on failure, with errno = EIO */ int ntfs_set_mode(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, mode_t mode) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const struct CACHED_PERMISSIONS *cached; char *oldattr; const SID *usid; const SID *gsid; uid_t processuid; uid_t uid; uid_t gid; int res; #if POSIXACLS BOOL isdir; int pxsize; const struct POSIX_SECURITY *oldpxdesc; struct POSIX_SECURITY *newpxdesc = (struct POSIX_SECURITY*)NULL; #endif /* get the current owner, either from cache or from old attribute */ res = 0; cached = fetch_cache(scx, ni); if (cached) { uid = cached->uid; gid = cached->gid; #if POSIXACLS oldpxdesc = cached->pxdesc; if (oldpxdesc) { /* must copy before merging */ pxsize = sizeof(struct POSIX_SECURITY) + (oldpxdesc->acccnt + oldpxdesc->defcnt)*sizeof(struct POSIX_ACE); newpxdesc = (struct POSIX_SECURITY*)malloc(pxsize); if (newpxdesc) { memcpy(newpxdesc, oldpxdesc, pxsize); if (ntfs_merge_mode_posix(newpxdesc, mode)) res = -1; } else res = -1; } else newpxdesc = (struct POSIX_SECURITY*)NULL; #endif } else { oldattr = getsecurityattr(scx->vol, ni); if (oldattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*)oldattr; #if OWNERFROMACL usid = ntfs_acl_owner(oldattr); #else usid = (const SID*)&oldattr[le32_to_cpu(phead->owner)]; #endif gsid = (const SID*)&oldattr[le32_to_cpu(phead->group)]; uid = ntfs_find_user(scx->mapping[MAPUSERS],usid); gid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); #if POSIXACLS isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); newpxdesc = ntfs_build_permissions_posix(scx->mapping, oldattr, usid, gsid, isdir); if (!newpxdesc || ntfs_merge_mode_posix(newpxdesc, mode)) res = -1; #endif free(oldattr); } else res = -1; } if (!res) { processuid = scx->uid; /* TODO : use CAP_FOWNER process capability */ if (!processuid || (uid == processuid)) { /* * clear setgid if file group does * not match process group */ if (processuid && (gid != scx->gid) && !groupmember(scx, scx->uid, gid)) mode &= ~S_ISGID; #if POSIXACLS if (newpxdesc) { newpxdesc->mode = mode; res = ntfs_set_owner_mode(scx, ni, uid, gid, mode, newpxdesc); } else res = ntfs_set_owner_mode(scx, ni, uid, gid, mode, newpxdesc); #else res = ntfs_set_owner_mode(scx, ni, uid, gid, mode); #endif } else { errno = EPERM; res = -1; /* neither owner nor root */ } } else { /* * Should not happen : a default descriptor is generated * by getsecurityattr() when there are none */ ntfs_log_error("File has no security descriptor\n"); res = -1; errno = EIO; } #if POSIXACLS if (newpxdesc) free(newpxdesc); #endif return (res ? -1 : 0); } /* * Create a default security descriptor for files whose descriptor * cannot be inherited */ int ntfs_sd_add_everyone(ntfs_inode *ni) { /* JPA SECURITY_DESCRIPTOR_ATTR *sd; */ SECURITY_DESCRIPTOR_RELATIVE *sd; ACL *acl; ACCESS_ALLOWED_ACE *ace; SID *sid; int ret, sd_len; /* Create SECURITY_DESCRIPTOR attribute (everyone has full access). */ /* * Calculate security descriptor length. We have 2 sub-authorities in * owner and group SIDs, but structure SID contain only one, so add * 4 bytes to every SID. */ sd_len = sizeof(SECURITY_DESCRIPTOR_ATTR) + 2 * (sizeof(SID) + 4) + sizeof(ACL) + sizeof(ACCESS_ALLOWED_ACE); sd = (SECURITY_DESCRIPTOR_RELATIVE*)ntfs_calloc(sd_len); if (!sd) return -1; sd->revision = SECURITY_DESCRIPTOR_REVISION; sd->control = SE_DACL_PRESENT | SE_SELF_RELATIVE; sid = (SID*)((u8*)sd + sizeof(SECURITY_DESCRIPTOR_ATTR)); sid->revision = SID_REVISION; sid->sub_authority_count = 2; sid->sub_authority[0] = const_cpu_to_le32(SECURITY_BUILTIN_DOMAIN_RID); sid->sub_authority[1] = const_cpu_to_le32(DOMAIN_ALIAS_RID_ADMINS); sid->identifier_authority.value[5] = 5; sd->owner = cpu_to_le32((u8*)sid - (u8*)sd); sid = (SID*)((u8*)sid + sizeof(SID) + 4); sid->revision = SID_REVISION; sid->sub_authority_count = 2; sid->sub_authority[0] = const_cpu_to_le32(SECURITY_BUILTIN_DOMAIN_RID); sid->sub_authority[1] = const_cpu_to_le32(DOMAIN_ALIAS_RID_ADMINS); sid->identifier_authority.value[5] = 5; sd->group = cpu_to_le32((u8*)sid - (u8*)sd); acl = (ACL*)((u8*)sid + sizeof(SID) + 4); acl->revision = ACL_REVISION; acl->size = const_cpu_to_le16(sizeof(ACL) + sizeof(ACCESS_ALLOWED_ACE)); acl->ace_count = const_cpu_to_le16(1); sd->dacl = cpu_to_le32((u8*)acl - (u8*)sd); ace = (ACCESS_ALLOWED_ACE*)((u8*)acl + sizeof(ACL)); ace->type = ACCESS_ALLOWED_ACE_TYPE; ace->flags = OBJECT_INHERIT_ACE | CONTAINER_INHERIT_ACE; ace->size = const_cpu_to_le16(sizeof(ACCESS_ALLOWED_ACE)); ace->mask = const_cpu_to_le32(0x1f01ff); /* FIXME */ ace->sid.revision = SID_REVISION; ace->sid.sub_authority_count = 1; ace->sid.sub_authority[0] = const_cpu_to_le32(0); ace->sid.identifier_authority.value[5] = 1; ret = ntfs_attr_add(ni, AT_SECURITY_DESCRIPTOR, AT_UNNAMED, 0, (u8*)sd, sd_len); if (ret) ntfs_log_perror("Failed to add initial SECURITY_DESCRIPTOR"); free(sd); return ret; } /* * Check whether user can access a file in a specific way * * Returns 1 if access is allowed, including user is root or no * user mapping defined * 2 if sticky and accesstype is S_IWRITE + S_IEXEC + S_ISVTX * 0 and sets errno if there is a problem or if access * is not allowed * * This is used for Posix ACL and checking creation of DOS file names */ int ntfs_allowed_access(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, int accesstype) /* access type required (S_Ixxx values) */ { int perm; int res; int allow; struct stat stbuf = {0, }; /* * Always allow for root unless execution is requested. * (was checked by fuse until kernel 2.6.29) * Also always allow if no mapping has been defined */ if (!scx->mapping[MAPUSERS] || (!scx->uid && (!(accesstype & S_IEXEC) || (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY)))) allow = 1; else { perm = ntfs_get_perm(scx, ni, accesstype); if (perm >= 0) { res = EACCES; switch (accesstype) { case S_IEXEC: allow = (perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0; break; case S_IWRITE: allow = (perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0; break; case S_IWRITE + S_IEXEC: allow = ((perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0) && ((perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0); break; case S_IREAD: allow = (perm & (S_IRUSR | S_IRGRP | S_IROTH)) != 0; break; case S_IREAD + S_IEXEC: allow = ((perm & (S_IRUSR | S_IRGRP | S_IROTH)) != 0) && ((perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0); break; case S_IREAD + S_IWRITE: allow = ((perm & (S_IRUSR | S_IRGRP | S_IROTH)) != 0) && ((perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0); break; case S_IWRITE + S_IEXEC + S_ISVTX: if (perm & S_ISVTX) { if ((ntfs_get_owner_mode(scx,ni,&stbuf) >= 0) && (stbuf.st_uid == scx->uid)) allow = 1; else allow = 2; } else allow = ((perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0) && ((perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0); break; case S_IREAD + S_IWRITE + S_IEXEC: allow = ((perm & (S_IRUSR | S_IRGRP | S_IROTH)) != 0) && ((perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0) && ((perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0); break; default : res = EINVAL; allow = 0; break; } if (!allow) errno = res; } else allow = 0; } return (allow); } /* * Check whether user can create a file (or directory) * * Returns TRUE if access is allowed, * Also returns the gid and dsetgid applicable to the created file */ int ntfs_allowed_create(struct SECURITY_CONTEXT *scx, ntfs_inode *dir_ni, gid_t *pgid, mode_t *pdsetgid) { int perm; int res; int allow; struct stat stbuf = {0, }; /* * Always allow for root. * Also always allow if no mapping has been defined */ if (!scx->mapping[MAPUSERS]) perm = 0777; else perm = ntfs_get_perm(scx, dir_ni, S_IWRITE + S_IEXEC); if (!scx->mapping[MAPUSERS] || !scx->uid) { allow = 1; } else { perm = ntfs_get_perm(scx, dir_ni, S_IWRITE + S_IEXEC); if (perm >= 0) { res = EACCES; allow = ((perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0) && ((perm & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0); if (!allow) errno = res; } else allow = 0; } *pgid = scx->gid; *pdsetgid = 0; /* return directory group if S_ISGID is set */ if (allow && (perm & S_ISGID)) { if (ntfs_get_owner_mode(scx, dir_ni, &stbuf) >= 0) { *pdsetgid = stbuf.st_mode & S_ISGID; if (perm & S_ISGID) *pgid = stbuf.st_gid; } } return (allow); } #if 0 /* not needed any more */ /* * Check whether user can access the parent directory * of a file in a specific way * * Returns true if access is allowed, including user is root and * no user mapping defined * * Sets errno if there is a problem or if not allowed * * This is used for Posix ACL and checking creation of DOS file names */ BOOL old_ntfs_allowed_dir_access(struct SECURITY_CONTEXT *scx, const char *path, int accesstype) { int allow; char *dirpath; char *name; ntfs_inode *ni; ntfs_inode *dir_ni; struct stat stbuf; allow = 0; dirpath = strdup(path); if (dirpath) { /* the root of file system is seen as a parent of itself */ /* is that correct ? */ name = strrchr(dirpath, '/'); *name = 0; dir_ni = ntfs_pathname_to_inode(scx->vol, NULL, dirpath); if (dir_ni) { allow = ntfs_allowed_access(scx, dir_ni, accesstype); ntfs_inode_close(dir_ni); /* * for an not-owned sticky directory, have to * check whether file itself is owned */ if ((accesstype == (S_IWRITE + S_IEXEC + S_ISVTX)) && (allow == 2)) { ni = ntfs_pathname_to_inode(scx->vol, NULL, path); allow = FALSE; if (ni) { allow = (ntfs_get_owner_mode(scx,ni,&stbuf) >= 0) && (stbuf.st_uid == scx->uid); ntfs_inode_close(ni); } } } free(dirpath); } return (allow); /* errno is set if not allowed */ } #endif /* * Define a new owner/group to a file * * returns zero if successful */ int ntfs_set_owner(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid) { const SECURITY_DESCRIPTOR_RELATIVE *phead; const struct CACHED_PERMISSIONS *cached; char *oldattr; const SID *usid; const SID *gsid; uid_t fileuid; uid_t filegid; mode_t mode; int perm; BOOL isdir; int res; #if POSIXACLS struct POSIX_SECURITY *pxdesc; BOOL pxdescbuilt = FALSE; #endif res = 0; /* get the current owner and mode from cache or security attributes */ oldattr = (char*)NULL; cached = fetch_cache(scx,ni); if (cached) { fileuid = cached->uid; filegid = cached->gid; mode = cached->mode; #if POSIXACLS pxdesc = cached->pxdesc; if (!pxdesc) res = -1; #endif } else { fileuid = 0; filegid = 0; mode = 0; oldattr = getsecurityattr(scx->vol, ni); if (oldattr) { isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); phead = (const SECURITY_DESCRIPTOR_RELATIVE*) oldattr; gsid = (const SID*) &oldattr[le32_to_cpu(phead->group)]; #if OWNERFROMACL usid = ntfs_acl_owner(oldattr); #else usid = (const SID*) &oldattr[le32_to_cpu(phead->owner)]; #endif #if POSIXACLS pxdesc = ntfs_build_permissions_posix(scx->mapping, oldattr, usid, gsid, isdir); if (pxdesc) { pxdescbuilt = TRUE; fileuid = ntfs_find_user(scx->mapping[MAPUSERS],usid); filegid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); mode = perm = pxdesc->mode; } else res = -1; #else mode = perm = ntfs_build_permissions(oldattr, usid, gsid, isdir); if (perm >= 0) { fileuid = ntfs_find_user(scx->mapping[MAPUSERS],usid); filegid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); } else res = -1; #endif free(oldattr); } else res = -1; } if (!res) { /* check requested by root */ /* or chgrp requested by owner to an owned group */ if (!scx->uid || ((((int)uid < 0) || (uid == fileuid)) && ((gid == scx->gid) || groupmember(scx, scx->uid, gid)) && (fileuid == scx->uid))) { /* replace by the new usid and gsid */ /* or reuse old gid and sid for cacheing */ if ((int)uid < 0) uid = fileuid; if ((int)gid < 0) gid = filegid; #if !defined(__sun) || !defined (__SVR4) /* clear setuid and setgid if owner has changed */ /* unless request originated by root */ if (uid && (fileuid != uid)) mode &= 01777; #endif #if POSIXACLS res = ntfs_set_owner_mode(scx, ni, uid, gid, mode, pxdesc); #else res = ntfs_set_owner_mode(scx, ni, uid, gid, mode); #endif } else { res = -1; /* neither owner nor root */ errno = EPERM; } #if POSIXACLS if (pxdescbuilt) free(pxdesc); #endif } else { /* * Should not happen : a default descriptor is generated * by getsecurityattr() when there are none */ ntfs_log_error("File has no security descriptor\n"); res = -1; errno = EIO; } return (res ? -1 : 0); } /* * Define new owner/group and mode to a file * * returns zero if successful */ int ntfs_set_ownmod(struct SECURITY_CONTEXT *scx, ntfs_inode *ni, uid_t uid, gid_t gid, const mode_t mode) { const struct CACHED_PERMISSIONS *cached; char *oldattr; uid_t fileuid; uid_t filegid; int res; #if POSIXACLS const SECURITY_DESCRIPTOR_RELATIVE *phead; const SID *usid; const SID *gsid; BOOL isdir; const struct POSIX_SECURITY *oldpxdesc; struct POSIX_SECURITY *newpxdesc = (struct POSIX_SECURITY*)NULL; int pxsize; #endif res = 0; /* get the current owner and mode from cache or security attributes */ oldattr = (char*)NULL; cached = fetch_cache(scx,ni); if (cached) { fileuid = cached->uid; filegid = cached->gid; #if POSIXACLS oldpxdesc = cached->pxdesc; if (oldpxdesc) { /* must copy before merging */ pxsize = sizeof(struct POSIX_SECURITY) + (oldpxdesc->acccnt + oldpxdesc->defcnt)*sizeof(struct POSIX_ACE); newpxdesc = (struct POSIX_SECURITY*)malloc(pxsize); if (newpxdesc) { memcpy(newpxdesc, oldpxdesc, pxsize); if (ntfs_merge_mode_posix(newpxdesc, mode)) res = -1; } else res = -1; } #endif } else { fileuid = 0; filegid = 0; oldattr = getsecurityattr(scx->vol, ni); if (oldattr) { #if POSIXACLS isdir = (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) != const_cpu_to_le16(0); phead = (const SECURITY_DESCRIPTOR_RELATIVE*) oldattr; gsid = (const SID*) &oldattr[le32_to_cpu(phead->group)]; #if OWNERFROMACL usid = ntfs_acl_owner(oldattr); #else usid = (const SID*) &oldattr[le32_to_cpu(phead->owner)]; #endif newpxdesc = ntfs_build_permissions_posix(scx->mapping, oldattr, usid, gsid, isdir); if (!newpxdesc || ntfs_merge_mode_posix(newpxdesc, mode)) res = -1; else { fileuid = ntfs_find_user(scx->mapping[MAPUSERS],usid); filegid = ntfs_find_group(scx->mapping[MAPGROUPS],gsid); } #endif free(oldattr); } else res = -1; } if (!res) { /* check requested by root */ /* or chgrp requested by owner to an owned group */ if (!scx->uid || ((((int)uid < 0) || (uid == fileuid)) && ((gid == scx->gid) || groupmember(scx, scx->uid, gid)) && (fileuid == scx->uid))) { /* replace by the new usid and gsid */ /* or reuse old gid and sid for cacheing */ if ((int)uid < 0) uid = fileuid; if ((int)gid < 0) gid = filegid; #if POSIXACLS res = ntfs_set_owner_mode(scx, ni, uid, gid, mode, newpxdesc); #else res = ntfs_set_owner_mode(scx, ni, uid, gid, mode); #endif } else { res = -1; /* neither owner nor root */ errno = EPERM; } } else { /* * Should not happen : a default descriptor is generated * by getsecurityattr() when there are none */ ntfs_log_error("File has no security descriptor\n"); res = -1; errno = EIO; } #if POSIXACLS free(newpxdesc); #endif return (res ? -1 : 0); } /* * Build a security id for a descriptor inherited from * parent directory the Windows way */ static le32 build_inherited_id(struct SECURITY_CONTEXT *scx, const char *parentattr, BOOL fordir) { const SECURITY_DESCRIPTOR_RELATIVE *pphead; const ACL *ppacl; const SID *usid; const SID *gsid; BIGSID defusid; BIGSID defgsid; int offpacl; int offgroup; SECURITY_DESCRIPTOR_RELATIVE *pnhead; ACL *pnacl; int parentattrsz; char *newattr; int newattrsz; int aclsz; int usidsz; int gsidsz; int pos; le32 securid; parentattrsz = ntfs_attr_size(parentattr); pphead = (const SECURITY_DESCRIPTOR_RELATIVE*)parentattr; if (scx->mapping[MAPUSERS]) { usid = ntfs_find_usid(scx->mapping[MAPUSERS], scx->uid, (SID*)&defusid); gsid = ntfs_find_gsid(scx->mapping[MAPGROUPS], scx->gid, (SID*)&defgsid); #if OWNERFROMACL /* Get approximation of parent owner when cannot map */ if (!gsid) gsid = adminsid; if (!usid) { usid = ntfs_acl_owner(parentattr); if (!ntfs_is_user_sid(gsid)) gsid = usid; } #else /* Define owner as root when cannot map */ if (!usid) usid = adminsid; if (!gsid) gsid = adminsid; #endif } else { /* * If there is no user mapping and this is not a root * user, we have to get owner and group from somewhere, * and the parent directory has to contribute. * Windows never has to do that, because it can always * rely on a user mapping */ if (!scx->uid) usid = adminsid; else { #if OWNERFROMACL usid = ntfs_acl_owner(parentattr); #else int offowner; offowner = le32_to_cpu(pphead->owner); usid = (const SID*)&parentattr[offowner]; #endif } if (!scx->gid) gsid = adminsid; else { offgroup = le32_to_cpu(pphead->group); gsid = (const SID*)&parentattr[offgroup]; } } /* * new attribute is smaller than parent's * except for differences in SIDs which appear in * owner, group and possible grants and denials in * generic creator-owner and creator-group ACEs. * For directories, an ACE may be duplicated for * access and inheritance, so we double the count. */ usidsz = ntfs_sid_size(usid); gsidsz = ntfs_sid_size(gsid); newattrsz = parentattrsz + 3*usidsz + 3*gsidsz; if (fordir) newattrsz *= 2; newattr = (char*)ntfs_malloc(newattrsz); if (newattr) { pnhead = (SECURITY_DESCRIPTOR_RELATIVE*)newattr; pnhead->revision = SECURITY_DESCRIPTOR_REVISION; pnhead->alignment = 0; pnhead->control = (pphead->control & (SE_DACL_AUTO_INHERITED | SE_SACL_AUTO_INHERITED)) | SE_SELF_RELATIVE; pos = sizeof(SECURITY_DESCRIPTOR_RELATIVE); /* * locate and inherit DACL * do not test SE_DACL_PRESENT (wrong for "DR Watson") */ pnhead->dacl = const_cpu_to_le32(0); if (pphead->dacl) { offpacl = le32_to_cpu(pphead->dacl); ppacl = (const ACL*)&parentattr[offpacl]; pnacl = (ACL*)&newattr[pos]; aclsz = ntfs_inherit_acl(ppacl, pnacl, usid, gsid, fordir, pphead->control & SE_DACL_AUTO_INHERITED); if (aclsz) { pnhead->dacl = cpu_to_le32(pos); pos += aclsz; pnhead->control |= SE_DACL_PRESENT; } } /* * locate and inherit SACL */ pnhead->sacl = const_cpu_to_le32(0); if (pphead->sacl) { offpacl = le32_to_cpu(pphead->sacl); ppacl = (const ACL*)&parentattr[offpacl]; pnacl = (ACL*)&newattr[pos]; aclsz = ntfs_inherit_acl(ppacl, pnacl, usid, gsid, fordir, pphead->control & SE_SACL_AUTO_INHERITED); if (aclsz) { pnhead->sacl = cpu_to_le32(pos); pos += aclsz; pnhead->control |= SE_SACL_PRESENT; } } /* * inherit or redefine owner */ memcpy(&newattr[pos],usid,usidsz); pnhead->owner = cpu_to_le32(pos); pos += usidsz; /* * inherit or redefine group */ memcpy(&newattr[pos],gsid,gsidsz); pnhead->group = cpu_to_le32(pos); pos += gsidsz; securid = setsecurityattr(scx->vol, (SECURITY_DESCRIPTOR_RELATIVE*)newattr, pos); free(newattr); } else securid = const_cpu_to_le32(0); return (securid); } /* * Get an inherited security id * * For Windows compatibility, the normal initial permission setting * may be inherited from the parent directory instead of being * defined by the creation arguments. * * The following creates an inherited id for that purpose. * * Note : the owner and group of parent directory are also * inherited (which is not the case on Windows) if no user mapping * is defined. * * Returns the inherited id, or zero if not possible (eg on NTFS 1.x) */ le32 ntfs_inherited_id(struct SECURITY_CONTEXT *scx, ntfs_inode *dir_ni, BOOL fordir) { struct CACHED_PERMISSIONS *cached; char *parentattr; le32 securid; securid = const_cpu_to_le32(0); cached = (struct CACHED_PERMISSIONS*)NULL; /* * Try to get inherited id from cache, possible when * the current process owns the parent directory */ if (test_nino_flag(dir_ni, v3_Extensions) && dir_ni->security_id) { cached = fetch_cache(scx, dir_ni); if (cached && (cached->uid == scx->uid) && (cached->gid == scx->gid)) securid = (fordir ? cached->inh_dirid : cached->inh_fileid); } /* * Not cached or not available in cache, compute it all * Note : if parent directory has no id, it is not cacheable */ if (!securid) { parentattr = getsecurityattr(scx->vol, dir_ni); if (parentattr) { securid = build_inherited_id(scx, parentattr, fordir); free(parentattr); /* * Store the result into cache for further use * if the current process owns the parent directory */ if (securid) { cached = fetch_cache(scx, dir_ni); if (cached && (cached->uid == scx->uid) && (cached->gid == scx->gid)) { if (fordir) cached->inh_dirid = securid; else cached->inh_fileid = securid; } } } } return (securid); } /* * Link a group to a member of group * * Returns 0 if OK, -1 (and errno set) if error */ static int link_single_group(struct MAPPING *usermapping, struct passwd *user, gid_t gid) { struct group *group; char **grmem; int grcnt; gid_t *groups; int res; res = 0; group = getgrgid(gid); if (group && group->gr_mem) { grcnt = usermapping->grcnt; groups = usermapping->groups; grmem = group->gr_mem; while (*grmem && strcmp(user->pw_name, *grmem)) grmem++; if (*grmem) { if (!grcnt) groups = (gid_t*)malloc(sizeof(gid_t)); else groups = (gid_t*)realloc(groups, (grcnt+1)*sizeof(gid_t)); if (groups) groups[grcnt++] = gid; else { res = -1; errno = ENOMEM; } } usermapping->grcnt = grcnt; usermapping->groups = groups; } return (res); } /* * Statically link group to users * This is based on groups defined in /etc/group and does not take * the groups dynamically set by setgroups() nor any changes in * /etc/group into account * * Only mapped groups and root group are linked to mapped users * * Returns 0 if OK, -1 (and errno set) if error * */ static int link_group_members(struct SECURITY_CONTEXT *scx) { struct MAPPING *usermapping; struct MAPPING *groupmapping; struct passwd *user; int res; res = 0; for (usermapping=scx->mapping[MAPUSERS]; usermapping && !res; usermapping=usermapping->next) { usermapping->grcnt = 0; usermapping->groups = (gid_t*)NULL; user = getpwuid(usermapping->xid); if (user && user->pw_name) { for (groupmapping=scx->mapping[MAPGROUPS]; groupmapping && !res; groupmapping=groupmapping->next) { if (link_single_group(usermapping, user, groupmapping->xid)) res = -1; } if (!res && link_single_group(usermapping, user, (gid_t)0)) res = -1; } } return (res); } /* * Apply default single user mapping * returns zero if successful */ static int ntfs_do_default_mapping(struct SECURITY_CONTEXT *scx, uid_t uid, gid_t gid, const SID *usid) { struct MAPPING *usermapping = NULL; struct MAPPING *groupmapping = NULL; SID *sid; int sidsz; int res; res = -1; sidsz = ntfs_sid_size(usid); sid = (SID*)ntfs_malloc(sidsz); if (sid) { memcpy(sid,usid,sidsz); usermapping = (struct MAPPING*)ntfs_malloc(sizeof(struct MAPPING)); if (usermapping) { groupmapping = (struct MAPPING*)ntfs_malloc(sizeof(struct MAPPING)); if (groupmapping) { usermapping->sid = sid; usermapping->xid = uid; usermapping->next = (struct MAPPING*)NULL; groupmapping->sid = sid; groupmapping->xid = gid; groupmapping->next = (struct MAPPING*)NULL; scx->mapping[MAPUSERS] = usermapping; scx->mapping[MAPGROUPS] = groupmapping; res = 0; } } } if (res) { if (sid) free(sid); if (usermapping) free(usermapping); if (groupmapping) free(groupmapping); } return (res); } /* * Make sure there are no ambiguous mapping * Ambiguous mapping may lead to undesired configurations and * we had rather be safe until the consequences are understood */ #if 0 /* not activated for now */ static BOOL check_mapping(const struct MAPPING *usermapping, const struct MAPPING *groupmapping) { const struct MAPPING *mapping1; const struct MAPPING *mapping2; BOOL ambiguous; ambiguous = FALSE; for (mapping1=usermapping; mapping1; mapping1=mapping1->next) for (mapping2=mapping1->next; mapping2; mapping1=mapping2->next) if (ntfs_same_sid(mapping1->sid,mapping2->sid)) { if (mapping1->xid != mapping2->xid) ambiguous = TRUE; } else { if (mapping1->xid == mapping2->xid) ambiguous = TRUE; } for (mapping1=groupmapping; mapping1; mapping1=mapping1->next) for (mapping2=mapping1->next; mapping2; mapping1=mapping2->next) if (ntfs_same_sid(mapping1->sid,mapping2->sid)) { if (mapping1->xid != mapping2->xid) ambiguous = TRUE; } else { if (mapping1->xid == mapping2->xid) ambiguous = TRUE; } return (ambiguous); } #endif #if 0 /* not used any more */ /* * Try and apply default single user mapping * returns zero if successful */ static int ntfs_default_mapping(struct SECURITY_CONTEXT *scx) { const SECURITY_DESCRIPTOR_RELATIVE *phead; ntfs_inode *ni; char *securattr; const SID *usid; int res; res = -1; ni = ntfs_pathname_to_inode(scx->vol, NULL, "/."); if (ni) { securattr = getsecurityattr(scx->vol, ni); if (securattr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*)securattr; usid = (SID*)&securattr[le32_to_cpu(phead->owner)]; if (ntfs_is_user_sid(usid)) res = ntfs_do_default_mapping(scx, scx->uid, scx->gid, usid); free(securattr); } ntfs_inode_close(ni); } return (res); } #endif /* * Basic read from a user mapping file on another volume */ static int basicread(void *fileid, char *buf, size_t size, off_t offs __attribute__((unused))) { return (read(*(int*)fileid, buf, size)); } /* * Read from a user mapping file on current NTFS partition */ static int localread(void *fileid, char *buf, size_t size, off_t offs) { return (ntfs_attr_data_read((ntfs_inode*)fileid, AT_UNNAMED, 0, buf, size, offs)); } /* * Build the user mapping * - according to a mapping file if defined (or default present), * - or try default single user mapping if possible * * The mapping is specific to a mounted device * No locking done, mounting assumed non multithreaded * * returns zero if mapping is successful * (failure should not be interpreted as an error) */ int ntfs_build_mapping(struct SECURITY_CONTEXT *scx, const char *usermap_path, BOOL allowdef) { struct MAPLIST *item; struct MAPLIST *firstitem; struct MAPPING *usermapping; struct MAPPING *groupmapping; ntfs_inode *ni; int fd; static struct { u8 revision; u8 levels; be16 highbase; be32 lowbase; le32 level1; le32 level2; le32 level3; le32 level4; le32 level5; } defmap = { 1, 5, const_cpu_to_be16(0), const_cpu_to_be32(5), const_cpu_to_le32(21), const_cpu_to_le32(DEFSECAUTH1), const_cpu_to_le32(DEFSECAUTH2), const_cpu_to_le32(DEFSECAUTH3), const_cpu_to_le32(DEFSECBASE) } ; /* be sure not to map anything until done */ scx->mapping[MAPUSERS] = (struct MAPPING*)NULL; scx->mapping[MAPGROUPS] = (struct MAPPING*)NULL; if (!usermap_path) usermap_path = MAPPINGFILE; if (usermap_path[0] == '/') { fd = open(usermap_path,O_RDONLY); if (fd >= 0) { firstitem = ntfs_read_mapping(basicread, (void*)&fd); close(fd); } else firstitem = (struct MAPLIST*)NULL; } else { ni = ntfs_pathname_to_inode(scx->vol, NULL, usermap_path); if (ni) { firstitem = ntfs_read_mapping(localread, ni); ntfs_inode_close(ni); } else firstitem = (struct MAPLIST*)NULL; } if (firstitem) { usermapping = ntfs_do_user_mapping(firstitem); groupmapping = ntfs_do_group_mapping(firstitem); if (usermapping) scx->mapping[MAPUSERS] = usermapping; if (groupmapping) scx->mapping[MAPGROUPS] = groupmapping; if (!usermapping || !groupmapping) { ntfs_log_error("There were no valid user or no valid group\n"); if (usermapping) ntfs_free(usermapping); if (groupmapping) ntfs_free(groupmapping); } /* now we can free the memory copy of input text */ /* and rely on internal representation */ while (firstitem) { item = firstitem->next; free(firstitem); firstitem = item; } } else { /* no mapping file, try a default mapping */ if (allowdef) { if (!ntfs_do_default_mapping(scx, 0, 0, (const SID*)&defmap)) ntfs_log_info("Using default user mapping\n"); } } return (!scx->mapping[MAPUSERS] || link_group_members(scx)); } /* * Get the ntfs attribute into an extended attribute * The attribute is returned according to cpu endianness */ int ntfs_get_ntfs_attrib(ntfs_inode *ni, char *value, size_t size) { u32 attrib; size_t outsize; outsize = 0; /* default to no data and no error */ if (ni) { attrib = le32_to_cpu(ni->flags); if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) attrib |= const_le32_to_cpu(FILE_ATTR_DIRECTORY); else attrib &= ~const_le32_to_cpu(FILE_ATTR_DIRECTORY); if (!attrib) attrib |= const_le32_to_cpu(FILE_ATTR_NORMAL); outsize = sizeof(FILE_ATTR_FLAGS); if (size >= outsize) { if (value) memcpy(value,&attrib,outsize); else errno = EINVAL; } } return (outsize ? (int)outsize : -errno); } /* * Return the ntfs attribute into an extended attribute * The attribute is expected according to cpu endianness * * Returns 0, or -1 if there is a problem */ int ntfs_set_ntfs_attrib(ntfs_inode *ni, const char *value, size_t size, int flags) { u32 attrib; le32 settable; ATTR_FLAGS dirflags; int res; res = -1; if (ni && value && (size >= sizeof(FILE_ATTR_FLAGS))) { if (!(flags & XATTR_CREATE)) { /* copy to avoid alignment problems */ memcpy(&attrib,value,sizeof(FILE_ATTR_FLAGS)); settable = FILE_ATTR_SETTABLE; res = 0; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { /* * Accept changing compression for a directory * and set index root accordingly */ settable |= FILE_ATTR_COMPRESSED; if ((ni->flags ^ cpu_to_le32(attrib)) & FILE_ATTR_COMPRESSED) { if (ni->flags & FILE_ATTR_COMPRESSED) dirflags = const_cpu_to_le16(0); else dirflags = ATTR_IS_COMPRESSED; res = ntfs_attr_set_flags(ni, AT_INDEX_ROOT, NTFS_INDEX_I30, 4, dirflags, ATTR_COMPRESSION_MASK); } } if (!res) { ni->flags = (ni->flags & ~settable) | (cpu_to_le32(attrib) & settable); NInoFileNameSetDirty(ni); NInoSetDirty(ni); } } else errno = EEXIST; } else errno = EINVAL; return (res ? -1 : 0); } /* * Open the volume's security descriptor index ($Secure) * * returns 0 if it succeeds * -1 with errno set if it fails and the volume is NTFS v3.0+ */ int ntfs_open_secure(ntfs_volume *vol) { ntfs_inode *ni; ntfs_index_context *sii; ntfs_index_context *sdh; if (vol->secure_ni) /* Already open? */ return 0; ni = ntfs_inode_open(vol, FILE_Secure); if (!ni) goto err; if (ni->mft_no != FILE_Secure) { ntfs_log_error("$Secure does not have expected inode number!"); errno = EINVAL; goto err_close_ni; } /* Allocate the needed index contexts. */ sii = ntfs_index_ctx_get(ni, sii_stream, 4); if (!sii) goto err_close_ni; sdh = ntfs_index_ctx_get(ni, sdh_stream, 4); if (!sdh) goto err_close_sii; vol->secure_xsdh = sdh; vol->secure_xsii = sii; vol->secure_ni = ni; return 0; err_close_sii: ntfs_index_ctx_put(sii); err_close_ni: ntfs_inode_close(ni); err: /* Failing on NTFS pre-v3.0 is expected. */ if (vol->major_ver < 3) return 0; ntfs_log_perror("Failed to open $Secure"); return -1; } /* * Close the volume's security descriptor index ($Secure) * * returns 0 if it succeeds * -1 with errno set if it fails */ int ntfs_close_secure(ntfs_volume *vol) { int res = 0; if (vol->secure_ni) { ntfs_index_ctx_put(vol->secure_xsdh); ntfs_index_ctx_put(vol->secure_xsii); res = ntfs_inode_close(vol->secure_ni); vol->secure_ni = NULL; } return res; } /* * Destroy a security context * Allocated memory is freed to facilitate the detection of memory leaks */ void ntfs_destroy_security_context(struct SECURITY_CONTEXT *scx) { ntfs_free_mapping(scx->mapping); free_caches(scx); } /* * API for direct access to security descriptors * based on Win32 API */ /* * Selective feeding of a security descriptor into user buffer * * Returns TRUE if successful */ static BOOL feedsecurityattr(const char *attr, u32 selection, char *buf, u32 buflen, u32 *psize) { const SECURITY_DESCRIPTOR_RELATIVE *phead; SECURITY_DESCRIPTOR_RELATIVE *pnhead; const ACL *pdacl; const ACL *psacl; const SID *pusid; const SID *pgsid; unsigned int offdacl; unsigned int offsacl; unsigned int offowner; unsigned int offgroup; unsigned int daclsz; unsigned int saclsz; unsigned int usidsz; unsigned int gsidsz; unsigned int size; /* size of requested attributes */ BOOL ok; unsigned int pos; unsigned int avail; le16 control; avail = 0; control = SE_SELF_RELATIVE; phead = (const SECURITY_DESCRIPTOR_RELATIVE*)attr; size = sizeof(SECURITY_DESCRIPTOR_RELATIVE); /* locate DACL if requested and available */ if (phead->dacl && (selection & DACL_SECURITY_INFORMATION)) { offdacl = le32_to_cpu(phead->dacl); pdacl = (const ACL*)&attr[offdacl]; daclsz = le16_to_cpu(pdacl->size); size += daclsz; avail |= DACL_SECURITY_INFORMATION; } else offdacl = daclsz = 0; /* locate owner if requested and available */ offowner = le32_to_cpu(phead->owner); if (offowner && (selection & OWNER_SECURITY_INFORMATION)) { /* find end of USID */ pusid = (const SID*)&attr[offowner]; usidsz = ntfs_sid_size(pusid); size += usidsz; avail |= OWNER_SECURITY_INFORMATION; } else offowner = usidsz = 0; /* locate group if requested and available */ offgroup = le32_to_cpu(phead->group); if (offgroup && (selection & GROUP_SECURITY_INFORMATION)) { /* find end of GSID */ pgsid = (const SID*)&attr[offgroup]; gsidsz = ntfs_sid_size(pgsid); size += gsidsz; avail |= GROUP_SECURITY_INFORMATION; } else offgroup = gsidsz = 0; /* locate SACL if requested and available */ if (phead->sacl && (selection & SACL_SECURITY_INFORMATION)) { /* find end of SACL */ offsacl = le32_to_cpu(phead->sacl); psacl = (const ACL*)&attr[offsacl]; saclsz = le16_to_cpu(psacl->size); size += saclsz; avail |= SACL_SECURITY_INFORMATION; } else offsacl = saclsz = 0; /* * Check having enough size in destination buffer * (required size is returned nevertheless so that * the request can be reissued with adequate size) */ if (size > buflen) { *psize = size; errno = EINVAL; ok = FALSE; } else { if (selection & OWNER_SECURITY_INFORMATION) control |= phead->control & SE_OWNER_DEFAULTED; if (selection & GROUP_SECURITY_INFORMATION) control |= phead->control & SE_GROUP_DEFAULTED; if (selection & DACL_SECURITY_INFORMATION) control |= phead->control & (SE_DACL_PRESENT | SE_DACL_DEFAULTED | SE_DACL_AUTO_INHERITED | SE_DACL_PROTECTED); if (selection & SACL_SECURITY_INFORMATION) control |= phead->control & (SE_SACL_PRESENT | SE_SACL_DEFAULTED | SE_SACL_AUTO_INHERITED | SE_SACL_PROTECTED); /* * copy header and feed new flags, even if no detailed data */ memcpy(buf,attr,sizeof(SECURITY_DESCRIPTOR_RELATIVE)); pnhead = (SECURITY_DESCRIPTOR_RELATIVE*)buf; pnhead->control = control; pos = sizeof(SECURITY_DESCRIPTOR_RELATIVE); /* copy DACL if requested and available */ if (selection & avail & DACL_SECURITY_INFORMATION) { pnhead->dacl = cpu_to_le32(pos); memcpy(&buf[pos],&attr[offdacl],daclsz); pos += daclsz; } else pnhead->dacl = const_cpu_to_le32(0); /* copy SACL if requested and available */ if (selection & avail & SACL_SECURITY_INFORMATION) { pnhead->sacl = cpu_to_le32(pos); memcpy(&buf[pos],&attr[offsacl],saclsz); pos += saclsz; } else pnhead->sacl = const_cpu_to_le32(0); /* copy owner if requested and available */ if (selection & avail & OWNER_SECURITY_INFORMATION) { pnhead->owner = cpu_to_le32(pos); memcpy(&buf[pos],&attr[offowner],usidsz); pos += usidsz; } else pnhead->owner = const_cpu_to_le32(0); /* copy group if requested and available */ if (selection & avail & GROUP_SECURITY_INFORMATION) { pnhead->group = cpu_to_le32(pos); memcpy(&buf[pos],&attr[offgroup],gsidsz); pos += gsidsz; } else pnhead->group = const_cpu_to_le32(0); if (pos != size) ntfs_log_error("Error in security descriptor size\n"); *psize = size; ok = TRUE; } return (ok); } /* * Merge a new security descriptor into the old one * and assign to designated file * * Returns TRUE if successful */ static BOOL mergesecurityattr(ntfs_volume *vol, const char *oldattr, const char *newattr, u32 selection, ntfs_inode *ni) { const SECURITY_DESCRIPTOR_RELATIVE *oldhead; const SECURITY_DESCRIPTOR_RELATIVE *newhead; SECURITY_DESCRIPTOR_RELATIVE *targhead; const ACL *pdacl; const ACL *psacl; const SID *powner; const SID *pgroup; int offdacl; int offsacl; int offowner; int offgroup; unsigned int size; le16 control; char *target; int pos; int oldattrsz; int newattrsz; BOOL ok; ok = FALSE; /* default return */ oldhead = (const SECURITY_DESCRIPTOR_RELATIVE*)oldattr; newhead = (const SECURITY_DESCRIPTOR_RELATIVE*)newattr; oldattrsz = ntfs_attr_size(oldattr); newattrsz = ntfs_attr_size(newattr); target = (char*)ntfs_malloc(oldattrsz + newattrsz); if (target) { targhead = (SECURITY_DESCRIPTOR_RELATIVE*)target; pos = sizeof(SECURITY_DESCRIPTOR_RELATIVE); control = SE_SELF_RELATIVE; /* * copy new DACL if selected * or keep old DACL if any */ if ((selection & DACL_SECURITY_INFORMATION) ? newhead->dacl : oldhead->dacl) { if (selection & DACL_SECURITY_INFORMATION) { offdacl = le32_to_cpu(newhead->dacl); pdacl = (const ACL*)&newattr[offdacl]; } else { offdacl = le32_to_cpu(oldhead->dacl); pdacl = (const ACL*)&oldattr[offdacl]; } size = le16_to_cpu(pdacl->size); memcpy(&target[pos], pdacl, size); targhead->dacl = cpu_to_le32(pos); pos += size; } else targhead->dacl = const_cpu_to_le32(0); if (selection & DACL_SECURITY_INFORMATION) { control |= newhead->control & (SE_DACL_PRESENT | SE_DACL_DEFAULTED | SE_DACL_PROTECTED); if (newhead->control & SE_DACL_AUTO_INHERIT_REQ) control |= SE_DACL_AUTO_INHERITED; } else control |= oldhead->control & (SE_DACL_PRESENT | SE_DACL_DEFAULTED | SE_DACL_AUTO_INHERITED | SE_DACL_PROTECTED); /* * copy new SACL if selected * or keep old SACL if any */ if ((selection & SACL_SECURITY_INFORMATION) ? newhead->sacl : oldhead->sacl) { if (selection & SACL_SECURITY_INFORMATION) { offsacl = le32_to_cpu(newhead->sacl); psacl = (const ACL*)&newattr[offsacl]; } else { offsacl = le32_to_cpu(oldhead->sacl); psacl = (const ACL*)&oldattr[offsacl]; } size = le16_to_cpu(psacl->size); memcpy(&target[pos], psacl, size); targhead->sacl = cpu_to_le32(pos); pos += size; } else targhead->sacl = const_cpu_to_le32(0); if (selection & SACL_SECURITY_INFORMATION) { control |= newhead->control & (SE_SACL_PRESENT | SE_SACL_DEFAULTED | SE_SACL_PROTECTED); if (newhead->control & SE_SACL_AUTO_INHERIT_REQ) control |= SE_SACL_AUTO_INHERITED; } else control |= oldhead->control & (SE_SACL_PRESENT | SE_SACL_DEFAULTED | SE_SACL_AUTO_INHERITED | SE_SACL_PROTECTED); /* * copy new OWNER if selected * or keep old OWNER if any */ if ((selection & OWNER_SECURITY_INFORMATION) ? newhead->owner : oldhead->owner) { if (selection & OWNER_SECURITY_INFORMATION) { offowner = le32_to_cpu(newhead->owner); powner = (const SID*)&newattr[offowner]; } else { offowner = le32_to_cpu(oldhead->owner); powner = (const SID*)&oldattr[offowner]; } size = ntfs_sid_size(powner); memcpy(&target[pos], powner, size); targhead->owner = cpu_to_le32(pos); pos += size; } else targhead->owner = const_cpu_to_le32(0); if (selection & OWNER_SECURITY_INFORMATION) control |= newhead->control & SE_OWNER_DEFAULTED; else control |= oldhead->control & SE_OWNER_DEFAULTED; /* * copy new GROUP if selected * or keep old GROUP if any */ if ((selection & GROUP_SECURITY_INFORMATION) ? newhead->group : oldhead->group) { if (selection & GROUP_SECURITY_INFORMATION) { offgroup = le32_to_cpu(newhead->group); pgroup = (const SID*)&newattr[offgroup]; control |= newhead->control & SE_GROUP_DEFAULTED; } else { offgroup = le32_to_cpu(oldhead->group); pgroup = (const SID*)&oldattr[offgroup]; control |= oldhead->control & SE_GROUP_DEFAULTED; } size = ntfs_sid_size(pgroup); memcpy(&target[pos], pgroup, size); targhead->group = cpu_to_le32(pos); pos += size; } else targhead->group = const_cpu_to_le32(0); if (selection & GROUP_SECURITY_INFORMATION) control |= newhead->control & SE_GROUP_DEFAULTED; else control |= oldhead->control & SE_GROUP_DEFAULTED; targhead->revision = SECURITY_DESCRIPTOR_REVISION; targhead->alignment = 0; targhead->control = control; ok = !update_secur_descr(vol, target, ni); free(target); } return (ok); } /* * Return the security descriptor of a file * This is intended to be similar to GetFileSecurity() from Win32 * in order to facilitate the development of portable tools * * returns zero if unsuccessful (following Win32 conventions) * -1 if no securid * the securid if any * * The Win32 API is : * * BOOL WINAPI GetFileSecurity( * __in LPCTSTR lpFileName, * __in SECURITY_INFORMATION RequestedInformation, * __out_opt PSECURITY_DESCRIPTOR pSecurityDescriptor, * __in DWORD nLength, * __out LPDWORD lpnLengthNeeded * ); * */ int ntfs_get_file_security(struct SECURITY_API *scapi, const char *path, u32 selection, char *buf, u32 buflen, u32 *psize) { ntfs_inode *ni; char *attr; int res; res = 0; /* default return */ if (scapi && (scapi->magic == MAGIC_API)) { ni = ntfs_pathname_to_inode(scapi->security.vol, NULL, path); if (ni) { attr = getsecurityattr(scapi->security.vol, ni); if (attr) { if (feedsecurityattr(attr,selection, buf,buflen,psize)) { if (test_nino_flag(ni, v3_Extensions) && ni->security_id) res = le32_to_cpu( ni->security_id); else res = -1; } free(attr); } ntfs_inode_close(ni); } else errno = ENOENT; if (!res) *psize = 0; } else errno = EINVAL; /* do not clear *psize */ return (res); } /* * Set the security descriptor of a file or directory * This is intended to be similar to SetFileSecurity() from Win32 * in order to facilitate the development of portable tools * * returns zero if unsuccessful (following Win32 conventions) * -1 if no securid * the securid if any * * The Win32 API is : * * BOOL WINAPI SetFileSecurity( * __in LPCTSTR lpFileName, * __in SECURITY_INFORMATION SecurityInformation, * __in PSECURITY_DESCRIPTOR pSecurityDescriptor * ); */ int ntfs_set_file_security(struct SECURITY_API *scapi, const char *path, u32 selection, const char *attr) { const SECURITY_DESCRIPTOR_RELATIVE *phead; ntfs_inode *ni; int attrsz; BOOL missing; char *oldattr; int res; res = 0; /* default return */ if (scapi && (scapi->magic == MAGIC_API) && attr) { phead = (const SECURITY_DESCRIPTOR_RELATIVE*)attr; attrsz = ntfs_attr_size(attr); /* if selected, owner and group must be present or defaulted */ missing = ((selection & OWNER_SECURITY_INFORMATION) && !phead->owner && !(phead->control & SE_OWNER_DEFAULTED)) || ((selection & GROUP_SECURITY_INFORMATION) && !phead->group && !(phead->control & SE_GROUP_DEFAULTED)); if (!missing && (phead->control & SE_SELF_RELATIVE) && ntfs_valid_descr(attr, attrsz)) { ni = ntfs_pathname_to_inode(scapi->security.vol, NULL, path); if (ni) { oldattr = getsecurityattr(scapi->security.vol, ni); if (oldattr) { if (mergesecurityattr( scapi->security.vol, oldattr, attr, selection, ni)) { if (test_nino_flag(ni, v3_Extensions)) res = le32_to_cpu( ni->security_id); else res = -1; } free(oldattr); } ntfs_inode_close(ni); } } else errno = EINVAL; } else errno = EINVAL; return (res); } /* * Return the attributes of a file * This is intended to be similar to GetFileAttributes() from Win32 * in order to facilitate the development of portable tools * * returns -1 if unsuccessful (Win32 : INVALID_FILE_ATTRIBUTES) * * The Win32 API is : * * DWORD WINAPI GetFileAttributes( * __in LPCTSTR lpFileName * ); */ int ntfs_get_file_attributes(struct SECURITY_API *scapi, const char *path) { ntfs_inode *ni; s32 attrib; attrib = -1; /* default return */ if (scapi && (scapi->magic == MAGIC_API) && path) { ni = ntfs_pathname_to_inode(scapi->security.vol, NULL, path); if (ni) { attrib = le32_to_cpu(ni->flags); if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) attrib |= const_le32_to_cpu(FILE_ATTR_DIRECTORY); else attrib &= ~const_le32_to_cpu(FILE_ATTR_DIRECTORY); if (!attrib) attrib |= const_le32_to_cpu(FILE_ATTR_NORMAL); ntfs_inode_close(ni); } else errno = ENOENT; } else errno = EINVAL; /* do not clear *psize */ return (attrib); } /* * Set attributes to a file or directory * This is intended to be similar to SetFileAttributes() from Win32 * in order to facilitate the development of portable tools * * Only a few flags can be set (same list as Win32) * * returns zero if unsuccessful (following Win32 conventions) * nonzero if successful * * The Win32 API is : * * BOOL WINAPI SetFileAttributes( * __in LPCTSTR lpFileName, * __in DWORD dwFileAttributes * ); */ BOOL ntfs_set_file_attributes(struct SECURITY_API *scapi, const char *path, s32 attrib) { ntfs_inode *ni; le32 settable; ATTR_FLAGS dirflags; int res; res = 0; /* default return */ if (scapi && (scapi->magic == MAGIC_API) && path) { ni = ntfs_pathname_to_inode(scapi->security.vol, NULL, path); if (ni) { settable = FILE_ATTR_SETTABLE; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { /* * Accept changing compression for a directory * and set index root accordingly */ settable |= FILE_ATTR_COMPRESSED; if ((ni->flags ^ cpu_to_le32(attrib)) & FILE_ATTR_COMPRESSED) { if (ni->flags & FILE_ATTR_COMPRESSED) dirflags = const_cpu_to_le16(0); else dirflags = ATTR_IS_COMPRESSED; res = ntfs_attr_set_flags(ni, AT_INDEX_ROOT, NTFS_INDEX_I30, 4, dirflags, ATTR_COMPRESSION_MASK); } } if (!res) { ni->flags = (ni->flags & ~settable) | (cpu_to_le32(attrib) & settable); NInoSetDirty(ni); NInoFileNameSetDirty(ni); } if (!ntfs_inode_close(ni)) res = -1; } else errno = ENOENT; } return (res); } BOOL ntfs_read_directory(struct SECURITY_API *scapi, const char *path, ntfs_filldir_t callback, void *context) { ntfs_inode *ni; BOOL ok; s64 pos; ok = FALSE; /* default return */ if (scapi && (scapi->magic == MAGIC_API) && callback) { ni = ntfs_pathname_to_inode(scapi->security.vol, NULL, path); if (ni) { if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { pos = 0; ntfs_readdir(ni,&pos,context,callback); ok = !ntfs_inode_close(ni); } else { ntfs_inode_close(ni); errno = ENOTDIR; } } else errno = ENOENT; } else errno = EINVAL; /* do not clear *psize */ return (ok); } /* * read $SDS (for auditing security data) * * Returns the number or read bytes, or -1 if there is an error */ int ntfs_read_sds(struct SECURITY_API *scapi, char *buf, u32 size, u32 offset) { int got; got = -1; /* default return */ if (scapi && (scapi->magic == MAGIC_API)) { if (scapi->security.vol->secure_ni) got = ntfs_attr_data_read(scapi->security.vol->secure_ni, STREAM_SDS, 4, buf, size, offset); else errno = EOPNOTSUPP; } else errno = EINVAL; return (got); } /* * read $SII (for auditing security data) * * Returns next entry, or NULL if there is an error */ INDEX_ENTRY *ntfs_read_sii(struct SECURITY_API *scapi, INDEX_ENTRY *entry) { SII_INDEX_KEY key; INDEX_ENTRY *ret; BOOL found; ntfs_index_context *xsii; ret = (INDEX_ENTRY*)NULL; /* default return */ if (scapi && (scapi->magic == MAGIC_API)) { xsii = scapi->security.vol->secure_xsii; if (xsii) { if (!entry) { key.security_id = const_cpu_to_le32(0); found = !ntfs_index_lookup((char*)&key, sizeof(SII_INDEX_KEY), xsii); /* not supposed to find */ if (!found && (errno == ENOENT)) ret = xsii->entry; } else ret = ntfs_index_next(entry,xsii); if (!ret) errno = ENODATA; } else errno = EOPNOTSUPP; } else errno = EINVAL; return (ret); } /* * read $SDH (for auditing security data) * * Returns next entry, or NULL if there is an error */ INDEX_ENTRY *ntfs_read_sdh(struct SECURITY_API *scapi, INDEX_ENTRY *entry) { SDH_INDEX_KEY key; INDEX_ENTRY *ret; BOOL found; ntfs_index_context *xsdh; ret = (INDEX_ENTRY*)NULL; /* default return */ if (scapi && (scapi->magic == MAGIC_API)) { xsdh = scapi->security.vol->secure_xsdh; if (xsdh) { if (!entry) { key.hash = const_cpu_to_le32(0); key.security_id = const_cpu_to_le32(0); found = !ntfs_index_lookup((char*)&key, sizeof(SDH_INDEX_KEY), xsdh); /* not supposed to find */ if (!found && (errno == ENOENT)) ret = xsdh->entry; } else ret = ntfs_index_next(entry,xsdh); if (!ret) errno = ENODATA; } else errno = ENOTSUP; } else errno = EINVAL; return (ret); } /* * Get the mapped user SID * A buffer of 40 bytes has to be supplied * * returns the size of the SID, or zero and errno set if not found */ int ntfs_get_usid(struct SECURITY_API *scapi, uid_t uid, char *buf) { const SID *usid; BIGSID defusid; int size; size = 0; if (scapi && (scapi->magic == MAGIC_API)) { usid = ntfs_find_usid(scapi->security.mapping[MAPUSERS], uid, (SID*)&defusid); if (usid) { size = ntfs_sid_size(usid); memcpy(buf,usid,size); } else errno = ENODATA; } else errno = EINVAL; return (size); } /* * Get the mapped group SID * A buffer of 40 bytes has to be supplied * * returns the size of the SID, or zero and errno set if not found */ int ntfs_get_gsid(struct SECURITY_API *scapi, gid_t gid, char *buf) { const SID *gsid; BIGSID defgsid; int size; size = 0; if (scapi && (scapi->magic == MAGIC_API)) { gsid = ntfs_find_gsid(scapi->security.mapping[MAPGROUPS], gid, (SID*)&defgsid); if (gsid) { size = ntfs_sid_size(gsid); memcpy(buf,gsid,size); } else errno = ENODATA; } else errno = EINVAL; return (size); } /* * Get the user mapped to a SID * * returns the uid, or -1 if not found */ int ntfs_get_user(struct SECURITY_API *scapi, const SID *usid) { int uid; uid = -1; if (scapi && (scapi->magic == MAGIC_API) && ntfs_valid_sid(usid)) { if (ntfs_same_sid(usid,adminsid)) uid = 0; else { uid = ntfs_find_user(scapi->security.mapping[MAPUSERS], usid); if (!uid) { uid = -1; errno = ENODATA; } } } else errno = EINVAL; return (uid); } /* * Get the group mapped to a SID * * returns the uid, or -1 if not found */ int ntfs_get_group(struct SECURITY_API *scapi, const SID *gsid) { int gid; gid = -1; if (scapi && (scapi->magic == MAGIC_API) && ntfs_valid_sid(gsid)) { if (ntfs_same_sid(gsid,adminsid)) gid = 0; else { gid = ntfs_find_group(scapi->security.mapping[MAPGROUPS], gsid); if (!gid) { gid = -1; errno = ENODATA; } } } else errno = EINVAL; return (gid); } /* * Initializations before calling ntfs_get_file_security() * ntfs_set_file_security() and ntfs_read_directory() * * Only allowed for root * * Returns an (obscured) struct SECURITY_API* needed for further calls * NULL if not root (EPERM) or device is mounted (EBUSY) */ struct SECURITY_API *ntfs_initialize_file_security(const char *device, unsigned long flags) { ntfs_volume *vol; unsigned long mntflag; int mnt; struct SECURITY_API *scapi; struct SECURITY_CONTEXT *scx; scapi = (struct SECURITY_API*)NULL; mnt = ntfs_check_if_mounted(device, &mntflag); if (!mnt && !(mntflag & NTFS_MF_MOUNTED) && !getuid()) { vol = ntfs_mount(device, flags); if (vol) { scapi = (struct SECURITY_API*) ntfs_malloc(sizeof(struct SECURITY_API)); if (!ntfs_volume_get_free_space(vol) && scapi) { scapi->magic = MAGIC_API; scapi->seccache = (struct PERMISSIONS_CACHE*)NULL; scx = &scapi->security; scx->vol = vol; scx->uid = getuid(); scx->gid = getgid(); scx->pseccache = &scapi->seccache; scx->vol->secure_flags = 0; /* accept no mapping and no $Secure */ ntfs_build_mapping(scx,(const char*)NULL,TRUE); } else { if (scapi) free(scapi); else errno = ENOMEM; mnt = ntfs_umount(vol,FALSE); scapi = (struct SECURITY_API*)NULL; } } } else if (getuid()) errno = EPERM; else errno = EBUSY; return (scapi); } /* * Leaving after ntfs_initialize_file_security() * * Returns FALSE if FAILED */ BOOL ntfs_leave_file_security(struct SECURITY_API *scapi) { int ok; ntfs_volume *vol; ok = FALSE; if (scapi && (scapi->magic == MAGIC_API) && scapi->security.vol) { vol = scapi->security.vol; ntfs_destroy_security_context(&scapi->security); free(scapi); if (!ntfs_umount(vol, 0)) ok = TRUE; } return (ok); } ntfsprogs-plus-1.0.0/libntfs/unistr.c000066400000000000000000001372061507404161300176610ustar00rootroot00000000000000/** * unistr.c - Unicode string handling. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2004 Anton Altaparmakov * Copyright (c) 2002-2009 Szabolcs Szakacsits * Copyright (c) 2008-2015 Jean-Pierre Andre * Copyright (c) 2008 Bernhard Kaindl * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_WCHAR_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_LOCALE_H #include #endif #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV #include #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ #include "compat.h" #include "attrib.h" #include "types.h" #include "unistr.h" #include "debug.h" #include "logging.h" #include "misc.h" #ifndef ALLOW_BROKEN_UNICODE /* Erik allowing broken UTF-16 surrogate pairs and U+FFFE and U+FFFF by default, * open to debate. */ #define ALLOW_BROKEN_UNICODE 1 #endif /* !defined(ALLOW_BROKEN_UNICODE) */ /* * IMPORTANT * ========= * * All these routines assume that the Unicode characters are in little endian * encoding inside the strings!!! */ static int use_utf8 = 1; /* use UTF-8 encoding for file names */ #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV /** * This variable controls whether or not automatic normalization form conversion * should be performed when translating NTFS unicode file names to UTF-8. * Defaults to on, but can be controlled from the outside using the function * int ntfs_macosx_normalize_filenames(int normalize); */ static int nfconvert_utf8 = 1; #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ /* * This is used by the name collation functions to quickly determine what * characters are (in)valid. */ #if 0 static const u8 legal_ansi_char_array[0x40] = { 0x00, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x10, 0x17, 0x07, 0x18, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x18, 0x16, 0x16, 0x17, 0x07, 0x00, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x17, 0x04, 0x16, 0x18, 0x16, 0x18, 0x18, }; #endif /** * ntfs_names_are_equal - compare two Unicode names for equality * @s1: name to compare to @s2 * @s1_len: length in Unicode characters of @s1 * @s2: name to compare to @s1 * @s2_len: length in Unicode characters of @s2 * @ic: ignore case bool * @upcase: upcase table (only if @ic == IGNORE_CASE) * @upcase_size: length in Unicode characters of @upcase (if present) * * Compare the names @s1 and @s2 and return TRUE (1) if the names are * identical, or FALSE (0) if they are not identical. If @ic is IGNORE_CASE, * the @upcase table is used to perform a case insensitive comparison. */ BOOL ntfs_names_are_equal(const ntfschar *s1, size_t s1_len, const ntfschar *s2, size_t s2_len, const IGNORE_CASE_BOOL ic, const ntfschar *upcase, const u32 upcase_size) { if (s1_len != s2_len) return FALSE; if (!s1_len) return TRUE; if (ic == CASE_SENSITIVE) return ntfs_ucsncmp(s1, s2, s1_len) ? FALSE: TRUE; return ntfs_ucsncasecmp(s1, s2, s1_len, upcase, upcase_size) ? FALSE: TRUE; } /* * ntfs_names_full_collate() fully collate two Unicode names * * @name1: first Unicode name to compare * @name1_len: length of first Unicode name to compare * @name2: second Unicode name to compare * @name2_len: length of second Unicode name to compare * @ic: either CASE_SENSITIVE or IGNORE_CASE (see below) * @upcase: upcase table * @upcase_len: upcase table size * * If @ic is CASE_SENSITIVE, then the names are compared primarily ignoring * case, but if the names are equal ignoring case, then they are compared * case-sensitively. As an example, "abc" would collate before "BCD" (since * "abc" and "BCD" differ ignoring case and 'A' < 'B') but after "ABC" (since * "ABC" and "abc" are equal ignoring case and 'A' < 'a'). This matches the * collation order of filenames as indexed in NTFS directories. * * If @ic is IGNORE_CASE, then the names are only compared case-insensitively * and are considered to match if and only if they are equal ignoring case. * * Returns: * -1 if the first name collates before the second one, * 0 if the names match, or * 1 if the second name collates before the first one */ int ntfs_names_full_collate(const ntfschar *name1, const u32 name1_len, const ntfschar *name2, const u32 name2_len, const IGNORE_CASE_BOOL ic, const ntfschar *upcase, const u32 upcase_len) { u32 cnt; u16 c1, c2; u16 u1, u2; #ifdef DEBUG if (!name1 || !name2 || !upcase || !upcase_len) { ntfs_log_debug("ntfs_names_collate received NULL pointer!\n"); exit(1); } #endif cnt = min(name1_len, name2_len); if (cnt > 0) { if (ic == CASE_SENSITIVE) { while (--cnt && (*name1 == *name2)) { name1++; name2++; } u1 = c1 = le16_to_cpu(*name1); u2 = c2 = le16_to_cpu(*name2); if (u1 < upcase_len) u1 = le16_to_cpu(upcase[u1]); if (u2 < upcase_len) u2 = le16_to_cpu(upcase[u2]); if ((u1 == u2) && cnt) do { name1++; u1 = le16_to_cpu(*name1); name2++; u2 = le16_to_cpu(*name2); if (u1 < upcase_len) u1 = le16_to_cpu(upcase[u1]); if (u2 < upcase_len) u2 = le16_to_cpu(upcase[u2]); } while ((u1 == u2) && --cnt); if (u1 < u2) return -1; if (u1 > u2) return 1; if (name1_len < name2_len) return -1; if (name1_len > name2_len) return 1; if (c1 < c2) return -1; if (c1 > c2) return 1; } else { do { u1 = le16_to_cpu(*name1); name1++; u2 = le16_to_cpu(*name2); name2++; if (u1 < upcase_len) u1 = le16_to_cpu(upcase[u1]); if (u2 < upcase_len) u2 = le16_to_cpu(upcase[u2]); } while ((u1 == u2) && --cnt); if (u1 < u2) return -1; if (u1 > u2) return 1; if (name1_len < name2_len) return -1; if (name1_len > name2_len) return 1; } } else { if (name1_len < name2_len) return -1; if (name1_len > name2_len) return 1; } return 0; } /** * ntfs_ucsncmp - compare two little endian Unicode strings * @s1: first string * @s2: second string * @n: maximum unicode characters to compare * * Compare the first @n characters of the Unicode strings @s1 and @s2, * The strings in little endian format and appropriate le16_to_cpu() * conversion is performed on non-little endian machines. * * The function returns an integer less than, equal to, or greater than zero * if @s1 (or the first @n Unicode characters thereof) is found, respectively, * to be less than, to match, or be greater than @s2. */ int ntfs_ucsncmp(const ntfschar *s1, const ntfschar *s2, size_t n) { u16 c1, c2; size_t i; #ifdef DEBUG if (!s1 || !s2) { ntfs_log_debug("ntfs_wcsncmp() received NULL pointer!\n"); exit(1); } #endif for (i = 0; i < n; ++i) { c1 = le16_to_cpu(s1[i]); c2 = le16_to_cpu(s2[i]); if (c1 < c2) return -1; if (c1 > c2) return 1; if (!c1) break; } return 0; } /** * ntfs_ucsncasecmp - compare two little endian Unicode strings, ignoring case * @s1: first string * @s2: second string * @n: maximum unicode characters to compare * @upcase: upcase table * @upcase_size: upcase table size in Unicode characters * * Compare the first @n characters of the Unicode strings @s1 and @s2, * ignoring case. The strings in little endian format and appropriate * le16_to_cpu() conversion is performed on non-little endian machines. * * Each character is uppercased using the @upcase table before the comparison. * * The function returns an integer less than, equal to, or greater than zero * if @s1 (or the first @n Unicode characters thereof) is found, respectively, * to be less than, to match, or be greater than @s2. */ int ntfs_ucsncasecmp(const ntfschar *s1, const ntfschar *s2, size_t n, const ntfschar *upcase, const u32 upcase_size) { u16 c1, c2; size_t i; #ifdef DEBUG if (!s1 || !s2 || !upcase) { ntfs_log_debug("ntfs_wcsncasecmp() received NULL pointer!\n"); exit(1); } #endif for (i = 0; i < n; ++i) { if ((c1 = le16_to_cpu(s1[i])) < upcase_size) c1 = le16_to_cpu(upcase[c1]); if ((c2 = le16_to_cpu(s2[i])) < upcase_size) c2 = le16_to_cpu(upcase[c2]); if (c1 < c2) return -1; if (c1 > c2) return 1; if (!c1) break; } return 0; } /** * ntfs_ucsnlen - determine the length of a little endian Unicode string * @s: pointer to Unicode string * @maxlen: maximum length of string @s * * Return the number of Unicode characters in the little endian Unicode * string @s up to a maximum of maxlen Unicode characters, not including * the terminating (ntfschar)'\0'. If there is no (ntfschar)'\0' between @s * and @s + @maxlen, @maxlen is returned. * * This function never looks beyond @s + @maxlen. */ u32 ntfs_ucsnlen(const ntfschar *s, u32 maxlen) { u32 i; for (i = 0; i < maxlen; i++) { if (!le16_to_cpu(s[i])) break; } return i; } /** * ntfs_ucsndup - duplicate little endian Unicode string * @s: pointer to Unicode string * @maxlen: maximum length of string @s * * Return a pointer to a new little endian Unicode string which is a duplicate * of the string s. Memory for the new string is obtained with ntfs_malloc(3), * and can be freed with free(3). * * A maximum of @maxlen Unicode characters are copied and a terminating * (ntfschar)'\0' little endian Unicode character is added. * * This function never looks beyond @s + @maxlen. * * Return a pointer to the new little endian Unicode string on success and NULL * on failure with errno set to the error code. */ ntfschar *ntfs_ucsndup(const ntfschar *s, u32 maxlen) { ntfschar *dst; u32 len; len = ntfs_ucsnlen(s, maxlen); dst = ntfs_malloc((len + 1) * sizeof(ntfschar)); if (dst) { memcpy(dst, s, len * sizeof(ntfschar)); dst[len] = const_cpu_to_le16(L'\0'); } return dst; } /** * ntfs_name_upcase - Map an Unicode name to its uppercase equivalent * @name: * @name_len: * @upcase: * @upcase_len: * * Description... * * Returns: */ void ntfs_name_upcase(ntfschar *name, u32 name_len, const ntfschar *upcase, const u32 upcase_len) { u32 i; u16 u; for (i = 0; i < name_len; i++) if ((u = le16_to_cpu(name[i])) < upcase_len) name[i] = upcase[u]; } /** * ntfs_name_locase - Map a Unicode name to its lowercase equivalent */ void ntfs_name_locase(ntfschar *name, u32 name_len, const ntfschar *locase, const u32 locase_len) { u32 i; u16 u; if (locase) for (i = 0; i < name_len; i++) if ((u = le16_to_cpu(name[i])) < locase_len) name[i] = locase[u]; } /** * ntfs_file_value_upcase - Convert a filename to upper case * @file_name_attr: * @upcase: * @upcase_len: * * Description... * * Returns: */ void ntfs_file_value_upcase(FILE_NAME_ATTR *file_name_attr, const ntfschar *upcase, const u32 upcase_len) { ntfs_name_upcase((ntfschar*)&file_name_attr->file_name, file_name_attr->file_name_length, upcase, upcase_len); } /* NTFS uses Unicode (UTF-16LE [NTFS-3G uses UCS-2LE, which is enough for now]) for path names, but the Unicode code points need to be converted before a path can be accessed under NTFS. For 7 bit ASCII/ANSI, glibc does this even without a locale in a hard-coded fashion as that appears to be is easy because the low 7-bit ASCII range appears to be available in all charsets but it does not convert anything if there was some error with the locale setup or none set up like when mount is called during early boot where he (by policy) do not use locales (and may be not available if /usr is not yet mounted), so this patch fixes the resulting issues for systems which use UTF-8 and for others, specifying the locale in fstab brings them the encoding which they want. If no locale is defined or there was a problem with setting one up and whenever nl_langinfo(CODESET) returns a sting starting with "ANSI", use an internal UCS-2LE <-> UTF-8 codeset converter to fix the bug where NTFS-3G does not show any path names which include international characters!!! (and also fails on creating them) as result. Author: Bernhard Kaindl Jean-Pierre Andre made it compliant with RFC3629/RFC2781. */ /* * Return the number of bytes in UTF-8 needed (without the terminating null) to * store the given UTF-16LE string. * * On error, -1 is returned, and errno is set to the error code. The following * error codes can be expected: * EILSEQ The input string is not valid UTF-16LE (only possible * if compiled without ALLOW_BROKEN_UNICODE). * ENAMETOOLONG The length of the UTF-8 string in bytes (without the * terminating null) would exceed @outs_len. */ static int utf16_to_utf8_size(const ntfschar *ins, const int ins_len, int outs_len) { int i, ret = -1; int count = 0; BOOL surrog; surrog = FALSE; for (i = 0; i < ins_len && ins[i] && count <= outs_len; i++) { unsigned short c = le16_to_cpu(ins[i]); if (surrog) { if ((c >= 0xdc00) && (c < 0xe000)) { surrog = FALSE; count += 4; } else { #if ALLOW_BROKEN_UNICODE /* The first UTF-16 unit of a surrogate pair has * a value between 0xd800 and 0xdc00. It can be * encoded as an individual UTF-8 sequence if we * cannot combine it with the next UTF-16 unit * unit as a surrogate pair. */ surrog = FALSE; count += 3; --i; continue; #else goto fail; #endif /* ALLOW_BROKEN_UNICODE */ } } else if (c < 0x80) count++; else if (c < 0x800) count += 2; else if (c < 0xd800) count += 3; else if (c < 0xdc00) surrog = TRUE; #if ALLOW_BROKEN_UNICODE else if (c < 0xe000) count += 3; else if (c >= 0xe000) #else else if ((c >= 0xe000) && (c < 0xfffe)) #endif /* ALLOW_BROKEN_UNICODE */ count += 3; else goto fail; } if (surrog && count <= outs_len) { #if ALLOW_BROKEN_UNICODE count += 3; /* ending with a single surrogate */ #else goto fail; #endif /* ALLOW_BROKEN_UNICODE */ } if (count > outs_len) { errno = ENAMETOOLONG; goto out; } ret = count; out: return ret; fail: errno = EILSEQ; goto out; } /* * ntfs_utf16_to_utf8 - convert a little endian UTF16LE string to an UTF-8 string * @ins: input utf16 string buffer * @ins_len: length of input string in utf16 characters * @outs: on return contains the (allocated) output multibyte string * @outs_len: length of output buffer in bytes (ignored if *@outs is NULL) * * Return -1 with errno set if string has invalid byte sequence or too long. */ static int ntfs_utf16_to_utf8(const ntfschar *ins, const int ins_len, char **outs, int outs_len) { #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV char *original_outs_value = *outs; int original_outs_len = outs_len; #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ char *t; int i, size, ret = -1; int halfpair; halfpair = 0; if (!*outs) { /* If no output buffer was provided, we will allocate one and * limit its length to PATH_MAX. Note: we follow the standard * convention of PATH_MAX including the terminating null. */ outs_len = PATH_MAX; } /* The size *with* the terminating null is limited to @outs_len, * so the size *without* the terminating null is limited to one less. */ size = utf16_to_utf8_size(ins, ins_len, outs_len - 1); if (size < 0) goto out; if (!*outs) { outs_len = size + 1; *outs = ntfs_malloc(outs_len); if (!*outs) goto out; } t = *outs; for (i = 0; i < ins_len && ins[i]; i++) { unsigned short c = le16_to_cpu(ins[i]); /* size not double-checked */ if (halfpair) { if ((c >= 0xdc00) && (c < 0xe000)) { *t++ = 0xf0 + (((halfpair + 64) >> 8) & 7); *t++ = 0x80 + (((halfpair + 64) >> 2) & 63); *t++ = 0x80 + ((c >> 6) & 15) + ((halfpair & 3) << 4); *t++ = 0x80 + (c & 63); halfpair = 0; } else { #if ALLOW_BROKEN_UNICODE /* The first UTF-16 unit of a surrogate pair has * a value between 0xd800 and 0xdc00. It can be * encoded as an individual UTF-8 sequence if we * cannot combine it with the next UTF-16 unit * unit as a surrogate pair. */ *t++ = 0xe0 | (halfpair >> 12); *t++ = 0x80 | ((halfpair >> 6) & 0x3f); *t++ = 0x80 | (halfpair & 0x3f); halfpair = 0; --i; continue; #else goto fail; #endif /* ALLOW_BROKEN_UNICODE */ } } else if (c < 0x80) { *t++ = c; } else { if (c < 0x800) { *t++ = (0xc0 | ((c >> 6) & 0x3f)); *t++ = 0x80 | (c & 0x3f); } else if (c < 0xd800) { *t++ = 0xe0 | (c >> 12); *t++ = 0x80 | ((c >> 6) & 0x3f); *t++ = 0x80 | (c & 0x3f); } else if (c < 0xdc00) halfpair = c; #if ALLOW_BROKEN_UNICODE else if (c < 0xe000) { *t++ = 0xe0 | (c >> 12); *t++ = 0x80 | ((c >> 6) & 0x3f); *t++ = 0x80 | (c & 0x3f); } #endif /* ALLOW_BROKEN_UNICODE */ else if (c >= 0xe000) { *t++ = 0xe0 | (c >> 12); *t++ = 0x80 | ((c >> 6) & 0x3f); *t++ = 0x80 | (c & 0x3f); } else goto fail; } } #if ALLOW_BROKEN_UNICODE if (halfpair) { /* ending with a single surrogate */ *t++ = 0xe0 | (halfpair >> 12); *t++ = 0x80 | ((halfpair >> 6) & 0x3f); *t++ = 0x80 | (halfpair & 0x3f); } #endif /* ALLOW_BROKEN_UNICODE */ *t = '\0'; #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV if(nfconvert_utf8 && (t - *outs) > 0) { char *new_outs = NULL; int new_outs_len = ntfs_macosx_normalize_utf8(*outs, &new_outs, 0); // Normalize to decomposed form if(new_outs_len >= 0 && new_outs != NULL) { if(original_outs_value != *outs) { // We have allocated outs ourselves. free(*outs); *outs = new_outs; t = *outs + new_outs_len; } else { // We need to copy new_outs into the fixed outs buffer. memset(*outs, 0, original_outs_len); strncpy(*outs, new_outs, original_outs_len-1); t = *outs + original_outs_len; free(new_outs); } } else { ntfs_log_error("Failed to normalize NTFS string to UTF-8 NFD: %s\n", *outs); ntfs_log_error(" new_outs=0x%p\n", new_outs); ntfs_log_error(" new_outs_len=%d\n", new_outs_len); } } #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ ret = t - *outs; out: return ret; fail: errno = EILSEQ; goto out; } /* * Return the amount of 16-bit elements in UTF-16LE needed * (without the terminating null) to store given UTF-8 string. * * Return -1 with errno set if it's longer than PATH_MAX or string is invalid. * * Note: This does not check whether the input sequence is a valid utf8 string, * and should be used only in context where such check is made! */ static int utf8_to_utf16_size(const char *s) { int ret = -1; unsigned int byte; size_t count = 0; while ((byte = *((const unsigned char *)s++))) { if (++count >= PATH_MAX) goto fail; if (byte >= 0xc0) { if (byte >= 0xF5) { errno = EILSEQ; goto out; } if (!*s) break; if (byte >= 0xC0) s++; if (!*s) break; if (byte >= 0xE0) s++; if (!*s) break; if (byte >= 0xF0) { s++; if (++count >= PATH_MAX) goto fail; } } } ret = count; out: return ret; fail: errno = ENAMETOOLONG; goto out; } /* * This converts one UTF-8 sequence to cpu-endian Unicode value * within range U+0 .. U+10ffff and excluding U+D800 .. U+DFFF * * Return the number of used utf8 bytes or -1 with errno set * if sequence is invalid. */ static int utf8_to_unicode(u32 *wc, const char *s) { unsigned int byte = *((const unsigned char *)s); /* single byte */ if (byte == 0) { *wc = (u32) 0; return 0; } else if (byte < 0x80) { *wc = (u32) byte; return 1; /* double byte */ } else if (byte < 0xc2) { goto fail; } else if (byte < 0xE0) { if ((s[1] & 0xC0) == 0x80) { *wc = ((u32)(byte & 0x1F) << 6) | ((u32)(s[1] & 0x3F)); return 2; } else goto fail; /* three-byte */ } else if (byte < 0xF0) { if (((s[1] & 0xC0) == 0x80) && ((s[2] & 0xC0) == 0x80)) { *wc = ((u32)(byte & 0x0F) << 12) | ((u32)(s[1] & 0x3F) << 6) | ((u32)(s[2] & 0x3F)); /* Check valid ranges */ #if ALLOW_BROKEN_UNICODE if (((*wc >= 0x800) && (*wc <= 0xD7FF)) || ((*wc >= 0xD800) && (*wc <= 0xDFFF)) || ((*wc >= 0xe000) && (*wc <= 0xFFFF))) return 3; #else if (((*wc >= 0x800) && (*wc <= 0xD7FF)) || ((*wc >= 0xe000) && (*wc <= 0xFFFD))) return 3; #endif /* ALLOW_BROKEN_UNICODE */ } goto fail; /* four-byte */ } else if (byte < 0xF5) { if (((s[1] & 0xC0) == 0x80) && ((s[2] & 0xC0) == 0x80) && ((s[3] & 0xC0) == 0x80)) { *wc = ((u32)(byte & 0x07) << 18) | ((u32)(s[1] & 0x3F) << 12) | ((u32)(s[2] & 0x3F) << 6) | ((u32)(s[3] & 0x3F)); /* Check valid ranges */ if ((*wc <= 0x10ffff) && (*wc >= 0x10000)) return 4; } goto fail; } fail: errno = EILSEQ; return -1; } /** * ntfs_utf8_to_utf16 - convert a UTF-8 string to a UTF-16LE string * @ins: input multibyte string buffer * @outs: on return contains the (allocated) output utf16 string * @outs_len: length of output buffer in utf16 characters * * Return -1 with errno set. */ static int ntfs_utf8_to_utf16(const char *ins, ntfschar **outs) { #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV char *new_ins = NULL; if(nfconvert_utf8) { int new_ins_len; new_ins_len = ntfs_macosx_normalize_utf8(ins, &new_ins, 1); // Normalize to composed form if(new_ins_len >= 0) ins = new_ins; else ntfs_log_error("Failed to normalize NTFS string to UTF-8 NFC: %s\n", ins); } #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ const char *t = ins; u32 wc; BOOL allocated; ntfschar *outpos; int shorts, ret = -1; shorts = utf8_to_utf16_size(ins); if (shorts < 0) goto fail; allocated = FALSE; if (!*outs) { *outs = ntfs_malloc((shorts + 1) * sizeof(ntfschar)); if (!*outs) goto fail; allocated = TRUE; } outpos = *outs; while(1) { int m = utf8_to_unicode(&wc, t); if (m <= 0) { if (m < 0) { /* do not leave space allocated if failed */ if (allocated) { free(*outs); *outs = (ntfschar*)NULL; } goto fail; } *outpos++ = const_cpu_to_le16(0); break; } if (wc < 0x10000) *outpos++ = cpu_to_le16(wc); else { wc -= 0x10000; *outpos++ = cpu_to_le16((wc >> 10) + 0xd800); *outpos++ = cpu_to_le16((wc & 0x3ff) + 0xdc00); } t += m; } ret = --outpos - *outs; fail: #if defined(__APPLE__) || defined(__DARWIN__) #ifdef ENABLE_NFCONV if(new_ins != NULL) free(new_ins); #endif /* ENABLE_NFCONV */ #endif /* defined(__APPLE__) || defined(__DARWIN__) */ return ret; } /** * ntfs_ucstombs - convert a little endian Unicode string to a multibyte string * @ins: input Unicode string buffer * @ins_len: length of input string in Unicode characters * @outs: on return contains the (allocated) output multibyte string * @outs_len: length of output buffer in bytes (ignored if *@outs is NULL) * * Convert the input little endian, 2-byte Unicode string @ins, of length * @ins_len into the multibyte string format dictated by the current locale. * * If *@outs is NULL, the function allocates the string and the caller is * responsible for calling free(*@outs); when finished with it. * * On success the function returns the number of bytes written to the output * string *@outs (>= 0), not counting the terminating NULL byte. If the output * string buffer was allocated, *@outs is set to it. * * On error, -1 is returned, and errno is set to the error code. The following * error codes can be expected: * EINVAL Invalid arguments (e.g. @ins or @outs is NULL). * EILSEQ The input string cannot be represented as a multibyte * sequence according to the current locale. * ENAMETOOLONG Destination buffer is too small for input string. * ENOMEM Not enough memory to allocate destination buffer. */ int ntfs_ucstombs(const ntfschar *ins, const int ins_len, char **outs, int outs_len) { char *mbs; int mbs_len; #ifdef MB_CUR_MAX wchar_t wc; int i, o; int cnt = 0; #ifdef HAVE_MBSINIT mbstate_t mbstate; #endif #endif /* MB_CUR_MAX */ if (!ins || !outs) { errno = EINVAL; return -1; } mbs = *outs; mbs_len = outs_len; if (mbs && !mbs_len) { errno = ENAMETOOLONG; return -1; } if (use_utf8) return ntfs_utf16_to_utf8(ins, ins_len, outs, outs_len); #ifdef MB_CUR_MAX if (!mbs) { mbs_len = (ins_len + 1) * MB_CUR_MAX; mbs = ntfs_malloc(mbs_len); if (!mbs) return -1; } #ifdef HAVE_MBSINIT memset(&mbstate, 0, sizeof(mbstate)); #else wctomb(NULL, 0); #endif for (i = o = 0; i < ins_len; i++) { /* Reallocate memory if necessary or abort. */ if ((int)(o + MB_CUR_MAX) > mbs_len) { char *tc; if (mbs == *outs) { errno = ENAMETOOLONG; return -1; } tc = ntfs_malloc((mbs_len + 64) & ~63); if (!tc) goto err_out; memcpy(tc, mbs, mbs_len); mbs_len = (mbs_len + 64) & ~63; free(mbs); mbs = tc; } /* Convert the LE Unicode character to a CPU wide character. */ wc = (wchar_t)le16_to_cpu(ins[i]); if (!wc) break; /* Convert the CPU endian wide character to multibyte. */ #ifdef HAVE_MBSINIT cnt = wcrtomb(mbs + o, wc, &mbstate); #else cnt = wctomb(mbs + o, wc); #endif if (cnt == -1) goto err_out; if (cnt <= 0) { ntfs_log_debug("Eeek. cnt <= 0, cnt = %i\n", cnt); errno = EINVAL; goto err_out; } o += cnt; } #ifdef HAVE_MBSINIT /* Make sure we are back in the initial state. */ if (!mbsinit(&mbstate)) { ntfs_log_debug("Eeek. mbstate not in initial state!\n"); errno = EILSEQ; goto err_out; } #endif /* Now write the NULL character. */ mbs[o] = '\0'; if (*outs != mbs) *outs = mbs; return o; err_out: if (mbs != *outs) { int eo = errno; free(mbs); errno = eo; } #else /* MB_CUR_MAX */ errno = EILSEQ; #endif /* MB_CUR_MAX */ return -1; } /** * ntfs_mbstoucs - convert a multibyte string to a little endian Unicode string * @ins: input multibyte string buffer * @outs: on return contains the (allocated) output Unicode string * * Convert the input multibyte string @ins, from the current locale into the * corresponding little endian, 2-byte Unicode string. * * The function allocates the string and the caller is responsible for calling * free(*@outs); when finished with it. * * On success the function returns the number of Unicode characters written to * the output string *@outs (>= 0), not counting the terminating Unicode NULL * character. * * On error, -1 is returned, and errno is set to the error code. The following * error codes can be expected: * EINVAL Invalid arguments (e.g. @ins or @outs is NULL). * EILSEQ The input string cannot be represented as a Unicode * string according to the current locale. * ENAMETOOLONG Destination buffer is too small for input string. * ENOMEM Not enough memory to allocate destination buffer. */ int ntfs_mbstoucs(const char *ins, ntfschar **outs) { #ifdef MB_CUR_MAX ntfschar *ucs; const char *s; wchar_t wc; int i, o, cnt, ins_len, ucs_len, ins_size; #ifdef HAVE_MBSINIT mbstate_t mbstate; #endif #endif /* MB_CUR_MAX */ if (!ins || !outs) { errno = EINVAL; return -1; } if (use_utf8) return ntfs_utf8_to_utf16(ins, outs); #ifdef MB_CUR_MAX /* Determine the size of the multi-byte string in bytes. */ ins_size = strlen(ins); /* Determine the length of the multi-byte string. */ s = ins; #if defined(HAVE_MBSINIT) memset(&mbstate, 0, sizeof(mbstate)); ins_len = mbsrtowcs(NULL, (const char **)&s, 0, &mbstate); #ifdef __CYGWIN32__ if (!ins_len && *ins) { /* Older Cygwin had broken mbsrtowcs() implementation. */ ins_len = strlen(ins); } #endif #elif !defined(DJGPP) ins_len = mbstowcs(NULL, s, 0); #else /* Eeek!!! DJGPP has broken mbstowcs() implementation!!! */ ins_len = strlen(ins); #endif if (ins_len == -1) return ins_len; #ifdef HAVE_MBSINIT if ((s != ins) || !mbsinit(&mbstate)) { #else if (s != ins) { #endif errno = EILSEQ; return -1; } /* Add the NULL terminator. */ ins_len++; ucs_len = ins_len; ucs = ntfs_malloc(ucs_len * sizeof(ntfschar)); if (!ucs) return -1; #ifdef HAVE_MBSINIT memset(&mbstate, 0, sizeof(mbstate)); #else mbtowc(NULL, NULL, 0); #endif for (i = o = cnt = 0; i < ins_size; i += cnt, o++) { /* Reallocate memory if necessary. */ if (o >= ucs_len) { ntfschar *tc; ucs_len = (ucs_len * sizeof(ntfschar) + 64) & ~63; tc = realloc(ucs, ucs_len); if (!tc) goto err_out; ucs = tc; ucs_len /= sizeof(ntfschar); } /* Convert the multibyte character to a wide character. */ #ifdef HAVE_MBSINIT cnt = mbrtowc(&wc, ins + i, ins_size - i, &mbstate); #else cnt = mbtowc(&wc, ins + i, ins_size - i); #endif if (!cnt) break; if (cnt == -1) goto err_out; if (cnt < -1) { ntfs_log_trace("Eeek. cnt = %i\n", cnt); errno = EINVAL; goto err_out; } /* Make sure we are not overflowing the NTFS Unicode set. */ if ((unsigned long)wc >= (unsigned long)(1 << (8 * sizeof(ntfschar)))) { errno = EILSEQ; goto err_out; } /* Convert the CPU wide character to a LE Unicode character. */ ucs[o] = cpu_to_le16(wc); } #ifdef HAVE_MBSINIT /* Make sure we are back in the initial state. */ if (!mbsinit(&mbstate)) { ntfs_log_trace("Eeek. mbstate not in initial state!\n"); errno = EILSEQ; goto err_out; } #endif /* Now write the NULL character. */ ucs[o] = const_cpu_to_le16(L'\0'); *outs = ucs; return o; err_out: free(ucs); #else /* MB_CUR_MAX */ errno = EILSEQ; #endif /* MB_CUR_MAX */ return -1; } /* * Turn a UTF8 name uppercase * * Returns an allocated uppercase name which has to be freed by caller * or NULL if there is an error (described by errno) */ char *ntfs_uppercase_mbs(const char *low, const ntfschar *upcase, u32 upcase_size) { int size; char *upp; u32 wc; int n; const char *s; char *t; size = strlen(low); upp = (char*)ntfs_malloc(3*size + 1); if (upp) { s = low; t = upp; do { n = utf8_to_unicode(&wc, s); if (n > 0) { if (wc < upcase_size) wc = le16_to_cpu(upcase[wc]); if (wc < 0x80) *t++ = wc; else if (wc < 0x800) { *t++ = (0xc0 | ((wc >> 6) & 0x3f)); *t++ = 0x80 | (wc & 0x3f); } else if (wc < 0x10000) { *t++ = 0xe0 | (wc >> 12); *t++ = 0x80 | ((wc >> 6) & 0x3f); *t++ = 0x80 | (wc & 0x3f); } else { *t++ = 0xf0 | ((wc >> 18) & 7); *t++ = 0x80 | ((wc >> 12) & 63); *t++ = 0x80 | ((wc >> 6) & 0x3f); *t++ = 0x80 | (wc & 0x3f); } s += n; } } while (n > 0); if (n < 0) { free(upp); upp = (char*)NULL; errno = EILSEQ; } *t = 0; } return (upp); } /** * ntfs_upcase_table_build - build the default upcase table for NTFS * @uc: destination buffer where to store the built table * @uc_len: size of destination buffer in bytes * * ntfs_upcase_table_build() builds the default upcase table for NTFS and * stores it in the caller supplied buffer @uc of size @uc_len. * * Note, @uc_len must be at least 128kiB in size or bad things will happen! */ void ntfs_upcase_table_build(ntfschar *uc, u32 uc_len) { struct NEWUPPERCASE { unsigned short first; unsigned short last; short diff; unsigned char step; unsigned char osmajor; unsigned char osminor; } ; /* * This is the table as defined by Windows XP */ static int uc_run_table[][3] = { /* Start, End, Add */ {0x0061, 0x007B, -32}, {0x0451, 0x045D, -80}, {0x1F70, 0x1F72, 74}, {0x00E0, 0x00F7, -32}, {0x045E, 0x0460, -80}, {0x1F72, 0x1F76, 86}, {0x00F8, 0x00FF, -32}, {0x0561, 0x0587, -48}, {0x1F76, 0x1F78, 100}, {0x0256, 0x0258, -205}, {0x1F00, 0x1F08, 8}, {0x1F78, 0x1F7A, 128}, {0x028A, 0x028C, -217}, {0x1F10, 0x1F16, 8}, {0x1F7A, 0x1F7C, 112}, {0x03AC, 0x03AD, -38}, {0x1F20, 0x1F28, 8}, {0x1F7C, 0x1F7E, 126}, {0x03AD, 0x03B0, -37}, {0x1F30, 0x1F38, 8}, {0x1FB0, 0x1FB2, 8}, {0x03B1, 0x03C2, -32}, {0x1F40, 0x1F46, 8}, {0x1FD0, 0x1FD2, 8}, {0x03C2, 0x03C3, -31}, {0x1F51, 0x1F52, 8}, {0x1FE0, 0x1FE2, 8}, {0x03C3, 0x03CC, -32}, {0x1F53, 0x1F54, 8}, {0x1FE5, 0x1FE6, 7}, {0x03CC, 0x03CD, -64}, {0x1F55, 0x1F56, 8}, {0x2170, 0x2180, -16}, {0x03CD, 0x03CF, -63}, {0x1F57, 0x1F58, 8}, {0x24D0, 0x24EA, -26}, {0x0430, 0x0450, -32}, {0x1F60, 0x1F68, 8}, {0xFF41, 0xFF5B, -32}, {0} }; static int uc_dup_table[][2] = { /* Start, End */ {0x0100, 0x012F}, {0x01A0, 0x01A6}, {0x03E2, 0x03EF}, {0x04CB, 0x04CC}, {0x0132, 0x0137}, {0x01B3, 0x01B7}, {0x0460, 0x0481}, {0x04D0, 0x04EB}, {0x0139, 0x0149}, {0x01CD, 0x01DD}, {0x0490, 0x04BF}, {0x04EE, 0x04F5}, {0x014A, 0x0178}, {0x01DE, 0x01EF}, {0x04BF, 0x04BF}, {0x04F8, 0x04F9}, {0x0179, 0x017E}, {0x01F4, 0x01F5}, {0x04C1, 0x04C4}, {0x1E00, 0x1E95}, {0x018B, 0x018B}, {0x01FA, 0x0218}, {0x04C7, 0x04C8}, {0x1EA0, 0x1EF9}, {0} }; static int uc_byte_table[][2] = { /* Offset, Value */ {0x00FF, 0x0178}, {0x01AD, 0x01AC}, {0x01F3, 0x01F1}, {0x0269, 0x0196}, {0x0183, 0x0182}, {0x01B0, 0x01AF}, {0x0253, 0x0181}, {0x026F, 0x019C}, {0x0185, 0x0184}, {0x01B9, 0x01B8}, {0x0254, 0x0186}, {0x0272, 0x019D}, {0x0188, 0x0187}, {0x01BD, 0x01BC}, {0x0259, 0x018F}, {0x0275, 0x019F}, {0x018C, 0x018B}, {0x01C6, 0x01C4}, {0x025B, 0x0190}, {0x0283, 0x01A9}, {0x0192, 0x0191}, {0x01C9, 0x01C7}, {0x0260, 0x0193}, {0x0288, 0x01AE}, {0x0199, 0x0198}, {0x01CC, 0x01CA}, {0x0263, 0x0194}, {0x0292, 0x01B7}, {0x01A8, 0x01A7}, {0x01DD, 0x018E}, {0x0268, 0x0197}, {0} }; /* * Changes which were applied to later Windows versions * * md5 for $UpCase from Winxp : 6fa3db2468275286210751e869d36373 * Vista : 2f03b5a69d486ff3864cecbd07f24440 * Win8 : 7ff498a44e45e77374cc7c962b1b92f2 */ static const struct NEWUPPERCASE newuppercase[] = { /* from Windows 6.0 (Vista) */ { 0x37b, 0x37d, 0x82, 1, 6, 0 }, { 0x1f80, 0x1f87, 0x8, 1, 6, 0 }, { 0x1f90, 0x1f97, 0x8, 1, 6, 0 }, { 0x1fa0, 0x1fa7, 0x8, 1, 6, 0 }, { 0x2c30, 0x2c5e, -0x30, 1, 6, 0 }, { 0x2d00, 0x2d25, -0x1c60, 1, 6, 0 }, { 0x2c68, 0x2c6c, -0x1, 2, 6, 0 }, { 0x219, 0x21f, -0x1, 2, 6, 0 }, { 0x223, 0x233, -0x1, 2, 6, 0 }, { 0x247, 0x24f, -0x1, 2, 6, 0 }, { 0x3d9, 0x3e1, -0x1, 2, 6, 0 }, { 0x48b, 0x48f, -0x1, 2, 6, 0 }, { 0x4fb, 0x513, -0x1, 2, 6, 0 }, { 0x2c81, 0x2ce3, -0x1, 2, 6, 0 }, { 0x3f8, 0x3fb, -0x1, 3, 6, 0 }, { 0x4c6, 0x4ce, -0x1, 4, 6, 0 }, { 0x23c, 0x242, -0x1, 6, 6, 0 }, { 0x4ed, 0x4f7, -0x1, 10, 6, 0 }, { 0x450, 0x45d, -0x50, 13, 6, 0 }, { 0x2c61, 0x2c76, -0x1, 21, 6, 0 }, { 0x1fcc, 0x1ffc, -0x9, 48, 6, 0 }, { 0x180, 0x180, 0xc3, 1, 6, 0 }, { 0x195, 0x195, 0x61, 1, 6, 0 }, { 0x19a, 0x19a, 0xa3, 1, 6, 0 }, { 0x19e, 0x19e, 0x82, 1, 6, 0 }, { 0x1bf, 0x1bf, 0x38, 1, 6, 0 }, { 0x1f9, 0x1f9, -0x1, 1, 6, 0 }, { 0x23a, 0x23a, 0x2a2b, 1, 6, 0 }, { 0x23e, 0x23e, 0x2a28, 1, 6, 0 }, { 0x26b, 0x26b, 0x29f7, 1, 6, 0 }, { 0x27d, 0x27d, 0x29e7, 1, 6, 0 }, { 0x280, 0x280, -0xda, 1, 6, 0 }, { 0x289, 0x289, -0x45, 1, 6, 0 }, { 0x28c, 0x28c, -0x47, 1, 6, 0 }, { 0x3f2, 0x3f2, 0x7, 1, 6, 0 }, { 0x4cf, 0x4cf, -0xf, 1, 6, 0 }, { 0x1d7d, 0x1d7d, 0xee6, 1, 6, 0 }, { 0x1fb3, 0x1fb3, 0x9, 1, 6, 0 }, { 0x214e, 0x214e, -0x1c, 1, 6, 0 }, { 0x2184, 0x2184, -0x1, 1, 6, 0 }, /* from Windows 6.1 (Win7) */ { 0x23a, 0x23e, 0x0, 4, 6, 1 }, { 0x250, 0x250, 0x2a1f, 2, 6, 1 }, { 0x251, 0x251, 0x2a1c, 2, 6, 1 }, { 0x271, 0x271, 0x29fd, 2, 6, 1 }, { 0x371, 0x373, -0x1, 2, 6, 1 }, { 0x377, 0x377, -0x1, 2, 6, 1 }, { 0x3c2, 0x3c2, 0x0, 2, 6, 1 }, { 0x3d7, 0x3d7, -0x8, 2, 6, 1 }, { 0x515, 0x523, -0x1, 2, 6, 1 }, /* below, -0x75fc stands for 0x8a04 and truncation */ { 0x1d79, 0x1d79, -0x75fc, 2, 6, 1 }, { 0x1efb, 0x1eff, -0x1, 2, 6, 1 }, { 0x1fc3, 0x1ff3, 0x9, 48, 6, 1 }, { 0x1fcc, 0x1ffc, 0x0, 48, 6, 1 }, { 0x2c65, 0x2c65, -0x2a2b, 2, 6, 1 }, { 0x2c66, 0x2c66, -0x2a28, 2, 6, 1 }, { 0x2c73, 0x2c73, -0x1, 2, 6, 1 }, { 0xa641, 0xa65f, -0x1, 2, 6, 1 }, { 0xa663, 0xa66d, -0x1, 2, 6, 1 }, { 0xa681, 0xa697, -0x1, 2, 6, 1 }, { 0xa723, 0xa72f, -0x1, 2, 6, 1 }, { 0xa733, 0xa76f, -0x1, 2, 6, 1 }, { 0xa77a, 0xa77c, -0x1, 2, 6, 1 }, { 0xa77f, 0xa787, -0x1, 2, 6, 1 }, { 0xa78c, 0xa78c, -0x1, 2, 6, 1 }, /* end mark */ { 0 } } ; int i, r; int k, off; const struct NEWUPPERCASE *puc; memset((char*)uc, 0, uc_len); uc_len >>= 1; if (uc_len > 65536) uc_len = 65536; for (i = 0; (u32)i < uc_len; i++) uc[i] = cpu_to_le16(i); for (r = 0; uc_run_table[r][0]; r++) { off = uc_run_table[r][2]; for (i = uc_run_table[r][0]; i < uc_run_table[r][1]; i++) uc[i] = cpu_to_le16(i + off); } for (r = 0; uc_dup_table[r][0]; r++) for (i = uc_dup_table[r][0]; i < uc_dup_table[r][1]; i += 2) uc[i + 1] = cpu_to_le16(i); for (r = 0; uc_byte_table[r][0]; r++) { k = uc_byte_table[r][1]; uc[uc_byte_table[r][0]] = cpu_to_le16(k); } for (r=0; newuppercase[r].first; r++) { puc = &newuppercase[r]; if ((puc->osmajor < UPCASE_MAJOR) || ((puc->osmajor == UPCASE_MAJOR) && (puc->osminor <= UPCASE_MINOR))) { off = puc->diff; for (i = puc->first; i <= puc->last; i += puc->step) uc[i] = cpu_to_le16(i + off); } } } /* * Allocate and build the default upcase table * * Returns the number of entries * 0 if failed */ #define UPCASE_LEN 65536 /* default number of entries in upcase */ u32 ntfs_upcase_build_default(ntfschar **upcase) { u32 upcase_len = 0; *upcase = (ntfschar*)ntfs_malloc(UPCASE_LEN*2); if (*upcase) { ntfs_upcase_table_build(*upcase, UPCASE_LEN*2); upcase_len = UPCASE_LEN; } return (upcase_len); } /* * Build a table for converting to lower case * * This is only meaningful when there is a single lower case * character leading to an upper case one, and currently the * only exception is the greek letter sigma which has a single * upper case glyph (code U+03A3), but two lower case glyphs * (code U+03C3 and U+03C2, the latter to be used at the end * of a word). In the following implementation the upper case * sigma will be lowercased as U+03C3. */ ntfschar *ntfs_locase_table_build(const ntfschar *uc, u32 uc_cnt) { ntfschar *lc; u32 upp; u32 i; lc = (ntfschar*)ntfs_malloc(uc_cnt*sizeof(ntfschar)); if (lc) { for (i=0; i NTFS_MAX_NAME_LEN) { free(ucs); errno = ENAMETOOLONG; return NULL; } if (!ucs || !*len) { if (ucs) free(ucs); ucs = AT_UNNAMED; *len = 0; } return ucs; } /** * ntfs_ucsfree - free memory allocated by ntfs_str2ucs() * @ucs input string to be freed * * Free memory at @ucs and which was allocated by ntfs_str2ucs. * * Return value: none. */ void ntfs_ucsfree(ntfschar *ucs) { if (ucs && (ucs != AT_UNNAMED)) free(ucs); } /* * Check whether a name contains no chars forbidden * for DOS or Win32 use * * If @strict is TRUE, then trailing dots and spaces are forbidden. * These names are technically allowed in the Win32 namespace, but * they can be problematic. See comment for FILE_NAME_WIN32. * * If there is a bad char, errno is set to EINVAL */ BOOL ntfs_forbidden_chars(const ntfschar *name, int len, BOOL strict) { BOOL forbidden; int ch; int i; static const u32 mainset = (1L << ('\"' - 0x20)) | (1L << ('*' - 0x20)) | (1L << ('/' - 0x20)) | (1L << (':' - 0x20)) | (1L << ('<' - 0x20)) | (1L << ('>' - 0x20)) | (1L << ('?' - 0x20)); forbidden = (len == 0) || (strict && (name[len-1] == const_cpu_to_le16(' ') || name[len-1] == const_cpu_to_le16('.'))); for (i=0; i= 3)) { /* * Rough hash check to tell whether the first couple of chars * may be one of CO PR AU NU LP or lowercase variants. */ h = ((le16_to_cpu(name[0]) & 31)*48) ^ ((le16_to_cpu(name[1]) & 31)*165); if ((h % 23) == 17) { /* do a full check, depending on the third char */ switch (le16_to_cpu(name[2]) & ~0x20) { case 'N' : if (((len == 3) || (name[3] == dot)) && (!ntfs_ucsncasecmp(name, con, 3, vol->upcase, vol->upcase_len) || !ntfs_ucsncasecmp(name, prn, 3, vol->upcase, vol->upcase_len))) forbidden = TRUE; break; case 'X' : if (((len == 3) || (name[3] == dot)) && !ntfs_ucsncasecmp(name, aux, 3, vol->upcase, vol->upcase_len)) forbidden = TRUE; break; case 'L' : if (((len == 3) || (name[3] == dot)) && !ntfs_ucsncasecmp(name, nul, 3, vol->upcase, vol->upcase_len)) forbidden = TRUE; break; case 'M' : if ((len > 3) && (le16_to_cpu(name[3]) >= '1') && (le16_to_cpu(name[3]) <= '9') && ((len == 4) || (name[4] == dot)) && !ntfs_ucsncasecmp(name, com, 3, vol->upcase, vol->upcase_len)) forbidden = TRUE; break; case 'T' : if ((len > 3) && (le16_to_cpu(name[3]) >= '1') && (le16_to_cpu(name[3]) <= '9') && ((len == 4) || (name[4] == dot)) && !ntfs_ucsncasecmp(name, lpt, 3, vol->upcase, vol->upcase_len)) forbidden = TRUE; break; } } } if (forbidden) errno = EINVAL; return (forbidden); } /* * Check whether the same name can be used as a DOS and * a Win32 name * * The names must be the same, or the short name the uppercase * variant of the long name */ BOOL ntfs_collapsible_chars(ntfs_volume *vol, const ntfschar *shortname, int shortlen, const ntfschar *longname, int longlen) { BOOL collapsible; unsigned int ch; unsigned int cs; int i; collapsible = shortlen == longlen; for (i=0; collapsible && (i= vol->upcase_len) || (cs >= vol->upcase_len) || (vol->upcase[cs] != vol->upcase[ch]))) collapsible = FALSE; } return (collapsible); } /* * Define the character encoding to be used. * Use UTF-8 unless specified otherwise. */ int ntfs_set_char_encoding(const char *locale) { use_utf8 = 0; if (!locale || strstr(locale,"utf8") || strstr(locale,"UTF8") || strstr(locale,"utf-8") || strstr(locale,"UTF-8")) use_utf8 = 1; else if (setlocale(LC_ALL, locale)) use_utf8 = 0; else { ntfs_log_error("Invalid locale, encoding to UTF-8\n"); use_utf8 = 1; } return 0; /* always successful */ } #if defined(__APPLE__) || defined(__DARWIN__) int ntfs_macosx_normalize_filenames(int normalize) { #ifdef ENABLE_NFCONV if (normalize == 0 || normalize == 1) { nfconvert_utf8 = normalize; return 0; } else { return -1; } #else return -1; #endif /* ENABLE_NFCONV */ } int ntfs_macosx_normalize_utf8(const char *utf8_string, char **target, int composed) { #ifdef ENABLE_NFCONV /* For this code to compile, the CoreFoundation framework must be fed to * the linker. */ CFStringRef cfSourceString; CFMutableStringRef cfMutableString; CFRange rangeToProcess; CFIndex requiredBufferLength; char *result = NULL; int resultLength = -1; /* Convert the UTF-8 string to a CFString. */ cfSourceString = CFStringCreateWithCString(kCFAllocatorDefault, utf8_string, kCFStringEncodingUTF8); if (cfSourceString == NULL) { ntfs_log_error("CFStringCreateWithCString failed!\n"); return -2; } /* Create a mutable string from cfSourceString that we are free to * modify. */ cfMutableString = CFStringCreateMutableCopy(kCFAllocatorDefault, 0, cfSourceString); CFRelease(cfSourceString); /* End-of-life. */ if (cfMutableString == NULL) { ntfs_log_error("CFStringCreateMutableCopy failed!\n"); return -3; } /* Normalize the mutable string to the desired normalization form. */ CFStringNormalize(cfMutableString, (composed != 0 ? kCFStringNormalizationFormC : kCFStringNormalizationFormD)); /* Store the resulting string in a '\0'-terminated UTF-8 encoded char* * buffer. */ rangeToProcess = CFRangeMake(0, CFStringGetLength(cfMutableString)); if (CFStringGetBytes(cfMutableString, rangeToProcess, kCFStringEncodingUTF8, 0, false, NULL, 0, &requiredBufferLength) > 0) { resultLength = sizeof(char) * (requiredBufferLength + 1); result = ntfs_calloc(resultLength); if (result != NULL) { if (CFStringGetBytes(cfMutableString, rangeToProcess, kCFStringEncodingUTF8, 0, false, (UInt8*) result, resultLength - 1, &requiredBufferLength) <= 0) { ntfs_log_error("Could not perform UTF-8 " "conversion of normalized " "CFMutableString.\n"); free(result); result = NULL; } } else { ntfs_log_error("Could not perform a ntfs_calloc of %d " "bytes for char *result.\n", resultLength); } } else { ntfs_log_error("Could not perform check for required length of " "UTF-8 conversion of normalized CFMutableString.\n"); } CFRelease(cfMutableString); if (result != NULL) { *target = result; return resultLength - 1; } else { return -1; } #else return -1; #endif /* ENABLE_NFCONV */ } #endif /* defined(__APPLE__) || defined(__DARWIN__) */ ntfsprogs-plus-1.0.0/libntfs/unix_io.c000066400000000000000000000220411507404161300177750ustar00rootroot00000000000000/** * unix_io.c - Unix style disk io functions. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2006 Anton Altaparmakov * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_SYS_IOCTL_H #include #endif #ifdef HAVE_LINUX_FD_H #include #endif #ifdef HAVE_LINUX_FS_H #include #endif #include "types.h" #include "mst.h" #include "debug.h" #include "device.h" #include "logging.h" #include "misc.h" #define DEV_FD(dev) (*(int *)dev->d_private) /* Define to nothing if not present on this system. */ #ifndef O_EXCL # define O_EXCL 0 #endif /** * fsync replacement which makes every effort to try to get the data down to * disk, using different means for different operating systems. Specifically, * it issues the proper fcntl for Mac OS X or does fsync where it is available * or as a last resort calls the fsync function. Information on this problem * was retrieved from: * http://mirror.linux.org.au/pub/linux.conf.au/2007/video/talks/278.pdf */ static int ntfs_fsync(int fildes) { int ret = -1; #if defined(__APPLE__) || defined(__DARWIN__) # ifndef F_FULLFSYNC # error "Mac OS X: F_FULLFSYNC is not defined. Either you didn't include fcntl.h or you're using an older, unsupported version of Mac OS X (pre-10.3)." # endif /* * Apple has disabled fsync() for internal disk drives in OS X. * To force a synchronization of disk contents, we use a Mac OS X * specific fcntl, F_FULLFSYNC. */ ret = fcntl(fildes, F_FULLFSYNC, NULL); if (ret) { /* * If we are not on a file system that supports this, * then fall back to a plain fsync. */ ret = fsync(fildes); } #else ret = fsync(fildes); #endif return ret; } /** * ntfs_device_unix_io_open - Open a device and lock it exclusively * @dev: * @flags: * * Description... * * Returns: */ static int ntfs_device_unix_io_open(struct ntfs_device *dev, int flags) { struct flock flk; struct stat sbuf; int err; if (NDevOpen(dev)) { errno = EBUSY; return -1; } if (stat(dev->d_name, &sbuf)) { ntfs_log_perror("Failed to access '%s'", dev->d_name); return -1; } if (S_ISBLK(sbuf.st_mode)) NDevSetBlock(dev); dev->d_private = ntfs_malloc(sizeof(int)); if (!dev->d_private) return -1; /* * Open file for exclusive access if mounting r/w. * Fuseblk takes care about block devices. */ if (!NDevBlock(dev) && (flags & O_RDWR) == O_RDWR) flags |= O_EXCL; *(int*)dev->d_private = open(dev->d_name, flags); if (*(int*)dev->d_private == -1) { err = errno; /* if permission error and rw, retry read-only */ if ((err == EACCES) && ((flags & O_RDWR) == O_RDWR)) err = EROFS; if ((err == ENODEV) || (err == ENXIO)) { ntfs_log_perror("Failed open device %s", dev->d_name); exit(8); } goto err_out; } #ifdef HAVE_LINUX_FS_H /* Check whether the device was forced read-only */ if (NDevBlock(dev) && ((flags & O_RDWR) == O_RDWR)) { int r; int state; r = ioctl(DEV_FD(dev), BLKROGET, &state); if (!r && state) { err = EROFS; if (close(DEV_FD(dev))) err = errno; goto err_out; } } #endif if ((flags & O_RDWR) != O_RDWR) NDevSetReadOnly(dev); memset(&flk, 0, sizeof(flk)); if (NDevReadOnly(dev)) flk.l_type = F_RDLCK; else flk.l_type = F_WRLCK; flk.l_whence = SEEK_SET; flk.l_start = flk.l_len = 0LL; if (fcntl(DEV_FD(dev), F_SETLK, &flk)) { err = errno; ntfs_log_perror("Failed to %s lock '%s'", NDevReadOnly(dev) ? "read" : "write", dev->d_name); if (close(DEV_FD(dev))) ntfs_log_perror("Failed to close '%s'", dev->d_name); goto err_out; } NDevSetOpen(dev); return 0; err_out: free(dev->d_private); dev->d_private = NULL; errno = err; return -1; } /** * ntfs_device_unix_io_close - Close the device, releasing the lock * @dev: * * Description... * * Returns: */ static int ntfs_device_unix_io_close(struct ntfs_device *dev) { struct flock flk; if (!NDevOpen(dev)) { errno = EBADF; ntfs_log_perror("Device %s is not open", dev->d_name); return -1; } if (NDevDirty(dev)) if (ntfs_fsync(DEV_FD(dev))) { ntfs_log_perror("Failed to fsync device %s", dev->d_name); return -1; } memset(&flk, 0, sizeof(flk)); flk.l_type = F_UNLCK; flk.l_whence = SEEK_SET; flk.l_start = flk.l_len = 0LL; if (fcntl(DEV_FD(dev), F_SETLK, &flk)) ntfs_log_perror("Could not unlock %s", dev->d_name); if (close(DEV_FD(dev))) { ntfs_log_perror("Failed to close device %s", dev->d_name); exit(8); } NDevClearOpen(dev); free(dev->d_private); dev->d_private = NULL; return 0; } /** * ntfs_device_unix_io_seek - Seek to a place on the device * @dev: * @offset: * @whence: * * Description... * * Returns: */ static s64 ntfs_device_unix_io_seek(struct ntfs_device *dev, s64 offset, int whence) { return lseek(DEV_FD(dev), offset, whence); } /** * ntfs_device_unix_io_read - Read from the device, from the current location * @dev: * @buf: * @count: * * Description... * * Returns: */ static s64 ntfs_device_unix_io_read(struct ntfs_device *dev, void *buf, s64 count) { s64 cnt; if ((cnt = read(DEV_FD(dev), buf, count)) < 0) { ntfs_log_perror("Failed to read device %s", dev->d_name); exit(8); } return cnt; } /** * ntfs_device_unix_io_write - Write to the device, at the current location * @dev: * @buf: * @count: * * Description... * * Returns: */ static s64 ntfs_device_unix_io_write(struct ntfs_device *dev, const void *buf, s64 count) { s64 cnt; if (NDevReadOnly(dev)) { errno = EROFS; return -1; } NDevSetDirty(dev); if ((cnt = write(DEV_FD(dev), buf, count)) < 0) { ntfs_log_perror("Failed to write device %s", dev->d_name); exit(8); } return cnt; } /** * ntfs_device_unix_io_pread - Perform a positioned read from the device * @dev: * @buf: * @count: * @offset: * * Description... * * Returns: */ static s64 ntfs_device_unix_io_pread(struct ntfs_device *dev, void *buf, s64 count, s64 offset) { s64 cnt; if ((cnt = pread(DEV_FD(dev), buf, count, offset)) < 0) { ntfs_log_perror("Failed to pread device %s", dev->d_name); exit(8); } return cnt; } /** * ntfs_device_unix_io_pwrite - Perform a positioned write to the device * @dev: * @buf: * @count: * @offset: * * Description... * * Returns: */ static s64 ntfs_device_unix_io_pwrite(struct ntfs_device *dev, const void *buf, s64 count, s64 offset) { s64 cnt; if (NDevReadOnly(dev)) { errno = EROFS; return -1; } NDevSetDirty(dev); if ((cnt = pwrite(DEV_FD(dev), buf, count, offset)) < 0) { ntfs_log_perror("Failed to pwrite device %s", dev->d_name); exit(8); } return cnt; } /** * ntfs_device_unix_io_sync - Flush any buffered changes to the device * @dev: * * Description... * * Returns: */ static int ntfs_device_unix_io_sync(struct ntfs_device *dev) { int res = 0; if (!NDevReadOnly(dev)) { res = ntfs_fsync(DEV_FD(dev)); if (res) ntfs_log_perror("Failed to sync device %s", dev->d_name); else NDevClearDirty(dev); } return res; } /** * ntfs_device_unix_io_stat - Get information about the device * @dev: * @buf: * * Description... * * Returns: */ static int ntfs_device_unix_io_stat(struct ntfs_device *dev, struct stat *buf) { return fstat(DEV_FD(dev), buf); } /** * ntfs_device_unix_io_ioctl - Perform an ioctl on the device * @dev: * @request: * @argp: * * Description... * * Returns: */ static int ntfs_device_unix_io_ioctl(struct ntfs_device *dev, unsigned long request, void *argp) { return ioctl(DEV_FD(dev), request, argp); } /** * Device operations for working with unix style devices and files. */ struct ntfs_device_operations ntfs_device_unix_io_ops = { .open = ntfs_device_unix_io_open, .close = ntfs_device_unix_io_close, .seek = ntfs_device_unix_io_seek, .read = ntfs_device_unix_io_read, .write = ntfs_device_unix_io_write, .pread = ntfs_device_unix_io_pread, .pwrite = ntfs_device_unix_io_pwrite, .sync = ntfs_device_unix_io_sync, .stat = ntfs_device_unix_io_stat, .ioctl = ntfs_device_unix_io_ioctl, }; ntfsprogs-plus-1.0.0/libntfs/volume.c000066400000000000000000001732341507404161300176450ustar00rootroot00000000000000/** * volume.c - NTFS volume handling code. Originated from the Linux-NTFS project. * * Copyright (c) 2000-2006 Anton Altaparmakov * Copyright (c) 2002-2009 Szabolcs Szakacsits * Copyright (c) 2004-2005 Richard Russon * Copyright (c) 2010 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #ifdef HAVE_LOCALE_H #include #endif #if defined(__sun) && defined (__SVR4) #include #endif #include "param.h" #include "compat.h" #include "volume.h" #include "attrib.h" #include "mft.h" #include "bootsect.h" #include "device.h" #include "debug.h" #include "inode.h" #include "runlist.h" #include "logfile.h" #include "dir.h" #include "logging.h" #include "cache.h" #include "realpath.h" #include "misc.h" #include "security.h" #include "problem.h" const char *ntfs_home = "News, support and information: https://github.com/tuxera/ntfs-3g/\n"; static const char *invalid_ntfs_msg = "The device '%s' doesn't seem to have a valid NTFS.\n" "Maybe the wrong device is used? Or the whole disk instead of a\n" "partition (e.g. /dev/sda, not /dev/sda1)? Or the other way around?\n"; static const char *corrupt_volume_msg = "NTFS is either inconsistent, or there is a hardware fault, or it's a\n" "SoftRAID/FakeRAID hardware. In the first case run chkdsk /f on Windows\n" "then reboot into Windows twice. The usage of the /f parameter is very\n" "important! If the device is a SoftRAID/FakeRAID then first activate\n" "it and mount a different device under the /dev/mapper/ directory, (e.g.\n" "/dev/mapper/nvidia_eahaabcc1). Please see the 'dmraid' documentation\n" "for more details.\n"; static const char *hibernated_volume_msg = "The NTFS partition is in an unsafe state. Please resume and shutdown\n" "Windows fully (no hibernation or fast restarting), or mount the volume\n" "read-only with the 'ro' mount option.\n"; static const char *fallback_readonly_msg = "Falling back to read-only mount because the NTFS partition is in an\n" "unsafe state. Please resume and shutdown Windows fully (no hibernation\n" "or fast restarting.)\n"; static const char *unclean_journal_msg = "Write access is denied because the disk wasn't safely powered\n" "off and the 'norecover' mount option was specified.\n"; static const char *opened_volume_msg = "Mount is denied because the NTFS volume is already exclusively opened.\n" "The volume may be already mounted, or another software may use it which\n" "could be identified for example by the help of the 'fuser' command.\n"; static const char *fakeraid_msg = "Either the device is missing or it's powered down, or you have\n" "SoftRAID hardware and must use an activated, different device under\n" "/dev/mapper/, (e.g. /dev/mapper/nvidia_eahaabcc1) to mount NTFS.\n" "Please see the 'dmraid' documentation for help.\n"; static const char *access_denied_msg = "Please check '%s' and the ntfs-3g binary permissions,\n" "and the mounting user ID. More explanation is provided at\n" "https://github.com/tuxera/ntfs-3g/wiki/NTFS-3G-FAQ\n"; int fsck_errors; int fsck_fixes; int parse_errors; /** * ntfs_volume_alloc - Create an NTFS volume object and initialise it * * Description... * * Returns: */ ntfs_volume *ntfs_volume_alloc(void) { return ntfs_calloc(sizeof(ntfs_volume)); } static void ntfs_attr_free(ntfs_attr **na) { if (na && *na) { ntfs_attr_close(*na); *na = NULL; } } static int ntfs_inode_free(ntfs_inode **ni) { int ret = -1; if (ni && *ni) { ret = ntfs_inode_close(*ni); *ni = NULL; } return ret; } static void ntfs_error_set(int *err) { if (!*err) *err = errno; } /** * __ntfs_volume_release - Destroy an NTFS volume object * @v: * * Description... * * Returns: */ static int __ntfs_volume_release(ntfs_volume *v) { int err = 0; if (ntfs_close_secure(v)) ntfs_error_set(&err); if (ntfs_inode_free(&v->vol_ni)) ntfs_error_set(&err); /* * FIXME: Inodes must be synced before closing * attributes, otherwise unmount could fail. */ if (v->lcnbmp_ni && NInoDirty(v->lcnbmp_ni)) ntfs_inode_sync(v->lcnbmp_ni); ntfs_attr_free(&v->lcnbmp_na); if (ntfs_inode_free(&v->lcnbmp_ni)) ntfs_error_set(&err); if (v->mft_ni && NInoDirty(v->mft_ni)) ntfs_inode_sync(v->mft_ni); ntfs_attr_free(&v->mftbmp_na); ntfs_attr_free(&v->mft_na); if (ntfs_inode_free(&v->mft_ni)) ntfs_error_set(&err); if (v->mftmirr_ni && NInoDirty(v->mftmirr_ni)) ntfs_inode_sync(v->mftmirr_ni); ntfs_attr_free(&v->mftmirr_na); if (ntfs_inode_free(&v->mftmirr_ni)) ntfs_error_set(&err); if (v->dev) { struct ntfs_device *dev = v->dev; if (dev->d_ops->sync(dev)) ntfs_error_set(&err); if (dev->d_ops->close(dev)) ntfs_error_set(&err); } ntfs_free_lru_caches(v); free(v->vol_name); free(v->upcase); if (v->locase) free(v->locase); free(v->attrdef); free(v); errno = err; return errno ? -1 : 0; } static int ntfs_attr_setup_flag(ntfs_inode *ni) { STANDARD_INFORMATION *si; s64 lth; int r; si = (STANDARD_INFORMATION*)ntfs_attr_readall(ni, AT_STANDARD_INFORMATION, AT_UNNAMED, 0, <h); if (si) { if ((u64)lth >= offsetof(STANDARD_INFORMATION, owner_id)) ni->flags = si->file_attributes; free(si); r = 0; } else { ntfs_log_error("Failed to get standard information of $MFT\n"); r = -1; } return (r); } /** * ntfs_mft_load - load the $MFT and setup the ntfs volume with it * @vol: ntfs volume whose $MFT to load * * Load $MFT from @vol and setup @vol with it. After calling this function the * volume @vol is ready for use by all read access functions provided by the * ntfs library. * * Return 0 on success and -1 on error with errno set to the error code. */ static int ntfs_mft_load(ntfs_volume *vol) { VCN next_vcn, last_vcn, highest_vcn; s64 l; MFT_RECORD *mb = NULL; ntfs_attr_search_ctx *ctx = NULL; ATTR_RECORD *a; int eo; char *filename; FILE_NAME_ATTR *fn; /* Manually setup an ntfs_inode. */ vol->mft_ni = ntfs_inode_allocate(vol); mb = ntfs_malloc(vol->mft_record_size); if (!vol->mft_ni || !mb) { ntfs_log_perror("Error allocating memory for $MFT"); goto error_exit; } vol->mft_ni->mft_no = FILE_MFT; vol->mft_ni->mrec = mb; /* Can't use any of the higher level functions yet! */ l = ntfs_mst_pread(vol->dev, vol->mft_lcn << vol->cluster_size_bits, 1, vol->mft_record_size, mb); if (l != 1) { if (l != -1) errno = EIO; ntfs_log_perror("Error reading $MFT"); goto error_exit; } if (ntfs_mft_record_check(vol, 0, mb)) goto error_exit; if (mb->flags != MFT_RECORD_IN_USE) { errno = ENOENT; goto error_exit; } ctx = ntfs_attr_get_search_ctx(vol->mft_ni, NULL); if (!ctx) goto error_exit; /* Check if there is $SI attribute in $MFT. */ if (ntfs_attr_lookup(AT_STANDARD_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("No STANDARD_INFORMATION in $MFT record\n"); goto error_exit; } if (le32_to_cpu(ctx->attr->value_length) < offsetof(STANDARD_INFORMATION, owner_id)) { ntfs_log_error("Corrupt STANDARD_INFORMATION in $MFT record\n"); goto error_exit; } /* Find the $ATTRIBUTE_LIST attribute in $MFT if present. */ if (ntfs_attr_lookup(AT_ATTRIBUTE_LIST, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { if (errno != ENOENT) { ntfs_log_error("$MFT has corrupt attribute list.\n"); goto io_error_exit; } goto mft_has_no_attr_list; } NInoSetAttrList(vol->mft_ni); l = ntfs_get_attribute_value_length(ctx->attr); if (l <= 0 || l > 0x40000) { ntfs_log_error("$MFT/$ATTR_LIST invalid length (%lld).\n", (long long)l); goto io_error_exit; } vol->mft_ni->attr_list_size = l; vol->mft_ni->attr_list = ntfs_malloc(l); if (!vol->mft_ni->attr_list) goto error_exit; l = ntfs_get_attribute_value(vol, ctx->attr, vol->mft_ni->attr_list); if (!l) { ntfs_log_error("Failed to get value of $MFT/$ATTR_LIST.\n"); goto io_error_exit; } if ((l != vol->mft_ni->attr_list_size) || (l < (s64)offsetof(ATTR_LIST_ENTRY, name))) { ntfs_log_error("Partial read of $MFT/$ATTR_LIST (%lld != " "%u or < %d).\n", (long long)l, vol->mft_ni->attr_list_size, (int)offsetof(ATTR_LIST_ENTRY, name)); goto io_error_exit; } mft_has_no_attr_list: if (ntfs_attr_setup_flag(vol->mft_ni)) goto error_exit; /* We now have a fully setup ntfs inode for $MFT in vol->mft_ni. */ /* Get an ntfs attribute for $MFT/$DATA and set it up, too. */ vol->mft_na = ntfs_attr_open(vol->mft_ni, AT_DATA, AT_UNNAMED, 0); if (!vol->mft_na) { ntfs_log_perror("Failed to open ntfs attribute"); goto error_exit; } /* Read all extents from the $DATA attribute in $MFT. */ ntfs_attr_reinit_search_ctx(ctx); last_vcn = vol->mft_na->allocated_size >> vol->cluster_size_bits; highest_vcn = next_vcn = 0; a = NULL; while (!ntfs_attr_lookup(AT_DATA, AT_UNNAMED, 0, 0, next_vcn, NULL, 0, ctx)) { runlist_element *nrl; a = ctx->attr; /* $MFT must be non-resident. */ if (!a->non_resident) { ntfs_log_error("$MFT must be non-resident.\n"); goto io_error_exit; } /* $MFT must be uncompressed and unencrypted. */ if (a->flags & ATTR_COMPRESSION_MASK || a->flags & ATTR_IS_ENCRYPTED) { ntfs_log_error("$MFT must be uncompressed and " "unencrypted.\n"); goto io_error_exit; } /* * Decompress the mapping pairs array of this extent and merge * the result into the existing runlist. No need for locking * as we have exclusive access to the inode at this time and we * are a mount in progress task, too. */ nrl = ntfs_mapping_pairs_decompress(vol, a, vol->mft_na->rl); if (!nrl) { ntfs_log_perror("ntfs_mapping_pairs_decompress() failed"); goto error_exit; } /* Make sure $DATA is the MFT itself */ if (nrl->lcn != vol->mft_lcn) { ntfs_log_perror("The MFT is not self-contained"); goto error_exit; } vol->mft_na->rl = nrl; /* Get the lowest vcn for the next extent. */ highest_vcn = sle64_to_cpu(a->highest_vcn); next_vcn = highest_vcn + 1; /* Only one extent or error, which we catch below. */ if (next_vcn <= 0) break; /* Avoid endless loops due to corruption. */ if (next_vcn < sle64_to_cpu(a->lowest_vcn)) { ntfs_log_error("$MFT has corrupt attribute list.\n"); goto io_error_exit; } } if (!a) { ntfs_log_error("$MFT/$DATA attribute not found.\n"); goto io_error_exit; } if (highest_vcn && highest_vcn != last_vcn - 1) { ntfs_log_error("Failed to load runlist for $MFT/$DATA.\n"); ntfs_log_error("highest_vcn = 0x%llx, last_vcn - 1 = 0x%llx\n", (long long)highest_vcn, (long long)last_vcn - 1); goto io_error_exit; } ntfs_attr_reinit_search_ctx(ctx); /* Check if there is $FN attribute in $MFT. */ if (ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("No FILE_NAME in $MFT record\n"); goto error_exit; } /* Check if filename is "$MFT" */ fn = (FILE_NAME_ATTR *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); filename = ntfs_attr_name_get(fn->file_name, fn->file_name_length); if (!filename || strcmp(filename, "$MFT")) { ntfs_log_error("filename of $MFT record is not '$MFT'(%s)\n", filename); if (filename) ntfs_attr_name_free(&filename); goto error_exit; } ntfs_attr_name_free(&filename); /* Done with the $Mft mft record. */ ntfs_attr_put_search_ctx(ctx); ctx = NULL; /* Update the size fields in the inode. */ vol->mft_ni->data_size = vol->mft_na->data_size; vol->mft_ni->allocated_size = vol->mft_na->allocated_size; set_nino_flag(vol->mft_ni, KnownSize); /* * The volume is now setup so we can use all read access functions. */ vol->mftbmp_na = ntfs_attr_open(vol->mft_ni, AT_BITMAP, AT_UNNAMED, 0); if (!vol->mftbmp_na) { ntfs_log_perror("Failed to open $MFT/$BITMAP"); goto error_exit; } return 0; io_error_exit: errno = EIO; error_exit: eo = errno; if (ctx) ntfs_attr_put_search_ctx(ctx); if (vol->mft_na) { ntfs_attr_close(vol->mft_na); vol->mft_na = NULL; } if (vol->mft_ni) { ntfs_inode_close(vol->mft_ni); vol->mft_ni = NULL; } errno = eo; return -1; } /** * ntfs_mftmirr_load - load the $MFTMirr and setup the ntfs volume with it * @vol: ntfs volume whose $MFTMirr to load * * Load $MFTMirr from @vol and setup @vol with it. After calling this function * the volume @vol is ready for use by all write access functions provided by * the ntfs library (assuming ntfs_mft_load() has been called successfully * beforehand). * * Return 0 on success and -1 on error with errno set to the error code. */ static int ntfs_mftmirr_load(ntfs_volume *vol) { int err; char *filename = NULL; FILE_NAME_ATTR *fn; ntfs_attr_search_ctx *ctx = NULL; vol->mftmirr_ni = ntfs_inode_open(vol, FILE_MFTMirr); if (!vol->mftmirr_ni) { ntfs_log_perror("Failed to open inode $MFTMirr"); return -1; } if (vol->mftmirr_ni->mrec->flags != MFT_RECORD_IN_USE) { errno = ENOENT; goto error_exit; } vol->mftmirr_na = ntfs_attr_open(vol->mftmirr_ni, AT_DATA, AT_UNNAMED, 0); if (!vol->mftmirr_na) { ntfs_log_perror("Failed to open $MFTMirr/$DATA"); goto error_exit; } if (ntfs_attr_map_runlist(vol->mftmirr_na, 0) < 0) { ntfs_log_perror("Failed to map runlist of $MFTMirr/$DATA"); goto error_exit; } if (vol->mftmirr_na->rl->lcn != vol->mftmirr_lcn) { ntfs_log_error("Bad $MFTMirr lcn 0x%llx, want 0x%llx\n", (long long)vol->mftmirr_na->rl->lcn, (long long)vol->mftmirr_lcn); goto error_exit; } ctx = ntfs_attr_get_search_ctx(vol->mftmirr_ni, NULL); if (!ctx) goto error_exit; /* Check if there is $FN attribute in $MFT. */ if (ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_perror("No FILE_NAME in $MFTMirr record\n"); goto error_exit; } /* Check if filename is "$MFTMirr" */ fn = (FILE_NAME_ATTR *)((u8 *)ctx->attr + le16_to_cpu(ctx->attr->value_offset)); filename = ntfs_attr_name_get(fn->file_name, fn->file_name_length); if (!filename || strcmp(filename, "$MFTMirr")) { ntfs_log_error("filename of $MFT record is not '$MFTMirr'(%s)\n", filename); goto error_exit; } ntfs_attr_name_free(&filename); ntfs_attr_put_search_ctx(ctx); return 0; error_exit: err = errno; if (filename) ntfs_attr_name_free(&filename); if (ctx) ntfs_attr_put_search_ctx(ctx); if (vol->mftmirr_na) { ntfs_attr_close(vol->mftmirr_na); vol->mftmirr_na = NULL; } ntfs_inode_close(vol->mftmirr_ni); vol->mftmirr_ni = NULL; errno = err; return -1; } /* * Try an alternate boot sector and fix the real one * * Only after successful checks is the boot sector rewritten. * * The alternate boot sector is not rewritten, either because it * was found correct, or because we truncated the file system * and the last actual sector might be part of some file. * * Returns 0 if successful */ static int ntfsck_fix_boot_sector(ntfs_volume *vol, char *full_bs, s64 read_sector, s64 fix_sectors, s32 sector_size) { s64 br; int res; s64 got_sectors; le16 sector_size_le; NTFS_BOOT_SECTOR *bs; res = -1; br = ntfs_pread(vol->dev, read_sector*sector_size, sector_size, full_bs); if (br != sector_size) { if (br != -1) errno = EINVAL; if (!br) ntfs_log_error("Failed to read alternate bootsector (size=0)\n"); else ntfs_log_perror("Error reading alternate bootsector"); } else { bs = (NTFS_BOOT_SECTOR *)full_bs; got_sectors = sle64_to_cpu(bs->number_of_sectors); bs->number_of_sectors = cpu_to_sle64(fix_sectors); /* alignment problem on Sparc, even doing memcpy() */ sector_size_le = cpu_to_le16(sector_size); if (!memcmp(§or_size_le, &bs->bpb.bytes_per_sector, 2) && ntfs_boot_sector_is_ntfs(bs) && !ntfs_boot_sector_parse(vol, bs)) { s64 bw; ntfs_log_info("The alternate bootsector is usable\n"); if (fix_sectors != got_sectors) ntfs_log_info("Set sector count to %lld instead of %lld\n", (long long)fix_sectors, (long long)got_sectors); /* fix the normal boot sector */ ntfs_log_info("Rewriting the bootsector\n"); bw = ntfs_pwrite(vol->dev, 0, sector_size, full_bs); if (bw == sector_size) res = 0; else { if (bw != -1) errno = EINVAL; if (!bw) ntfs_log_error("Failed to rewrite the bootsector (size=0)\n"); else ntfs_log_perror("Error rewriting the bootsector"); } } if (!res) ntfs_log_verbose("The boot sector has been rewritten\n"); } return res; } /** * Return: 0 ok, 1 error. */ static BOOL ntfsck_verify_boot_sector(ntfs_volume *vol) { NTFS_BOOT_SECTOR *ntfs_boot; s32 sector_size; struct ntfs_device *dev = vol->dev; int res = 1; sector_size = ntfs_device_sector_size_get(dev); if (sector_size <= 0) sector_size = 512; ntfs_boot = ntfs_malloc(sector_size); if (!ntfs_boot) return 1; if (ntfs_pread(dev, 0, sector_size, ntfs_boot) != sector_size) { ntfs_log_error("Failed to read boot sector.\n"); ntfs_free(ntfs_boot); return 1; } if ((ntfs_boot->jump[0] != 0xeb) || ((ntfs_boot->jump[1] != 0x52) && (ntfs_boot->jump[1] != 0x5b)) || (ntfs_boot->jump[2] != 0x90)) { ntfs_log_error("Boot sector: Bad jump.\n"); ntfs_free(ntfs_boot); return 1; } if (ntfs_boot_sector_is_ntfs(ntfs_boot) && (ntfs_boot_sector_parse(vol, ntfs_boot) == 0)) goto out; if (NVolFsck(vol)) { problem_context_t pctx = {0, }; fsck_err_found(); if (ntfs_fix_problem(vol, PR_BOOT_SECTOR_INVALID, &pctx)) { s64 actual_sectors, shown_sectors; actual_sectors = ntfs_device_size_get(dev, sector_size) - 1; shown_sectors = sle64_to_cpu(ntfs_boot->number_of_sectors); /* first try the actual last sector */ if ((actual_sectors > 0) && !ntfsck_fix_boot_sector(vol, (char *)ntfs_boot, actual_sectors, actual_sectors, sector_size)) res = 0; /* then try the shown last sector, if less than actual */ if (res && (shown_sectors > 0) && (shown_sectors < actual_sectors) && !ntfsck_fix_boot_sector(vol, (char *)ntfs_boot, shown_sectors, shown_sectors, sector_size)) res = 0; /* then try reducing the number of sectors to actual value */ if (res && (shown_sectors > actual_sectors) && !ntfsck_fix_boot_sector(vol, (char *)ntfs_boot, 0, actual_sectors, sector_size)) res = 0; if (res) { ntfs_log_error("Boot sector: failed to fix boot sector\n"); ntfs_free(ntfs_boot); return res; } else fsck_err_fixed(); } else if (res) { ntfs_free(ntfs_boot); return 1; } } else { ntfs_log_error("Boot sector: invalid boot sector\n"); return 1; } out: if (NVolFsck(vol)) ntfs_log_verbose("Boot sector verification complete.\n"); // todo: if partition, query bios and match heads/tracks? ntfs_free(ntfs_boot); return 0; } /* * ntfs_recover_mft : recover mft record of 'mftno' in dest_mft lcn from 'src_mrec' * * vol : ntfs_volume structure * src_mrec : source MFT_RECORD structure for recovering * dest_mft : destination mft lcn (for $MFT or $MFTMirr) * mftno : mft record number to recover in $MFT or $MFTMirr, * it should be less than vol->mftmirr_size. */ static int ntfs_recover_mft(ntfs_volume *vol, MFT_RECORD *src_mrec, LCN dest_mft, u64 mftno) { MFT_RECORD *mwrite; u16 usn; u16 usa_ofs; le16 le_usn; le16 *usa_pos; s64 dest_pos; if (mftno >= vol->mftmirr_size) return -EINVAL; mwrite = ntfs_malloc(vol->mft_record_size); if (!mwrite) return -EIO; memcpy(mwrite, src_mrec, vol->mft_record_size); usa_ofs = le16_to_cpu(mwrite->usa_ofs); usa_pos = (le16 *)((u8 *)mwrite + usa_ofs); usn = le16_to_cpup(usa_pos); /* * ntfs_mst_pwrite will increase usn in function * so decrease by one to make same usn with source mrec */ le_usn = cpu_to_le16(usn - 1); *usa_pos = le_usn; dest_pos = (dest_mft << vol->cluster_size_bits) + (mftno * vol->mft_record_size); if (ntfs_mst_pwrite(vol->dev, dest_pos, 1, vol->mft_record_size, mwrite) != 1) { ntfs_log_perror("Error correcting mft record(%"PRIu64") of (%"PRIu64").", mftno, dest_mft); ntfs_free(mwrite); return -EIO; } #ifdef DEBUG ntfs_mst_pread(vol->dev, dest_pos, 1, vol->mft_record_size, mwrite); if (memcmp(mwrite, src_mrec, vol->mft_record_size)) { ntfs_log_error("After recover $MFT/$MFTMirr, both are differ!!\n"); ntfs_free(mwrite); return -EIO; } #endif ntfs_free(mwrite); return 0; } static int ntfs_recover_mft_from_mftmirr(ntfs_volume *vol, const u64 mftno) { MFT_RECORD *mrec; int err = 0; mrec = ntfs_malloc(vol->mft_record_size); if (!mrec) return -ENOMEM; if (ntfs_mst_pread(vol->dev, (vol->mftmirr_lcn << vol->cluster_size_bits) + mftno * vol->mft_record_size, 1, vol->mft_record_size, mrec) != 1) { err = -EIO; goto err_out; } if (ntfs_mft_record_check(vol, mftno, mrec)) { err = -EIO; goto err_out; } if (ntfs_recover_mft(vol, mrec, vol->mft_lcn, mftno)) { ntfs_log_perror("Error correcting $MFT record"); err = -EIO; goto err_out; } err_out: ntfs_free(mrec); return err; } /** * ntfs_volume_startup - allocate and setup an ntfs volume * @dev: device to open * @flags: optional mount flags * * Load, verify, and parse bootsector; load and setup $MFT and $MFTMirr. After * calling this function, the volume is setup sufficiently to call all read * and write access functions provided by the library. * * Return the allocated volume structure on success and NULL on error with * errno set to the error code. */ ntfs_volume *ntfs_volume_startup(struct ntfs_device *dev, ntfs_mount_flags flags) { LCN mft_zone_size, mft_lcn; ntfs_volume *vol; int eo; BOOL try_recover_mft = FALSE; problem_context_t pctx = {0, }; if (!dev || !dev->d_ops || !dev->d_name) { errno = EINVAL; ntfs_log_perror("%s: dev = %p", __FUNCTION__, dev); return NULL; } /* Allocate the volume structure. */ vol = ntfs_volume_alloc(); if (!vol) goto error_exit; /* Create the default upcase table. */ vol->upcase_len = ntfs_upcase_build_default(&vol->upcase); if (!vol->upcase_len || !vol->upcase) goto error_exit; /* Default with no locase table and case sensitive file names */ vol->locase = (ntfschar*)NULL; NVolSetCaseSensitive(vol); /* by default, all files are shown and not marked hidden */ NVolSetShowSysFiles(vol); NVolSetShowHidFiles(vol); NVolClearHideDotFiles(vol); /* set default compression */ #if DEFAULT_COMPRESSION NVolSetCompression(vol); #else NVolClearCompression(vol); #endif if (flags & NTFS_MNT_RDONLY) NVolSetReadOnly(vol); if (flags & NTFS_MNT_FSCK) NVolSetFsck(vol); if (flags & NTFS_MNT_FS_YES_REPAIR) NVolSetFsYesRepair(vol); else if (flags & NTFS_MNT_FS_ASK_REPAIR) NVolSetFsAskRepair(vol); else if (flags & NTFS_MNT_FS_AUTO_REPAIR) NVolSetFsAutoRepair(vol); else if (flags & NTFS_MNT_FS_NO_REPAIR) NVolSetFsNoRepair(vol); /* ...->open needs bracketing to compile with glibc 2.7 */ if ((dev->d_ops->open)(dev, NVolReadOnly(vol) ? O_RDONLY: O_RDWR)) { if (!NVolReadOnly(vol) && (errno == EROFS)) { if ((dev->d_ops->open)(dev, O_RDONLY)) { ntfs_log_perror("Error opening read-only '%s'", dev->d_name); goto error_exit; } else { ntfs_log_info("Error opening '%s' read-write\n", dev->d_name); NVolSetReadOnly(vol); } } else { ntfs_log_perror("Error opening '%s'", dev->d_name); goto error_exit; } } /* Attach the device to the volume. */ vol->dev = dev; if (ntfsck_verify_boot_sector(vol)) { errno = EOPNOTSUPP; goto error_exit; } /* Now set the device block size to the sector size. */ if (ntfs_device_block_size_set(vol->dev, vol->sector_size)) ntfs_log_debug("Failed to set the device block size to the " "sector size. This may affect performance " "but should be harmless otherwise. Error: " "%s\n", strerror(errno)); /* We now initialize the cluster allocator. */ vol->full_zones = 0; mft_zone_size = vol->nr_clusters >> 3; /* 12.5% */ /* Setup the mft zone. */ vol->mft_zone_start = vol->mft_zone_pos = vol->mft_lcn; ntfs_log_debug("mft_zone_pos = 0x%llx\n", (long long)vol->mft_zone_pos); /* * Calculate the mft_lcn for an unmodified NTFS volume (see mkntfs * source) and if the actual mft_lcn is in the expected place or even * further to the front of the volume, extend the mft_zone to cover the * beginning of the volume as well. This is in order to protect the * area reserved for the mft bitmap as well within the mft_zone itself. * On non-standard volumes we don't protect it as the overhead would be * higher than the speed increase we would get by doing it. */ mft_lcn = (8192 + 2 * vol->cluster_size - 1) / vol->cluster_size; if (mft_lcn * vol->cluster_size < 16 * 1024) mft_lcn = (16 * 1024 + vol->cluster_size - 1) / vol->cluster_size; if (vol->mft_zone_start <= mft_lcn) vol->mft_zone_start = 0; ntfs_log_debug("mft_zone_start = 0x%llx\n", (long long)vol->mft_zone_start); /* * Need to cap the mft zone on non-standard volumes so that it does * not point outside the boundaries of the volume. We do this by * halving the zone size until we are inside the volume. */ vol->mft_zone_end = vol->mft_lcn + mft_zone_size; while (vol->mft_zone_end >= vol->nr_clusters) { mft_zone_size >>= 1; if (!mft_zone_size) { errno = EINVAL; goto error_exit; } vol->mft_zone_end = vol->mft_lcn + mft_zone_size; } ntfs_log_debug("mft_zone_end = 0x%llx\n", (long long)vol->mft_zone_end); /* * Set the current position within each data zone to the start of the * respective zone. */ vol->data1_zone_pos = vol->mft_zone_end; ntfs_log_debug("data1_zone_pos = %lld\n", (long long)vol->data1_zone_pos); vol->data2_zone_pos = 0; ntfs_log_debug("data2_zone_pos = %lld\n", (long long)vol->data2_zone_pos); /* Set the mft data allocation position to mft record 24. */ vol->mft_data_pos = 24; /* * The cluster allocator is now fully operational. */ reload_mft: /* Need to setup $MFT so we can use the library read functions. */ if (ntfs_mft_load(vol) < 0) { if (try_recover_mft == FALSE) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_MOUNT_LOAD_MFT_FAILURE, &pctx)) { if (!ntfs_recover_mft_from_mftmirr(vol, 0)) { ntfs_log_info("Try to reload $MFT after updating it using $MFTMirr\n"); try_recover_mft = TRUE; fsck_err_fixed(); goto reload_mft; } } } else ntfs_log_perror("Failed to load $MFT"); goto error_exit; } try_recover_mft = FALSE; reload_mft_mirr: /* Need to setup $MFTMirr so we can use the write functions, too. */ if (ntfs_mftmirr_load(vol) < 0) { if (try_recover_mft == FALSE) { fsck_err_found(); if (ntfs_fix_problem(vol, PR_MOUNT_LOAD_MFTMIRR_FAILURE, &pctx)) { if (!ntfs_recover_mft_from_mftmirr(vol, 1)) { ntfs_log_info("Try to reload $MFTMirr after updating it using $MFT\n"); try_recover_mft = TRUE; fsck_err_fixed(); goto reload_mft_mirr; } } } else ntfs_log_perror("Failed to load $MFTMirr"); goto error_exit; } return vol; error_exit: eo = errno; if (vol) __ntfs_volume_release(vol); errno = eo; return NULL; } /** * ntfs_volume_check_logfile - check logfile on target volume * @vol: volume on which to check logfile * * Return 0 on success and -1 on error with errno set error code. */ static int ntfs_volume_check_logfile(ntfs_volume *vol) { ntfs_inode *ni; ntfs_attr *na = NULL; RESTART_PAGE_HEADER *rp = NULL; int err = 0; ni = ntfs_inode_open(vol, FILE_LogFile); if (!ni) { ntfs_log_perror("Failed to open inode FILE_LogFile"); errno = EIO; return -1; } na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { ntfs_log_perror("Failed to open $FILE_LogFile/$DATA"); err = EIO; goto out; } if (!ntfs_check_logfile(na, &rp)) err = EOPNOTSUPP; /* * If the latest restart page was identified as version * 2.0, then Windows may have kept a cached copy of * metadata for fast restarting, and we should not mount. * Hibernation will be seen the same way on a non * Windows-system partition, so we have to use the same * error code (EPERM). * The restart page may also be identified as version 2.0 * when access to the file system is terminated abruptly * by unplugging or power cut, so mounting is also rejected * after such an event. */ if (rp && (rp->major_ver == const_cpu_to_le16(2)) && (rp->minor_ver == const_cpu_to_le16(0))) { ntfs_log_error("Metadata kept in Windows cache, refused to mount.\n"); err = EPERM; } free(rp); ntfs_attr_close(na); out: if (ntfs_inode_close(ni)) ntfs_error_set(&err); if (err) { errno = err; return -1; } return 0; } /** * ntfs_hiberfile_open - Find and open '/hiberfil.sys' * @vol: An ntfs volume obtained from ntfs_mount * * Return: inode Success, hiberfil.sys is valid * NULL hiberfil.sys doesn't exist or some other error occurred */ static ntfs_inode *ntfs_hiberfile_open(ntfs_volume *vol) { u64 inode; ntfs_inode *ni_root; ntfs_inode *ni_hibr = NULL; ntfschar *unicode = NULL; int unicode_len; const char *hiberfile = "hiberfil.sys"; if (!vol) { errno = EINVAL; return NULL; } ni_root = ntfs_inode_open(vol, FILE_root); if (!ni_root) { ntfs_log_debug("Couldn't open the root directory.\n"); return NULL; } unicode_len = ntfs_mbstoucs(hiberfile, &unicode); if (unicode_len < 0) { ntfs_log_perror("Couldn't convert 'hiberfil.sys' to Unicode"); goto out; } inode = ntfs_inode_lookup_by_name(ni_root, unicode, unicode_len); if (inode == (u64)-1) { ntfs_log_debug("Couldn't find file '%s'.\n", hiberfile); goto out; } inode = MREF(inode); ni_hibr = ntfs_inode_open(vol, inode); if (!ni_hibr) { ntfs_log_debug("Couldn't open inode %lld.\n", (long long)inode); goto out; } out: if (ntfs_inode_close(ni_root)) { ntfs_inode_close(ni_hibr); ni_hibr = NULL; } free(unicode); return ni_hibr; } #define NTFS_HIBERFILE_HEADER_SIZE 4096 /** * ntfs_volume_check_hiberfile - check hiberfil.sys whether Windows is * hibernated on the target volume * @vol: volume on which to check hiberfil.sys * * Return: 0 if Windows isn't hibernated for sure * -1 otherwise and errno is set to the appropriate value */ int ntfs_volume_check_hiberfile(ntfs_volume *vol, int verbose) { ntfs_inode *ni; ntfs_attr *na = NULL; int bytes_read, err; char *buf = NULL; ni = ntfs_hiberfile_open(vol); if (!ni) { if (errno == ENOENT) return 0; return -1; } buf = ntfs_malloc(NTFS_HIBERFILE_HEADER_SIZE); if (!buf) goto out; na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { ntfs_log_perror("Failed to open hiberfil.sys data attribute"); goto out; } bytes_read = ntfs_attr_pread(na, 0, NTFS_HIBERFILE_HEADER_SIZE, buf); if (bytes_read == -1) { ntfs_log_perror("Failed to read hiberfil.sys"); goto out; } if (bytes_read < NTFS_HIBERFILE_HEADER_SIZE) { if (verbose) ntfs_log_error("Hibernated non-system partition, " "refused to mount.\n"); errno = EPERM; goto out; } if ((memcmp(buf, "hibr", 4) == 0) || (memcmp(buf, "HIBR", 4) == 0)) { if (verbose) ntfs_log_error("Windows is hibernated, refused to mount.\n"); errno = EPERM; goto out; } /* All right, all header bytes are zero */ errno = 0; out: if (na) ntfs_attr_close(na); free(buf); err = errno; if (ntfs_inode_close(ni)) ntfs_error_set(&err); errno = err; return errno ? -1 : 0; } /* * Make sure a LOGGED_UTILITY_STREAM attribute named "$TXF_DATA" * on the root directory is resident. * When it is non-resident, the partition cannot be mounted on Vista * (see http://support.microsoft.com/kb/974729) * * We take care to avoid this situation, however this can be a * consequence of having used an older version (including older * Windows version), so we had better fix it. * * Returns 0 if unneeded or successful * -1 if there was an error, explained by errno */ static int fix_txf_data(ntfs_volume *vol) { void *txf_data; s64 txf_data_size; ntfs_inode *ni; ntfs_attr *na; int res; res = 0; ntfs_log_debug("Loading root directory\n"); ni = ntfs_inode_open(vol, FILE_root); if (!ni) { ntfs_log_perror("Failed to open root directory"); res = -1; } else { /* Get the $TXF_DATA attribute */ na = ntfs_attr_open(ni, AT_LOGGED_UTILITY_STREAM, TXF_DATA, 9); if (na) { if (NAttrNonResident(na)) { /* * Fix the attribute by truncating, then * rewriting it. */ ntfs_log_debug("Making $TXF_DATA resident\n"); txf_data = ntfs_attr_readall(ni, AT_LOGGED_UTILITY_STREAM, TXF_DATA, 9, &txf_data_size); if (txf_data) { if (ntfs_attr_truncate(na, 0) || (ntfs_attr_pwrite(na, 0, txf_data_size, txf_data) != txf_data_size)) res = -1; free(txf_data); } if (res) ntfs_log_error("Failed to make $TXF_DATA resident\n"); else ntfs_log_error("$TXF_DATA made resident\n"); } ntfs_attr_close(na); } if (ntfs_inode_close(ni)) { ntfs_log_perror("Failed to close root"); res = -1; } } return (res); } /** * ntfs_device_mount - open ntfs volume * @dev: device to open * @flags: optional mount flags * * This function mounts an ntfs volume. @dev should describe the device which * to mount as the ntfs volume. * * @flags is an optional second parameter. The same flags are used as for * the mount system call (man 2 mount). Currently only the following flag * is implemented: * NTFS_MNT_RDONLY - mount volume read-only * * The function opens the device @dev and verifies that it contains a valid * bootsector. Then, it allocates an ntfs_volume structure and initializes * some of the values inside the structure from the information stored in the * bootsector. It proceeds to load the necessary system files and completes * setting up the structure. * * Return the allocated volume structure on success and NULL on error with * errno set to the error code. */ ntfs_volume *ntfs_device_mount(struct ntfs_device *dev, ntfs_mount_flags flags) { s64 l; ntfs_volume *vol; u8 *m = NULL, *m2 = NULL; ntfs_attr_search_ctx *ctx = NULL; ntfs_inode *ni; ntfs_attr *na; ATTR_RECORD *a; VOLUME_INFORMATION *vinf; ntfschar *vname; int i, j, eo; unsigned int k; u32 u; BOOL need_fallback_ro; problem_context_t pctx = {0, }; need_fallback_ro = FALSE; vol = ntfs_volume_startup(dev, flags); if (!vol) return NULL; if (!NVolFsck(vol)) goto skip_compare_mft; /* Load data from $MFT and $MFTMirr and compare the contents. */ m = ntfs_malloc(vol->mftmirr_size << vol->mft_record_size_bits); m2 = ntfs_malloc(vol->mftmirr_size << vol->mft_record_size_bits); if (!m || !m2) goto error_exit; l = ntfs_attr_mst_pread(vol->mft_na, 0, vol->mftmirr_size, vol->mft_record_size, m); if (l != vol->mftmirr_size) { if (l == -1) ntfs_log_perror("Failed to read $MFT"); else { ntfs_log_error("Failed to read $MFT, unexpected length " "(%lld != %d).\n", (long long)l, vol->mftmirr_size); errno = EIO; } goto error_exit; } l = ntfs_attr_mst_pread(vol->mftmirr_na, 0, vol->mftmirr_size, vol->mft_record_size, m2); if (l != vol->mftmirr_size) { if (l == -1) { ntfs_log_perror("Failed to read $MFTMirr"); goto error_exit; } vol->mftmirr_size = l; } ntfs_log_debug("Comparing $MFTMirr to $MFT...\n"); /* Windows 10 does not update the full $MFTMirr any more */ for (i = 0; (i < vol->mftmirr_size) && (i < FILE_first_user); ++i) { MFT_RECORD *mrec, *mrec2; const char *ESTR[12] = { "$MFT", "$MFTMirr", "$LogFile", "$Volume", "$AttrDef", "root directory", "$Bitmap", "$Boot", "$BadClus", "$Secure", "$UpCase", "$Extend" }; const char *s; BOOL use_mirr; if (i < 12) s = ESTR[i]; else if (i < 16) s = "system file"; else s = "mft record"; mrec = (MFT_RECORD *)(m + i * vol->mft_record_size); mrec2 = (MFT_RECORD *)(m2 + i * vol->mft_record_size); use_mirr = FALSE; /* check mft record of $MFT */ if (!ntfs_mft_record_check(vol, FILE_MFT + i, mrec)) { if (!memcmp(mrec, mrec2, vol->mft_record_size)) continue; fsck_err_found(); if (ntfs_fix_problem(vol, PR_MOUNT_MFT_MFTMIRR_MISMATCH, &pctx)) { if (ntfs_recover_mft(vol, mrec, vol->mftmirr_lcn, FILE_MFT + i)) { ntfs_log_perror("Error correcting $MFTMirror record : %d", i); goto io_error_exit; } fsck_err_fixed(); } continue; } /* check mft record of $MFTMirror */ if (!ntfs_mft_record_check(vol, FILE_MFT + i, mrec2)) use_mirr = TRUE; if (use_mirr == FALSE) { ntfs_log_error("Both $MFT/$MFTmirr error: Invalid mft record for '%s'\n", s); fsck_err_found(); goto io_error_exit; } fsck_err_found(); if (ntfs_fix_problem(vol, PR_MOUNT_REPAIRED_MFTMIRR_CORRUPTED, &pctx)) { if (ntfs_recover_mft(vol, mrec2, vol->mft_lcn, FILE_MFT + i)) { ntfs_log_perror("Error correcting $MFT record : %d", i); goto io_error_exit; } fsck_err_fixed(); } else { goto io_error_exit; } } free(m2); free(m); m = m2 = NULL; skip_compare_mft: /* Now load the bitmap from $Bitmap. */ ntfs_log_debug("Loading $Bitmap...\n"); vol->lcnbmp_ni = ntfs_inode_open(vol, FILE_Bitmap); if (!vol->lcnbmp_ni) { ntfs_log_perror("Failed to open inode FILE_Bitmap"); goto error_exit; } vol->lcnbmp_na = ntfs_attr_open(vol->lcnbmp_ni, AT_DATA, AT_UNNAMED, 0); if (!vol->lcnbmp_na) { ntfs_log_perror("Failed to open ntfs attribute"); goto error_exit; } if (vol->lcnbmp_na->data_size > vol->lcnbmp_na->allocated_size) { ntfs_log_error("Corrupt cluster map size (%lld > %lld)\n", (long long)vol->lcnbmp_na->data_size, (long long)vol->lcnbmp_na->allocated_size); goto io_error_exit; } /* Now load the upcase table from $UpCase. */ ntfs_log_debug("Loading $UpCase...\n"); ni = ntfs_inode_open(vol, FILE_UpCase); if (!ni) { ntfs_log_perror("Failed to open inode FILE_UpCase"); goto error_exit; } /* Get an ntfs attribute for $UpCase/$DATA. */ na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { ntfs_log_perror("Failed to open ntfs attribute"); ntfs_inode_close(ni); goto error_exit; } /* * Note: Normally, the upcase table has a length equal to 65536 * 2-byte Unicode characters. Anyway we currently can only process * such characters. */ if ((na->data_size - 2) & ~0x1fffeULL) { ntfs_log_error("Error: Upcase table is invalid (want size even " "<= 131072).\n"); errno = EINVAL; goto error_close; } if (vol->upcase_len != na->data_size >> 1) { vol->upcase_len = na->data_size >> 1; /* Throw away default table. */ free(vol->upcase); vol->upcase = ntfs_malloc(na->data_size); if (!vol->upcase) goto error_close; } /* Read in the $DATA attribute value into the buffer. */ l = ntfs_attr_pread(na, 0, na->data_size, vol->upcase); if (l != na->data_size) { ntfs_log_error("Failed to read $UpCase, unexpected length " "(%lld != %lld).\n", (long long)l, (long long)na->data_size); errno = EIO; goto error_close; } /* Done with the $UpCase mft record. */ ntfs_attr_close(na); if (ntfs_inode_close(ni)) { ntfs_log_perror("Failed to close $UpCase"); goto error_exit; } /* Consistency check of $UpCase, restricted to plain ASCII chars */ k = 0x20; while ((k < vol->upcase_len) && (k < 0x7f) && (le16_to_cpu(vol->upcase[k]) == ((k < 'a') || (k > 'z') ? k : k + 'A' - 'a'))) k++; if (k < 0x7f) { ntfs_log_error("Corrupted file $UpCase\n"); goto io_error_exit; } /* * Now load $Volume and set the version information and flags in the * vol structure accordingly. */ ntfs_log_debug("Loading $Volume...\n"); vol->vol_ni = ntfs_inode_open(vol, FILE_Volume); if (!vol->vol_ni) { ntfs_log_perror("Failed to open inode FILE_Volume"); goto error_exit; } /* Get a search context for the $Volume/$VOLUME_INFORMATION lookup. */ ctx = ntfs_attr_get_search_ctx(vol->vol_ni, NULL); if (!ctx) goto error_exit; /* Find the $VOLUME_INFORMATION attribute. */ if (ntfs_attr_lookup(AT_VOLUME_INFORMATION, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { ntfs_log_perror("$VOLUME_INFORMATION attribute not found in " "$Volume"); goto error_exit; } a = ctx->attr; /* Has to be resident. */ if (a->non_resident) { ntfs_log_error("Attribute $VOLUME_INFORMATION must be " "resident but it isn't.\n"); errno = EIO; goto error_exit; } /* Get a pointer to the value of the attribute. */ vinf = (VOLUME_INFORMATION*)(le16_to_cpu(a->value_offset) + (char*)a); /* Sanity checks. */ if ((char*)vinf + le32_to_cpu(a->value_length) > (char*)ctx->mrec + le32_to_cpu(ctx->mrec->bytes_in_use) || le16_to_cpu(a->value_offset) + le32_to_cpu( a->value_length) > le32_to_cpu(a->length)) { ntfs_log_error("$VOLUME_INFORMATION in $Volume is corrupt.\n"); errno = EIO; goto error_exit; } /* Setup vol from the volume information attribute value. */ vol->major_ver = vinf->major_ver; vol->minor_ver = vinf->minor_ver; /* Do not use le16_to_cpu() macro here as our VOLUME_FLAGS are defined using cpu_to_le16() macro and hence are consistent. */ vol->flags = vinf->flags; /* * Reinitialize the search context for the $Volume/$VOLUME_NAME lookup. */ ntfs_attr_reinit_search_ctx(ctx); if (ntfs_attr_lookup(AT_VOLUME_NAME, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { if (errno != ENOENT) { ntfs_log_perror("Failed to lookup of $VOLUME_NAME in " "$Volume failed"); goto error_exit; } /* * Attribute not present. This has been seen in the field. * Treat this the same way as if the attribute was present but * had zero length. */ vol->vol_name = ntfs_malloc(1); if (!vol->vol_name) goto error_exit; vol->vol_name[0] = '\0'; } else { a = ctx->attr; /* Has to be resident. */ if (a->non_resident) { ntfs_log_error("$VOLUME_NAME must be resident.\n"); errno = EIO; goto error_exit; } /* Get a pointer to the value of the attribute. */ vname = (ntfschar*)(le16_to_cpu(a->value_offset) + (char*)a); u = le32_to_cpu(a->value_length) / 2; /* * Convert Unicode volume name to current locale multibyte * format. */ vol->vol_name = NULL; if (ntfs_ucstombs(vname, u, &vol->vol_name, 0) == -1) { ntfs_log_perror("Volume name could not be converted " "to current locale"); ntfs_log_debug("Forcing name into ASCII by replacing " "non-ASCII characters with underscores.\n"); vol->vol_name = ntfs_malloc(u + 1); if (!vol->vol_name) goto error_exit; for (j = 0; j < (s32)u; j++) { u16 uc = le16_to_cpu(vname[j]); if (uc > 0xff) uc = (u16)'_'; vol->vol_name[j] = (char)uc; } vol->vol_name[u] = '\0'; } } ntfs_attr_put_search_ctx(ctx); ctx = NULL; /* Now load the attribute definitions from $AttrDef. */ ntfs_log_debug("Loading $AttrDef...\n"); ni = ntfs_inode_open(vol, FILE_AttrDef); if (!ni) { ntfs_log_perror("Failed to open $AttrDef"); goto error_exit; } /* Get an ntfs attribute for $AttrDef/$DATA. */ na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { ntfs_log_perror("Failed to open ntfs attribute"); ntfs_inode_close(ni); goto error_exit; } /* Check we don't overflow 24-bits. */ if ((u64)na->data_size > 0xffffffLL) { ntfs_log_error("Attribute definition table is too big (max " "24-bit allowed).\n"); errno = EINVAL; goto error_close; } vol->attrdef_len = na->data_size; vol->attrdef = ntfs_malloc(na->data_size); if (!vol->attrdef) { goto error_close; } /* Read in the $DATA attribute value into the buffer. */ l = ntfs_attr_pread(na, 0, na->data_size, vol->attrdef); if (l != na->data_size) { ntfs_log_error("Failed to read $AttrDef, unexpected length " "(%lld != %lld).\n", (long long)l, (long long)na->data_size); errno = EIO; goto error_close; } /* Done with the $AttrDef mft record. */ ntfs_attr_close(na); if (ntfs_inode_close(ni)) { ntfs_log_perror("Failed to close $AttrDef"); goto error_exit; } /* Open $Secure. */ if (ntfs_open_secure(vol)) goto error_exit; /* * Check for dirty logfile and hibernated Windows. * We care only about read-write mounts. */ if (!(flags & (NTFS_MNT_RDONLY | NTFS_MNT_FORENSIC))) { if (!(flags & NTFS_MNT_IGNORE_HIBERFILE) && ntfs_volume_check_hiberfile(vol, 1) < 0) { if (flags & NTFS_MNT_MAY_RDONLY) need_fallback_ro = TRUE; else goto error_exit; } if (ntfs_volume_check_logfile(vol) < 0) { /* Always reject cached metadata for now */ if (!(flags & NTFS_MNT_RECOVER) || (errno == EPERM)) { if (flags & NTFS_MNT_MAY_RDONLY) need_fallback_ro = TRUE; else goto error_exit; } else { ntfs_log_info("The file system wasn't safely " "closed on Windows. Fixing.\n"); if (ntfs_logfile_reset(vol)) goto error_exit; } } /* make $TXF_DATA resident if present on the root directory */ if (!(flags & NTFS_MNT_RDONLY) && !need_fallback_ro) { if (fix_txf_data(vol)) goto error_exit; } } if (need_fallback_ro) { NVolSetReadOnly(vol); ntfs_log_error("%s", fallback_readonly_msg); } return vol; error_close : ntfs_attr_close(na); ntfs_inode_close(ni); goto error_exit; io_error_exit: errno = EIO; error_exit: eo = errno; if (ctx) ntfs_attr_put_search_ctx(ctx); if (m) free(m); if (m2) free(m2); __ntfs_volume_release(vol); errno = eo; return NULL; } /* * Set appropriate flags for showing NTFS metafiles * or files marked as hidden. * Not set in ntfs_mount() to avoid breaking existing tools. */ int ntfs_set_shown_files(ntfs_volume *vol, BOOL show_sys_files, BOOL show_hid_files, BOOL hide_dot_files) { int res; res = -1; if (vol) { NVolClearShowSysFiles(vol); NVolClearShowHidFiles(vol); NVolClearHideDotFiles(vol); if (show_sys_files) NVolSetShowSysFiles(vol); if (show_hid_files) NVolSetShowHidFiles(vol); if (hide_dot_files) NVolSetHideDotFiles(vol); res = 0; } if (res) ntfs_log_error("Failed to set file visibility\n"); return (res); } /* * Set ignore case mode */ int ntfs_set_ignore_case(ntfs_volume *vol) { int res; res = -1; if (vol && vol->upcase) { vol->locase = ntfs_locase_table_build(vol->upcase, vol->upcase_len); if (vol->locase) { NVolClearCaseSensitive(vol); res = 0; } } if (res) ntfs_log_error("Failed to set ignore_case mode\n"); return (res); } /** * ntfs_mount - open ntfs volume * @name: name of device/file to open * @flags: optional mount flags * * This function mounts an ntfs volume. @name should contain the name of the * device/file to mount as the ntfs volume. * * @flags is an optional second parameter. The same flags are used as for * the mount system call (man 2 mount). Currently only the following flags * is implemented: * NTFS_MNT_RDONLY - mount volume read-only * * The function opens the device or file @name and verifies that it contains a * valid bootsector. Then, it allocates an ntfs_volume structure and initializes * some of the values inside the structure from the information stored in the * bootsector. It proceeds to load the necessary system files and completes * setting up the structure. * * Return the allocated volume structure on success and NULL on error with * errno set to the error code. * * Note, that a copy is made of @name, and hence it can be discarded as * soon as the function returns. */ ntfs_volume *ntfs_mount(const char *name __attribute__((unused)), ntfs_mount_flags flags __attribute__((unused))) { #ifndef NO_NTFS_DEVICE_DEFAULT_IO_OPS struct ntfs_device *dev; ntfs_volume *vol; /* Allocate an ntfs_device structure. */ dev = ntfs_device_alloc(name, 0, &ntfs_device_default_io_ops, NULL); if (!dev) return NULL; /* Call ntfs_device_mount() to do the actual mount. */ vol = ntfs_device_mount(dev, flags); if (!vol) { int eo = errno; ntfs_device_free(dev); errno = eo; } else ntfs_create_lru_caches(vol); return vol; #else /* * ntfs_mount() makes no sense if NO_NTFS_DEVICE_DEFAULT_IO_OPS is * defined as there are no device operations available in libntfs in * this case. */ errno = EOPNOTSUPP; return NULL; #endif } /** * ntfs_umount - close ntfs volume * @vol: address of ntfs_volume structure of volume to close * @force: if true force close the volume even if it is busy * * Deallocate all structures (including @vol itself) associated with the ntfs * volume @vol. * * Return 0 on success. On error return -1 with errno set appropriately * (most likely to one of EAGAIN, EBUSY or EINVAL). The EAGAIN error means that * an operation is in progress and if you try the close later the operation * might be completed and the close succeed. * * If @force is true (i.e. not zero) this function will close the volume even * if this means that data might be lost. * * @vol must have previously been returned by a call to ntfs_mount(). * * @vol itself is deallocated and should no longer be dereferenced after this * function returns success. If it returns an error then nothing has been done * so it is safe to continue using @vol. */ int ntfs_umount(ntfs_volume *vol, const BOOL force __attribute__((unused))) { struct ntfs_device *dev; int ret; if (!vol) { errno = EINVAL; return -1; } dev = vol->dev; ret = __ntfs_volume_release(vol); ntfs_device_free(dev); return ret; } #ifdef HAVE_MNTENT_H /** * ntfs_mntent_check - desc * * If you are wanting to use this, you actually wanted to use * ntfs_check_if_mounted(), you just didn't realize. (-: * * See description of ntfs_check_if_mounted(), below. */ static int ntfs_mntent_check(const char *file, unsigned long *mnt_flags) { struct mntent *mnt; char *real_file = NULL, *real_fsname = NULL; FILE *f; int err = 0; real_file = ntfs_malloc(PATH_MAX + 1); if (!real_file) return -1; real_fsname = ntfs_malloc(PATH_MAX + 1); if (!real_fsname) { err = errno; goto exit; } if (!ntfs_realpath_canonicalize(file, real_file)) { err = errno; goto exit; } f = setmntent("/proc/mounts", "r"); if (!f && !(f = setmntent(MOUNTED, "r"))) { err = errno; goto exit; } while ((mnt = getmntent(f))) { if (!ntfs_realpath_canonicalize(mnt->mnt_fsname, real_fsname)) continue; if (!strcmp(real_file, real_fsname)) break; } endmntent(f); if (!mnt) goto exit; *mnt_flags = NTFS_MF_MOUNTED; if (!strcmp(mnt->mnt_dir, "/")) *mnt_flags |= NTFS_MF_ISROOT; #ifdef HAVE_HASMNTOPT if (hasmntopt(mnt, "ro") && !hasmntopt(mnt, "rw")) *mnt_flags |= NTFS_MF_READONLY; #endif exit: free(real_file); free(real_fsname); if (err) { errno = err; return -1; } return 0; } #else /* HAVE_MNTENT_H */ #if defined(__sun) && defined (__SVR4) static int ntfs_mntent_check(const char *file, unsigned long *mnt_flags) { struct mnttab *mnt = NULL; char *real_file = NULL, *real_fsname = NULL; FILE *f; int err = 0; real_file = (char*)ntfs_malloc(PATH_MAX + 1); if (!real_file) return -1; real_fsname = (char*)ntfs_malloc(PATH_MAX + 1); mnt = (struct mnttab*)ntfs_malloc(MNT_LINE_MAX + 1); if (!real_fsname || !mnt) { err = errno; goto exit; } if (!ntfs_realpath_canonicalize(file, real_file)) { err = errno; goto exit; } if (!(f = fopen(MNTTAB, "r"))) { err = errno; goto exit; } while (!getmntent(f, mnt)) { if (!ntfs_realpath_canonicalize(mnt->mnt_special, real_fsname)) continue; if (!strcmp(real_file, real_fsname)) { *mnt_flags = NTFS_MF_MOUNTED; if (!strcmp(mnt->mnt_mountp, "/")) *mnt_flags |= NTFS_MF_ISROOT; if (hasmntopt(mnt, "ro") && !hasmntopt(mnt, "rw")) *mnt_flags |= NTFS_MF_READONLY; break; } } fclose(f); exit: free(mnt); free(real_file); free(real_fsname); if (err) { errno = err; return -1; } return 0; } #endif /* defined(__sun) && defined (__SVR4) */ #endif /* HAVE_MNTENT_H */ /** * ntfs_check_if_mounted - check if an ntfs volume is currently mounted * @file: device file to check * @mnt_flags: pointer into which to return the ntfs mount flags (see volume.h) * * If the running system does not support the {set,get,end}mntent() calls, * just return 0 and set *@mnt_flags to zero. * * When the system does support the calls, ntfs_check_if_mounted() first tries * to find the device @file in /etc/mtab (or wherever this is kept on the * running system). If it is not found, assume the device is not mounted and * return 0 and set *@mnt_flags to zero. * * If the device @file is found, set the NTFS_MF_MOUNTED flags in *@mnt_flags. * * Further if @file is mounted as the file system root ("/"), set the flag * NTFS_MF_ISROOT in *@mnt_flags. * * Finally, check if the file system is mounted read-only, and if so set the * NTFS_MF_READONLY flag in *@mnt_flags. * * On success return 0 with *@mnt_flags set to the ntfs mount flags. * * On error return -1 with errno set to the error code. */ int ntfs_check_if_mounted(const char *file __attribute__((unused)), unsigned long *mnt_flags) { *mnt_flags = 0; #if defined(HAVE_MNTENT_H) || (defined(__sun) && defined (__SVR4)) return ntfs_mntent_check(file, mnt_flags); #else return 0; #endif } /** * ntfs_version_is_supported - check if NTFS version is supported. * @vol: ntfs volume whose version we're interested in. * * The function checks if the NTFS volume version is known or not. * Version 1.1 and 1.2 are used by Windows NT3.x and NT4. * Version 2.x is used by Windows 2000 Betas. * Version 3.0 is used by Windows 2000. * Version 3.1 is used by Windows XP, Windows Server 2003 and Longhorn. * * Return 0 if NTFS version is supported otherwise -1 with errno set. * * The following error codes are defined: * EOPNOTSUPP - Unknown NTFS version * EINVAL - Invalid argument */ int ntfs_version_is_supported(ntfs_volume *vol) { u8 major, minor; if (!vol) { errno = EINVAL; return -1; } major = vol->major_ver; minor = vol->minor_ver; if (NTFS_V1_1(major, minor) || NTFS_V1_2(major, minor)) return 0; if (NTFS_V2_X(major, minor)) return 0; if (NTFS_V3_0(major, minor) || NTFS_V3_1(major, minor)) return 0; errno = EOPNOTSUPP; return -1; } /** * ntfs_logfile_reset - "empty" $LogFile data attribute value * @vol: ntfs volume whose $LogFile we intend to reset. * * Fill the value of the $LogFile data attribute, i.e. the contents of * the file, with 0xff's, thus marking the journal as empty. * * FIXME(?): We might need to zero the LSN field of every single mft * record as well. (But, first try without doing that and see what * happens, since chkdsk might pickup the pieces and do it for us...) * * On success return 0. * * On error return -1 with errno set to the error code. */ int ntfs_logfile_reset(ntfs_volume *vol) { ntfs_inode *ni; ntfs_attr *na; int eo; if (!vol) { errno = EINVAL; return -1; } ni = ntfs_inode_open(vol, FILE_LogFile); if (!ni) { ntfs_log_perror("Failed to open inode FILE_LogFile"); return -1; } na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { eo = errno; ntfs_log_perror("Failed to open $FILE_LogFile/$DATA"); goto error_exit; } if (ntfs_empty_logfile(na)) { eo = errno; ntfs_attr_close(na); goto error_exit; } ntfs_attr_close(na); return ntfs_inode_close(ni); error_exit: ntfs_inode_close(ni); errno = eo; return -1; } /** * ntfs_volume_write_flags - set the flags of an ntfs volume * @vol: ntfs volume where we set the volume flags * @flags: new flags * * Set the on-disk volume flags in the mft record of $Volume and * on volume @vol to @flags. * * Return 0 if successful and -1 if not with errno set to the error code. */ int ntfs_volume_write_flags(ntfs_volume *vol, const le16 flags) { ATTR_RECORD *a; VOLUME_INFORMATION *c; ntfs_attr_search_ctx *ctx; int ret = -1; /* failure */ if (!vol || !vol->vol_ni) { errno = EINVAL; return -1; } /* Get a pointer to the volume information attribute. */ ctx = ntfs_attr_get_search_ctx(vol->vol_ni, NULL); if (!ctx) return -1; if (ntfs_attr_lookup(AT_VOLUME_INFORMATION, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) { ntfs_log_error("Attribute $VOLUME_INFORMATION was not found " "in $Volume!\n"); goto err_out; } a = ctx->attr; /* Sanity check. */ if (a->non_resident) { ntfs_log_error("Attribute $VOLUME_INFORMATION must be resident " "but it isn't.\n"); errno = EIO; goto err_out; } /* Get a pointer to the value of the attribute. */ c = (VOLUME_INFORMATION*)(le16_to_cpu(a->value_offset) + (char*)a); /* Sanity checks. */ if ((char*)c + le32_to_cpu(a->value_length) > (char*)ctx->mrec + le32_to_cpu(ctx->mrec->bytes_in_use) || le16_to_cpu(a->value_offset) + le32_to_cpu(a->value_length) > le32_to_cpu(a->length)) { ntfs_log_error("Attribute $VOLUME_INFORMATION in $Volume is " "corrupt!\n"); errno = EIO; goto err_out; } /* Set the volume flags. */ vol->flags = c->flags = flags & VOLUME_FLAGS_MASK; /* Write them to disk. */ ntfs_inode_mark_dirty(vol->vol_ni); if (ntfs_inode_sync(vol->vol_ni)) goto err_out; ret = 0; /* success */ err_out: ntfs_attr_put_search_ctx(ctx); return ret; } int ntfs_volume_error(int err) { int ret; switch (err) { case 0: ret = NTFS_VOLUME_OK; break; case EINVAL: ret = NTFS_VOLUME_NOT_NTFS; break; case EIO: ret = NTFS_VOLUME_CORRUPT; break; case EPERM: /* * Hibernation and fast restarting are seen the * same way on a non Windows-system partition. */ ret = NTFS_VOLUME_HIBERNATED; break; case EOPNOTSUPP: ret = NTFS_VOLUME_UNCLEAN_UNMOUNT; break; case EBUSY: ret = NTFS_VOLUME_LOCKED; break; case ENXIO: ret = NTFS_VOLUME_RAID; break; case EACCES: ret = NTFS_VOLUME_NO_PRIVILEGE; break; default: ret = NTFS_VOLUME_UNKNOWN_REASON; break; } return ret; } void ntfs_mount_error(const char *volume, const char *mntpoint, int err) { switch (err) { case NTFS_VOLUME_NOT_NTFS: ntfs_log_error(invalid_ntfs_msg, volume); break; case NTFS_VOLUME_CORRUPT: ntfs_log_error("%s", corrupt_volume_msg); break; case NTFS_VOLUME_HIBERNATED: ntfs_log_error(hibernated_volume_msg, volume, mntpoint); break; case NTFS_VOLUME_UNCLEAN_UNMOUNT: ntfs_log_error("%s", unclean_journal_msg); break; case NTFS_VOLUME_LOCKED: ntfs_log_error("%s", opened_volume_msg); break; case NTFS_VOLUME_RAID: ntfs_log_error("%s", fakeraid_msg); break; case NTFS_VOLUME_NO_PRIVILEGE: ntfs_log_error(access_denied_msg, volume); break; } } int ntfs_set_locale(void) { const char *locale; locale = setlocale(LC_ALL, ""); if (!locale) { locale = setlocale(LC_ALL, NULL); ntfs_log_error("Couldn't set local environment, using default " "'%s'.\n", locale); return 1; } return 0; } /* * Feed the counts of free clusters and free mft records */ int ntfs_volume_get_free_space(ntfs_volume *vol) { ntfs_attr *na; int ret; ret = -1; /* default return */ vol->free_clusters = ntfs_attr_get_free_bits(vol->lcnbmp_na); if (vol->free_clusters < 0) { ntfs_log_perror("Failed to read NTFS $Bitmap"); } else { na = vol->mftbmp_na; vol->free_mft_records = ntfs_attr_get_free_bits(na); if (vol->free_mft_records >= 0) vol->free_mft_records += (na->allocated_size - na->data_size) << 3; if (vol->free_mft_records < 0) ntfs_log_perror("Failed to calculate free MFT records"); else { NVolSetFreeSpaceKnown(vol); ret = 0; } } return (ret); } /** * ntfs_volume_rename - change the current label on a volume * @vol: volume to change the label on * @label: the new label * @label_len: the length of @label in ntfschars including the terminating NULL * character, which is mandatory (the value can not exceed 128) * * Change the label on the volume @vol to @label. */ int ntfs_volume_rename(ntfs_volume *vol, const ntfschar *label, int label_len) { ntfs_attr *na; char *old_vol_name; char *new_vol_name = NULL; int new_vol_name_len; int err; if (NVolReadOnly(vol)) { ntfs_log_error("Refusing to change label on read-only mounted " "volume.\n"); errno = EROFS; return -1; } label_len *= sizeof(ntfschar); if (label_len > 0x100) { ntfs_log_error("New label is too long. Maximum %u characters " "allowed.\n", (unsigned)(0x100 / sizeof(ntfschar))); errno = ERANGE; return -1; } na = ntfs_attr_open(vol->vol_ni, AT_VOLUME_NAME, AT_UNNAMED, 0); if (!na) { if (errno != ENOENT) { err = errno; ntfs_log_perror("Lookup of $VOLUME_NAME attribute " "failed"); goto err_out; } /* The volume name attribute does not exist. Need to add it. */ if (ntfs_attr_add(vol->vol_ni, AT_VOLUME_NAME, AT_UNNAMED, 0, (const u8*) label, label_len)) { err = errno; ntfs_log_perror("Encountered error while adding " "$VOLUME_NAME attribute"); goto err_out; } } else { s64 written; if (NAttrNonResident(na)) { err = errno; ntfs_log_error("Error: Attribute $VOLUME_NAME must be " "resident.\n"); goto err_out; } if (na->data_size != label_len) { if (ntfs_attr_truncate(na, label_len)) { err = errno; ntfs_log_perror("Error resizing resident " "attribute"); goto err_out; } } if (label_len) { written = ntfs_attr_pwrite(na, 0, label_len, label); if (written == -1) { err = errno; ntfs_log_perror("Error when writing " "$VOLUME_NAME data"); goto err_out; } else if (written != label_len) { err = EIO; ntfs_log_error("Partial write when writing " "$VOLUME_NAME data."); goto err_out; } } } new_vol_name_len = ntfs_ucstombs(label, label_len, &new_vol_name, 0); if (new_vol_name_len == -1) { err = errno; ntfs_log_perror("Error while decoding new volume name"); goto err_out; } old_vol_name = vol->vol_name; vol->vol_name = new_vol_name; free(old_vol_name); err = 0; err_out: if (na) ntfs_attr_close(na); if (err) errno = err; return err ? -1 : 0; } ntfsprogs-plus-1.0.0/libntfs/win32_io.c000066400000000000000000001554111507404161300177640ustar00rootroot00000000000000/* * win32_io.c - A stdio-like disk I/O implementation for low-level disk access * on Win32. Can access an NTFS volume while it is mounted. * Originated from the Linux-NTFS project. * * Copyright (c) 2003-2004 Lode Leroy * Copyright (c) 2003-2006 Anton Altaparmakov * Copyright (c) 2004-2005 Yuval Fledel * Copyright (c) 2012-2014 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_WINDOWS_H #define BOOL WINBOOL /* avoid conflicting definitions of BOOL */ #include #undef BOOL #endif #ifdef HAVE_STDLIB_H #include #endif /* * Definitions needed for */ #ifndef _ANONYMOUS_UNION #define _ANONYMOUS_UNION #define _ANONYMOUS_STRUCT typedef unsigned long long DWORD64; #endif typedef struct { DWORD data1; /* The first eight hexadecimal digits of the GUID. */ WORD data2; /* The first group of four hexadecimal digits. */ WORD data3; /* The second group of four hexadecimal digits. */ char data4[8]; /* The first two bytes are the third group of four hexadecimal digits. The remaining six bytes are the final 12 hexadecimal digits. */ } GUID; #include #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_CTYPE_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_SYS_STAT_H #include #define stat stat64 #define st_blocks st_rdev /* emulate st_blocks, missing in Windows */ #endif /* Prevent volume.h from being be loaded, as it conflicts with winnt.h. */ #define _NTFS_VOLUME_H struct ntfs_volume; typedef struct ntfs_volume ntfs_volume; #include "debug.h" #include "types.h" #include "device.h" #include "misc.h" #define cpu_to_le16(x) (x) #define const_cpu_to_le16(x) (x) #ifndef MAX_PATH #define MAX_PATH 1024 #endif #ifndef NTFS_BLOCK_SIZE #define NTFS_BLOCK_SIZE 512 #define NTFS_BLOCK_SIZE_BITS 9 #endif #ifndef INVALID_SET_FILE_POINTER #define INVALID_SET_FILE_POINTER ((DWORD)-1) #endif #ifndef IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS #define IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS 5636096 #endif #ifndef IOCTL_DISK_GET_DRIVE_GEOMETRY #define IOCTL_DISK_GET_DRIVE_GEOMETRY 0x70000 #endif #ifndef IOCTL_GET_DISK_LENGTH_INFO #define IOCTL_GET_DISK_LENGTH_INFO 0x7405c #endif #ifndef FSCTL_ALLOW_EXTENDED_DASD_IO #define FSCTL_ALLOW_EXTENDED_DASD_IO 0x90083 #endif /* Windows 2k+ imports. */ typedef HANDLE (WINAPI *LPFN_FINDFIRSTVOLUME)(LPTSTR, DWORD); typedef BOOL (WINAPI *LPFN_FINDNEXTVOLUME)(HANDLE, LPTSTR, DWORD); typedef BOOL (WINAPI *LPFN_FINDVOLUMECLOSE)(HANDLE); typedef BOOL (WINAPI *LPFN_SETFILEPOINTEREX)(HANDLE, LARGE_INTEGER, PLARGE_INTEGER, DWORD); static LPFN_FINDFIRSTVOLUME fnFindFirstVolume = NULL; static LPFN_FINDNEXTVOLUME fnFindNextVolume = NULL; static LPFN_FINDVOLUMECLOSE fnFindVolumeClose = NULL; static LPFN_SETFILEPOINTEREX fnSetFilePointerEx = NULL; #ifdef UNICODE #define FNPOSTFIX "W" #else #define FNPOSTFIX "A" #endif enum { /* see http://msdn.microsoft.com/en-us/library/cc704588(v=prot.10).aspx */ STATUS_UNKNOWN = -1, STATUS_SUCCESS = 0x00000000, STATUS_BUFFER_OVERFLOW = 0x80000005, STATUS_INVALID_HANDLE = 0xC0000008, STATUS_INVALID_PARAMETER = 0xC000000D, STATUS_INVALID_DEVICE_REQUEST = 0xC0000010, STATUS_END_OF_FILE = 0xC0000011, STATUS_CONFLICTING_ADDRESSES = 0xC0000018, STATUS_NO_MATCH = 0xC000001E, STATUS_ACCESS_DENIED = 0xC0000022, STATUS_BUFFER_TOO_SMALL = 0xC0000023, STATUS_OBJECT_TYPE_MISMATCH = 0xC0000024, STATUS_FILE_NOT_FOUND = 0xC0000028, STATUS_OBJECT_NAME_INVALID = 0xC0000033, STATUS_OBJECT_NAME_NOT_FOUND = 0xC0000034, STATUS_SHARING_VIOLATION = 0xC0000043, STATUS_INVALID_PARAMETER_1 = 0xC00000EF, STATUS_IO_DEVICE_ERROR = 0xC0000185, STATUS_GUARD_PAGE_VIOLATION = 0x80000001 } ; typedef u32 NTSTATUS; /* do not let the compiler choose the size */ #ifdef __x86_64__ typedef unsigned long long ULONG_PTR; /* an integer the same size as a pointer */ #else typedef unsigned long ULONG_PTR; /* an integer the same size as a pointer */ #endif HANDLE get_osfhandle(int); /* from msvcrt.dll */ /* * A few needed definitions not included in */ typedef struct _IO_STATUS_BLOCK { union { NTSTATUS Status; PVOID Pointer; }; ULONG_PTR Information; } IO_STATUS_BLOCK, *PIO_STATUS_BLOCK; typedef struct _UNICODE_STRING { USHORT Length; USHORT MaximumLength; #ifdef __x86_64__ u32 padding; #endif PWSTR Buffer; } UNICODE_STRING, *PUNICODE_STRING; typedef struct _OBJECT_ATTRIBUTES { ULONG Length; #ifdef __x86_64__ u32 padding1; HANDLE RootDirectory; PUNICODE_STRING ObjectName; ULONG Attributes; u32 padding2; #else HANDLE RootDirectory; PUNICODE_STRING ObjectName; ULONG Attributes; #endif PVOID SecurityDescriptor; PVOID SecurityQualityOfService; } OBJECT_ATTRIBUTES, *POBJECT_ATTRIBUTES; #define FILE_OPEN 1 #define FILE_CREATE 2 #define FILE_OVERWRITE 4 #define FILE_SYNCHRONOUS_IO_ALERT 0x10 #define FILE_SYNCHRONOUS_IO_NONALERT 0x20 #define OBJ_CASE_INSENSITIVE 0x40 typedef void (WINAPI *PIO_APC_ROUTINE)(void*, PIO_STATUS_BLOCK, ULONG); extern WINAPI NTSTATUS NtOpenFile( PHANDLE FileHandle, ACCESS_MASK DesiredAccess, POBJECT_ATTRIBUTES ObjectAttributes, PIO_STATUS_BLOCK IoStatusBlock, ULONG ShareAccess, ULONG OpenOptions ); extern WINAPI NTSTATUS NtReadFile( HANDLE FileHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, PVOID ApcContext, PIO_STATUS_BLOCK IoStatusBlock, PVOID Buffer, ULONG Length, PLARGE_INTEGER ByteOffset, PULONG Key ); extern WINAPI NTSTATUS NtWriteFile( HANDLE FileHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, PVOID ApcContext, PIO_STATUS_BLOCK IoStatusBlock, LPCVOID Buffer, ULONG Length, PLARGE_INTEGER ByteOffset, PULONG Key ); extern NTSTATUS WINAPI NtClose( HANDLE Handle ); extern NTSTATUS WINAPI NtDeviceIoControlFile( HANDLE FileHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, PVOID ApcContext, PIO_STATUS_BLOCK IoStatusBlock, ULONG IoControlCode, PVOID InputBuffer, ULONG InputBufferLength, PVOID OutputBuffer, ULONG OutputBufferLength ); extern NTSTATUS WINAPI NtFsControlFile( HANDLE FileHandle, HANDLE Event, PIO_APC_ROUTINE ApcRoutine, PVOID ApcContext, PIO_STATUS_BLOCK IoStatusBlock, ULONG FsControlCode, PVOID InputBuffer, ULONG InputBufferLength, PVOID OutputBuffer, ULONG OutputBufferLength ); /** * struct win32_fd - */ typedef struct { HANDLE handle; s64 pos; /* Logical current position on the volume. */ s64 part_start; s64 part_length; int part_hidden_sectors; s64 geo_size, geo_cylinders; s32 geo_sector_size; s64 volume_size; DWORD geo_sectors, geo_heads; HANDLE vol_handle; BOOL ntdll; } win32_fd; /** * ntfs_w32error_to_errno - convert a win32 error code to the unix one * @w32error: the win32 error code * * Limited to a relatively small but useful number of codes. */ static int ntfs_w32error_to_errno(unsigned int w32error) { ntfs_log_trace("Converting w32error 0x%x.\n",w32error); switch (w32error) { case ERROR_INVALID_FUNCTION: return EBADRQC; case ERROR_FILE_NOT_FOUND: case ERROR_PATH_NOT_FOUND: case ERROR_INVALID_NAME: return ENOENT; case ERROR_TOO_MANY_OPEN_FILES: return EMFILE; case ERROR_ACCESS_DENIED: return EACCES; case ERROR_INVALID_HANDLE: return EBADF; case ERROR_NOT_ENOUGH_MEMORY: return ENOMEM; case ERROR_OUTOFMEMORY: return ENOSPC; case ERROR_INVALID_DRIVE: case ERROR_BAD_UNIT: return ENODEV; case ERROR_WRITE_PROTECT: return EROFS; case ERROR_NOT_READY: case ERROR_SHARING_VIOLATION: return EBUSY; case ERROR_BAD_COMMAND: return EINVAL; case ERROR_SEEK: case ERROR_NEGATIVE_SEEK: return ESPIPE; case ERROR_NOT_SUPPORTED: return EOPNOTSUPP; case ERROR_BAD_NETPATH: return ENOSHARE; default: /* generic message */ return ENOMSG; } } static int ntfs_ntstatus_to_errno(NTSTATUS status) { ntfs_log_trace("Converting w32error 0x%x.\n",w32error); switch (status) { case STATUS_INVALID_HANDLE : case STATUS_INVALID_PARAMETER : case STATUS_OBJECT_NAME_INVALID : case STATUS_INVALID_DEVICE_REQUEST : return (EINVAL); case STATUS_ACCESS_DENIED : return (EACCES); case STATUS_IO_DEVICE_ERROR : case STATUS_END_OF_FILE : return (EIO); case STATUS_SHARING_VIOLATION : return (EBUSY); default: /* generic message */ return ENOMSG; } } /** * libntfs_SetFilePointerEx - emulation for SetFilePointerEx() * * We use this to emulate SetFilePointerEx() when it is not present. This can * happen since SetFilePointerEx() only exists in Win2k+. */ static BOOL WINAPI libntfs_SetFilePointerEx(HANDLE hFile, LARGE_INTEGER liDistanceToMove, PLARGE_INTEGER lpNewFilePointer, DWORD dwMoveMethod) { liDistanceToMove.u.LowPart = SetFilePointer(hFile, liDistanceToMove.u.LowPart, &liDistanceToMove.u.HighPart, dwMoveMethod); SetLastError(NO_ERROR); if (liDistanceToMove.u.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) { if (lpNewFilePointer) lpNewFilePointer->QuadPart = -1; return FALSE; } if (lpNewFilePointer) lpNewFilePointer->QuadPart = liDistanceToMove.QuadPart; return TRUE; } /** * ntfs_device_win32_init_imports - initialize the function pointers * * The Find*Volume and SetFilePointerEx functions exist only on win2k+, as such * we cannot just staticly import them. * * This function initializes the imports if the functions do exist and in the * SetFilePointerEx case, we emulate the function ourselves if it is not * present. * * Note: The values are cached, do be afraid to run it more than once. */ static void ntfs_device_win32_init_imports(void) { HMODULE kernel32 = GetModuleHandle("kernel32"); if (!kernel32) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("kernel32.dll could not be imported.\n"); } if (!fnSetFilePointerEx) { if (kernel32) fnSetFilePointerEx = (LPFN_SETFILEPOINTEREX) GetProcAddress(kernel32, "SetFilePointerEx"); /* * If we did not get kernel32.dll or it is not Win2k+, emulate * SetFilePointerEx(). */ if (!fnSetFilePointerEx) { ntfs_log_debug("SetFilePointerEx() not found in " "kernel32.dll: Enabling emulation.\n"); fnSetFilePointerEx = libntfs_SetFilePointerEx; } } /* Cannot do lookups if we could not get kernel32.dll... */ if (!kernel32) return; if (!fnFindFirstVolume) fnFindFirstVolume = (LPFN_FINDFIRSTVOLUME) GetProcAddress(kernel32, "FindFirstVolume" FNPOSTFIX); if (!fnFindNextVolume) fnFindNextVolume = (LPFN_FINDNEXTVOLUME) GetProcAddress(kernel32, "FindNextVolume" FNPOSTFIX); if (!fnFindVolumeClose) fnFindVolumeClose = (LPFN_FINDVOLUMECLOSE) GetProcAddress(kernel32, "FindVolumeClose"); } /** * ntfs_device_unix_status_flags_to_win32 - convert unix->win32 open flags * @flags: unix open status flags * * Supported flags are O_RDONLY, O_WRONLY and O_RDWR. */ static __inline__ int ntfs_device_unix_status_flags_to_win32(int flags) { int win_mode; switch (flags & O_ACCMODE) { case O_RDONLY: win_mode = GENERIC_READ; break; case O_WRONLY: win_mode = GENERIC_WRITE; break; case O_RDWR: win_mode = GENERIC_READ | GENERIC_WRITE; break; default: /* error */ ntfs_log_trace("Unknown status flags.\n"); win_mode = 0; } return win_mode; } /** * ntfs_device_win32_simple_open_file - just open a file via win32 API * @filename: name of the file to open * @handle: pointer the a HANDLE in which to put the result * @flags: unix open status flags * @locking: will the function gain an exclusive lock on the file? * * Supported flags are O_RDONLY, O_WRONLY and O_RDWR. * * Return 0 if o.k. * -1 if not, and errno set. In this case handle is trashed. */ static int ntfs_device_win32_simple_open_file(const char *filename, HANDLE *handle, int flags, BOOL locking) { *handle = CreateFile(filename, ntfs_device_unix_status_flags_to_win32(flags), locking ? 0 : (FILE_SHARE_WRITE | FILE_SHARE_READ), NULL, (flags & O_CREAT ? OPEN_ALWAYS : OPEN_EXISTING), 0, NULL); if (*handle == INVALID_HANDLE_VALUE) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("CreateFile(%s) failed.\n", filename); return -1; } return 0; } /** * ntfs_device_win32_lock - lock the volume * @handle: a win32 HANDLE for a volume to lock * * Locking a volume means no one can access its contents. * Exiting the process automatically unlocks the volume, except in old NT4s. * * Return 0 if o.k. * -1 if not, and errno set. */ static int ntfs_device_win32_lock(HANDLE handle) { DWORD i; if (!DeviceIoControl(handle, FSCTL_LOCK_VOLUME, NULL, 0, NULL, 0, &i, NULL)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't lock volume.\n"); return -1; } ntfs_log_debug("Volume locked.\n"); return 0; } /** * ntfs_device_win32_unlock - unlock the volume * @handle: the win32 HANDLE which the volume was locked with * * Return 0 if o.k. * -1 if not, and errno set. */ static int ntfs_device_win32_unlock(HANDLE handle) { DWORD i; if (!DeviceIoControl(handle, FSCTL_UNLOCK_VOLUME, NULL, 0, NULL, 0, &i, NULL)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't unlock volume.\n"); return -1; } ntfs_log_debug("Volume unlocked.\n"); return 0; } static int ntfs_device_win32_setlock(HANDLE handle, ULONG code) { IO_STATUS_BLOCK io_status; NTSTATUS res; io_status.Status = STATUS_SUCCESS; io_status.Information = 0; res = NtFsControlFile(handle,(HANDLE)NULL, (PIO_APC_ROUTINE)NULL,(void*)NULL, &io_status, code, (char*)NULL,0,(char*)NULL,0); if (res != STATUS_SUCCESS) errno = ntfs_ntstatus_to_errno(res); return (res == STATUS_SUCCESS ? 0 : -1); } /** * ntfs_device_win32_dismount - dismount a volume * @handle: a win32 HANDLE for a volume to dismount * * Dismounting means the system will refresh the volume in the first change it * gets. Usefull after altering the file structures. * The volume must be locked by the current process while dismounting. * A side effect is that the volume is also unlocked, but you must not rely om * this. * * Return 0 if o.k. * -1 if not, and errno set. */ static int ntfs_device_win32_dismount(HANDLE handle) { DWORD i; if (!DeviceIoControl(handle, FSCTL_DISMOUNT_VOLUME, NULL, 0, NULL, 0, &i, NULL)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't dismount volume.\n"); return -1; } ntfs_log_debug("Volume dismounted.\n"); return 0; } /** * ntfs_device_win32_getsize - get file size via win32 API * @handle: pointer the file HANDLE obtained via open * * Only works on ordinary files. * * Return The file size if o.k. * -1 if not, and errno set. */ static s64 ntfs_device_win32_getsize(HANDLE handle) { LONG loword, hiword; SetLastError(NO_ERROR); hiword = 0; loword = SetFilePointer(handle, 0, &hiword, 2); if ((loword == INVALID_SET_FILE_POINTER) && (GetLastError() != NO_ERROR)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't get file size.\n"); return -1; } return ((s64)hiword << 32) + (ULONG)loword; } /** * ntfs_device_win32_getdisklength - get disk size via win32 API * @handle: pointer the file HANDLE obtained via open * @argp: pointer to result buffer * * Only works on PhysicalDriveX type handles. * * Return The disk size if o.k. * -1 if not, and errno set. */ static s64 ntfs_device_win32_getdisklength(HANDLE handle) { GET_LENGTH_INFORMATION buf; DWORD i; if (!DeviceIoControl(handle, IOCTL_DISK_GET_LENGTH_INFO, NULL, 0, &buf, sizeof(buf), &i, NULL)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't get disk length.\n"); return -1; } ntfs_log_debug("Disk length: %lld.\n", buf.Length.QuadPart); return buf.Length.QuadPart; } /** * ntfs_device_win32_getntfssize - get NTFS volume size via win32 API * @handle: pointer the file HANDLE obtained via open * @argp: pointer to result buffer * * Only works on NTFS volume handles. * An annoying bug in windows is that an NTFS volume does not occupy the entire * partition, namely not the last sector (which holds the backup boot sector, * and normally not interesting). * Use this function to get the length of the accessible space through a given * volume handle. * * Return The volume size if o.k. * -1 if not, and errno set. */ static s64 ntfs_device_win32_getntfssize(HANDLE handle) { s64 rvl; #ifdef FSCTL_GET_NTFS_VOLUME_DATA DWORD i; NTFS_VOLUME_DATA_BUFFER buf; if (!DeviceIoControl(handle, FSCTL_GET_NTFS_VOLUME_DATA, NULL, 0, &buf, sizeof(buf), &i, NULL)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't get NTFS volume length.\n"); return -1; } rvl = buf.NumberSectors.QuadPart * buf.BytesPerSector; ntfs_log_debug("NTFS volume length: 0x%llx.\n", (long long)rvl); #else errno = EINVAL; rvl = -1; #endif return rvl; } /** * ntfs_device_win32_getgeo - get CHS information of a drive * @handle: an open handle to the PhysicalDevice * @fd: a win_fd structure that will be filled * * Return 0 if o.k. * -1 if not, and errno set. * * In Windows NT+: fills size, sectors, and cylinders and sets heads to -1. * In Windows XP+: fills size, sectors, cylinders, and heads. * * Note: In pre XP, this requires write permission, even though nothing is * actually written. * * If fails, sets sectors, cylinders, heads, and size to -1. */ static int ntfs_device_win32_getgeo(HANDLE handle, win32_fd *fd) { DWORD i; BOOL rvl; BYTE b[sizeof(DISK_GEOMETRY) + sizeof(DISK_PARTITION_INFO) + sizeof(DISK_DETECTION_INFO) + 512]; rvl = DeviceIoControl(handle, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX, NULL, 0, &b, sizeof(b), &i, NULL); if (rvl) { ntfs_log_debug("GET_DRIVE_GEOMETRY_EX detected.\n"); DISK_DETECTION_INFO *ddi = (PDISK_DETECTION_INFO) (((PBYTE)(&((PDISK_GEOMETRY_EX)b)->Data)) + (((PDISK_PARTITION_INFO) (&((PDISK_GEOMETRY_EX)b)->Data))-> SizeOfPartitionInfo)); fd->geo_cylinders = ((DISK_GEOMETRY*)&b)->Cylinders.QuadPart; fd->geo_sectors = ((DISK_GEOMETRY*)&b)->SectorsPerTrack; fd->geo_size = ((DISK_GEOMETRY_EX*)&b)->DiskSize.QuadPart; fd->geo_sector_size = NTFS_BLOCK_SIZE; switch (ddi->DetectionType) { case DetectInt13: fd->geo_cylinders = ddi->Int13.MaxCylinders; fd->geo_sectors = ddi->Int13.SectorsPerTrack; fd->geo_heads = ddi->Int13.MaxHeads; return 0; case DetectExInt13: fd->geo_cylinders = ddi->ExInt13.ExCylinders; fd->geo_sectors = ddi->ExInt13.ExSectorsPerTrack; fd->geo_heads = ddi->ExInt13.ExHeads; return 0; case DetectNone: default: break; } } else fd->geo_heads = -1; rvl = DeviceIoControl(handle, IOCTL_DISK_GET_DRIVE_GEOMETRY, NULL, 0, &b, sizeof(b), &i, NULL); if (rvl) { ntfs_log_debug("GET_DRIVE_GEOMETRY detected.\n"); fd->geo_cylinders = ((DISK_GEOMETRY*)&b)->Cylinders.QuadPart; fd->geo_sectors = ((DISK_GEOMETRY*)&b)->SectorsPerTrack; fd->geo_size = fd->geo_cylinders * fd->geo_sectors * ((DISK_GEOMETRY*)&b)->TracksPerCylinder * ((DISK_GEOMETRY*)&b)->BytesPerSector; fd->geo_sector_size = ((DISK_GEOMETRY*)&b)->BytesPerSector; return 0; } errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("Couldn't retrieve disk geometry.\n"); fd->geo_cylinders = -1; fd->geo_sectors = -1; fd->geo_size = -1; fd->geo_sector_size = NTFS_BLOCK_SIZE; return -1; } static int ntfs_device_win32_getntgeo(HANDLE handle, win32_fd *fd) { DISK_GEOMETRY geo; NTSTATUS st; IO_STATUS_BLOCK status; u64 bytes; int res; res = -1; fd->geo_cylinders = 0; fd->geo_sectors = 0; fd->geo_size = 1073741824; fd->geo_sectors = fd->geo_size >> 9; fd->geo_sector_size = NTFS_BLOCK_SIZE; st = NtDeviceIoControlFile(handle, (HANDLE)NULL, (PIO_APC_ROUTINE)NULL, (void*)NULL, &status, IOCTL_DISK_GET_DRIVE_GEOMETRY, (void*)NULL, 0, (void*)&geo, sizeof(geo)); if (st == STATUS_SUCCESS) { /* over-estimate the (rounded) number of cylinders */ fd->geo_cylinders = geo.Cylinders.QuadPart + 1; fd->geo_sectors = fd->geo_cylinders *geo.TracksPerCylinder*geo.SectorsPerTrack; fd->geo_size = fd->geo_sectors*geo.BytesPerSector; fd->geo_sector_size = geo.BytesPerSector; res = 0; /* try to get the exact sector count */ st = NtDeviceIoControlFile(handle, (HANDLE)NULL, (PIO_APC_ROUTINE)NULL, (void*)NULL, &status, IOCTL_GET_DISK_LENGTH_INFO, (void*)NULL, 0, (void*)&bytes, sizeof(bytes)); if (st == STATUS_SUCCESS) { fd->geo_size = bytes; fd->geo_sectors = bytes/geo.BytesPerSector; } } return (res); } /** * ntfs_device_win32_open_file - open a file via win32 API * @filename: name of the file to open * @fd: pointer to win32 file device in which to put the result * @flags: unix open status flags * * Return 0 if o.k. * -1 if not, and errno set. */ static __inline__ int ntfs_device_win32_open_file(char *filename, win32_fd *fd, int flags) { HANDLE handle; int mode; if (ntfs_device_win32_simple_open_file(filename, &handle, flags, FALSE)) { /* open error */ return -1; } mode = flags & O_ACCMODE; if ((mode == O_RDWR) || (mode == O_WRONLY)) { DWORD bytes; /* try making sparse (but ignore errors) */ DeviceIoControl(handle, FSCTL_SET_SPARSE, (void*)NULL, 0, (void*)NULL, 0, &bytes, (LPOVERLAPPED)NULL); } /* fill fd */ fd->handle = handle; fd->part_start = 0; fd->part_length = ntfs_device_win32_getsize(handle); fd->pos = 0; fd->part_hidden_sectors = -1; fd->geo_size = -1; /* used as a marker that this is a file */ fd->vol_handle = INVALID_HANDLE_VALUE; fd->geo_sector_size = 512; /* will be adjusted from the boot sector */ fd->ntdll = FALSE; return 0; } /** * ntfs_device_win32_open_drive - open a drive via win32 API * @drive_id: drive to open * @fd: pointer to win32 file device in which to put the result * @flags: unix open status flags * * return 0 if o.k. * -1 if not, and errno set. */ static __inline__ int ntfs_device_win32_open_drive(int drive_id, win32_fd *fd, int flags) { HANDLE handle; int err; char filename[MAX_PATH]; sprintf(filename, "\\\\.\\PhysicalDrive%d", drive_id); if ((err = ntfs_device_win32_simple_open_file(filename, &handle, flags, TRUE))) { /* open error */ return err; } /* store the drive geometry */ ntfs_device_win32_getgeo(handle, fd); /* Just to be sure */ if (fd->geo_size == -1) fd->geo_size = ntfs_device_win32_getdisklength(handle); /* fill fd */ fd->ntdll = FALSE; fd->handle = handle; fd->part_start = 0; fd->part_length = fd->geo_size; fd->pos = 0; fd->part_hidden_sectors = -1; fd->vol_handle = INVALID_HANDLE_VALUE; return 0; } /** * ntfs_device_win32_open_lowlevel - open a drive via low level win32 API * @drive_id: drive to open * @fd: pointer to win32 file device in which to put the result * @flags: unix open status flags * * return 0 if o.k. * -1 if not, and errno set. */ static __inline__ int ntfs_device_win32_open_lowlevel(int drive_id, win32_fd *fd, int flags) { HANDLE handle; NTSTATUS st; ACCESS_MASK access; ULONG share; OBJECT_ATTRIBUTES attr; IO_STATUS_BLOCK io_status; UNICODE_STRING unicode_name; ntfschar unicode_buffer[7]; int mode; static const ntfschar unicode_init[] = { const_cpu_to_le16('\\'), const_cpu_to_le16('?'), const_cpu_to_le16('?'), const_cpu_to_le16('\\'), const_cpu_to_le16(' '), const_cpu_to_le16(':'), const_cpu_to_le16(0) }; memcpy(unicode_buffer, unicode_init, sizeof(unicode_buffer)); unicode_buffer[4] = cpu_to_le16(drive_id + 'A'); unicode_name.Buffer = unicode_buffer; unicode_name.Length = 6*sizeof(ntfschar); unicode_name.MaximumLength = 6*sizeof(ntfschar); attr.Length = sizeof(OBJECT_ATTRIBUTES); attr.RootDirectory = (HANDLE*)NULL; attr.ObjectName = &unicode_name; attr.Attributes = OBJ_CASE_INSENSITIVE; attr.SecurityDescriptor = (void*)NULL; attr.SecurityQualityOfService = (void*)NULL; io_status.Status = 0; io_status.Information = 0; mode = flags & O_ACCMODE; share = (mode == O_RDWR ? 0 : FILE_SHARE_READ | FILE_SHARE_WRITE); access = (mode == O_RDWR ? FILE_READ_DATA | FILE_WRITE_DATA | SYNCHRONIZE : FILE_READ_DATA | SYNCHRONIZE); st = NtOpenFile(&handle, access, &attr, &io_status, share, FILE_SYNCHRONOUS_IO_ALERT); if (st != STATUS_SUCCESS) { errno = ntfs_ntstatus_to_errno(st); return (-1); } ntfs_device_win32_setlock(handle,FSCTL_LOCK_VOLUME); /* store the drive geometry */ ntfs_device_win32_getntgeo(handle, fd); fd->ntdll = TRUE; /* allow accessing the full partition */ st = NtFsControlFile(handle, (HANDLE)NULL, (PIO_APC_ROUTINE)NULL, (PVOID)NULL, &io_status, FSCTL_ALLOW_EXTENDED_DASD_IO, NULL, 0, NULL, 0); if (st != STATUS_SUCCESS) { errno = ntfs_ntstatus_to_errno(st); NtClose(handle); return (-1); } /* fill fd */ fd->handle = handle; fd->part_start = 0; fd->part_length = fd->geo_size; fd->pos = 0; fd->part_hidden_sectors = -1; fd->vol_handle = INVALID_HANDLE_VALUE; return 0; } /** * ntfs_device_win32_open_volume_for_partition - find and open a volume * * Windows NT/2k/XP handles volumes instead of partitions. * This function gets the partition details and return an open volume handle. * That volume is the one whose only physical location on disk is the described * partition. * * The function required Windows 2k/XP, otherwise it fails (gracefully). * * Return success: a valid open volume handle. * fail : INVALID_HANDLE_VALUE */ static HANDLE ntfs_device_win32_open_volume_for_partition(unsigned int drive_id, s64 part_offset, s64 part_length, int flags) { HANDLE vol_find_handle; TCHAR vol_name[MAX_PATH]; /* Make sure all the required imports exist. */ if (!fnFindFirstVolume || !fnFindNextVolume || !fnFindVolumeClose) { ntfs_log_trace("Required dll imports not found.\n"); return INVALID_HANDLE_VALUE; } /* Start iterating through volumes. */ ntfs_log_trace("Entering with drive_id=%d, part_offset=%lld, " "path_length=%lld, flags=%d.\n", drive_id, (unsigned long long)part_offset, (unsigned long long)part_length, flags); vol_find_handle = fnFindFirstVolume(vol_name, MAX_PATH); /* If a valid handle could not be aquired, reply with "don't know". */ if (vol_find_handle == INVALID_HANDLE_VALUE) { ntfs_log_trace("FindFirstVolume failed.\n"); return INVALID_HANDLE_VALUE; } do { int vol_name_length; HANDLE handle; /* remove trailing '/' from vol_name */ #ifdef UNICODE vol_name_length = wcslen(vol_name); #else vol_name_length = strlen(vol_name); #endif if (vol_name_length>0) vol_name[vol_name_length-1]=0; ntfs_log_debug("Processing %s.\n", vol_name); /* open the file */ handle = CreateFile(vol_name, ntfs_device_unix_status_flags_to_win32(flags), FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL); if (handle != INVALID_HANDLE_VALUE) { DWORD bytesReturned; #define EXTENTS_SIZE sizeof(VOLUME_DISK_EXTENTS) + 9 * sizeof(DISK_EXTENT) char extents[EXTENTS_SIZE]; /* Check physical locations. */ if (DeviceIoControl(handle, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL, 0, extents, EXTENTS_SIZE, &bytesReturned, NULL)) { if (((VOLUME_DISK_EXTENTS *)extents)-> NumberOfDiskExtents == 1) { DISK_EXTENT *extent = &(( VOLUME_DISK_EXTENTS *) extents)->Extents[0]; if ((extent->DiskNumber==drive_id) && (extent->StartingOffset. QuadPart==part_offset) && (extent-> ExtentLength.QuadPart == part_length)) { /* * Eureka! (Archimedes, 287 BC, * "I have found it!") */ fnFindVolumeClose( vol_find_handle); return handle; } } } } else ntfs_log_trace("getExtents() Failed.\n"); } while (fnFindNextVolume(vol_find_handle, vol_name, MAX_PATH)); /* End of iteration through volumes. */ ntfs_log_trace("Closing, volume was not found.\n"); fnFindVolumeClose(vol_find_handle); return INVALID_HANDLE_VALUE; } /** * ntfs_device_win32_find_partition - locates partition details by id. * @handle: HANDLE to the PhysicalDrive * @partition_id: the partition number to locate * @part_offset: pointer to where to put the offset to the partition * @part_length: pointer to where to put the length of the partition * @hidden_sectors: pointer to where to put the hidden sectors * * This function requires an open PhysicalDrive handle and a partition_id. * If a partition with the required id is found on the supplied device, * the partition attributes are returned back. * * Returns: TRUE if found, and sets the output parameters. * FALSE if not and errno is set to the error code. */ static BOOL ntfs_device_win32_find_partition(HANDLE handle, DWORD partition_id, s64 *part_offset, s64 *part_length, int *hidden_sectors) { DRIVE_LAYOUT_INFORMATION *drive_layout; unsigned int err, buf_size, part_count; DWORD i; /* * There is no way to know the required buffer, so if the ioctl fails, * try doubling the buffer size each time until the ioctl succeeds. */ part_count = 8; do { buf_size = sizeof(DRIVE_LAYOUT_INFORMATION) + part_count * sizeof(PARTITION_INFORMATION); drive_layout = (DRIVE_LAYOUT_INFORMATION*)ntfs_malloc(buf_size); if (!drive_layout) { errno = ENOMEM; return FALSE; } if (DeviceIoControl(handle, IOCTL_DISK_GET_DRIVE_LAYOUT, NULL, 0, (BYTE*)drive_layout, buf_size, &i, NULL)) break; err = GetLastError(); free(drive_layout); if (err != ERROR_INSUFFICIENT_BUFFER) { ntfs_log_trace("GetDriveLayout failed.\n"); errno = ntfs_w32error_to_errno(err); return FALSE; } ntfs_log_debug("More than %u partitions.\n", part_count); part_count <<= 1; if (part_count > 512) { ntfs_log_trace("GetDriveLayout failed: More than 512 " "partitions?\n"); errno = ENOBUFS; return FALSE; } } while (1); for (i = 0; i < drive_layout->PartitionCount; i++) { if (drive_layout->PartitionEntry[i].PartitionNumber == partition_id) { *part_offset = drive_layout->PartitionEntry[i]. StartingOffset.QuadPart; *part_length = drive_layout->PartitionEntry[i]. PartitionLength.QuadPart; *hidden_sectors = drive_layout->PartitionEntry[i]. HiddenSectors; free(drive_layout); return TRUE; } } free(drive_layout); errno = ENOENT; return FALSE; } /** * ntfs_device_win32_open_partition - open a partition via win32 API * @drive_id: drive to open * @partition_id: partition to open * @fd: win32 file device to return * @flags: unix open status flags * * Return 0 if o.k. * -1 if not, and errno set. * * When fails, fd contents may have not been preserved. */ static int ntfs_device_win32_open_partition(int drive_id, unsigned int partition_id, win32_fd *fd, int flags) { s64 part_start, part_length; HANDLE handle; int err, hidden_sectors; char drive_name[MAX_PATH]; sprintf(drive_name, "\\\\.\\PhysicalDrive%d", drive_id); /* Open the entire device without locking, ask questions later */ if ((err = ntfs_device_win32_simple_open_file(drive_name, &handle, flags, FALSE))) { /* error */ return err; } if (ntfs_device_win32_find_partition(handle, partition_id, &part_start, &part_length, &hidden_sectors)) { s64 tmp; HANDLE vol_handle = ntfs_device_win32_open_volume_for_partition( drive_id, part_start, part_length, flags); /* Store the drive geometry. */ ntfs_device_win32_getgeo(handle, fd); fd->handle = handle; fd->pos = 0; fd->part_start = part_start; fd->part_length = part_length; fd->part_hidden_sectors = hidden_sectors; fd->geo_sector_size = 512; fd->ntdll = FALSE; tmp = ntfs_device_win32_getntfssize(vol_handle); if (tmp > 0) fd->geo_size = tmp; else fd->geo_size = fd->part_length; if (vol_handle != INVALID_HANDLE_VALUE) { if (((flags & O_RDWR) == O_RDWR) && ntfs_device_win32_lock(vol_handle)) { CloseHandle(vol_handle); CloseHandle(handle); return -1; } fd->vol_handle = vol_handle; } else { if ((flags & O_RDWR) == O_RDWR) { /* Access if read-write, no volume found. */ ntfs_log_trace("Partitions containing Spanned/" "Mirrored volumes are not " "supported in R/W status " "yet.\n"); CloseHandle(handle); errno = EOPNOTSUPP; return -1; } fd->vol_handle = INVALID_HANDLE_VALUE; } return 0; } else { ntfs_log_debug("Partition %u not found on drive %d.\n", partition_id, drive_id); CloseHandle(handle); errno = ENODEV; return -1; } } /** * ntfs_device_win32_open - open a device * @dev: a pointer to the NTFS_DEVICE to open * @flags: unix open status flags * * @dev->d_name must hold the device name, the rest is ignored. * Supported flags are O_RDONLY, O_WRONLY and O_RDWR. * * If name is in format "(hd[0-9],[0-9])" then open a partition. * If name is in format "(hd[0-9])" then open a volume. * Otherwise open a file. */ static int ntfs_device_win32_open(struct ntfs_device *dev, int flags) { int drive_id = 0, numparams; unsigned int part = 0; char drive_char; win32_fd fd; int err; if (NDevOpen(dev)) { errno = EBUSY; return -1; } ntfs_device_win32_init_imports(); numparams = sscanf(dev->d_name, "/dev/hd%c%u", &drive_char, &part); if (!numparams && (dev->d_name[1] == ':') && (dev->d_name[2] == '\0')) { drive_char = dev->d_name[0]; numparams = 3; drive_id = toupper(drive_char) - 'A'; } switch (numparams) { case 0: ntfs_log_debug("win32_open(%s) -> file.\n", dev->d_name); err = ntfs_device_win32_open_file(dev->d_name, &fd, flags); break; case 1: ntfs_log_debug("win32_open(%s) -> drive %d.\n", dev->d_name, drive_id); err = ntfs_device_win32_open_drive(drive_id, &fd, flags); break; case 2: ntfs_log_debug("win32_open(%s) -> drive %d, part %u.\n", dev->d_name, drive_id, part); err = ntfs_device_win32_open_partition(drive_id, part, &fd, flags); break; case 3: ntfs_log_debug("win32_open(%s) -> drive %c:\n", dev->d_name, drive_char); err = ntfs_device_win32_open_lowlevel(drive_id, &fd, flags); break; default: ntfs_log_debug("win32_open(%s) -> unknwon file format.\n", dev->d_name); err = -1; } if (err) return err; ntfs_log_debug("win32_open(%s) -> %p, offset 0x%llx.\n", dev->d_name, dev, fd.part_start); /* Setup our read-only flag. */ if ((flags & O_RDWR) != O_RDWR) NDevSetReadOnly(dev); dev->d_private = (win32_fd*)ntfs_malloc(sizeof(win32_fd)); memcpy(dev->d_private, &fd, sizeof(win32_fd)); NDevSetOpen(dev); NDevClearDirty(dev); return 0; } /** * ntfs_device_win32_seek - change current logical file position * @dev: ntfs device obtained via ->open * @offset: required offset from the whence anchor * @whence: whence anchor specifying what @offset is relative to * * Return the new position on the volume on success and -1 on error with errno * set to the error code. * * @whence may be one of the following: * SEEK_SET - Offset is relative to file start. * SEEK_CUR - Offset is relative to current position. * SEEK_END - Offset is relative to end of file. */ static s64 ntfs_device_win32_seek(struct ntfs_device *dev, s64 offset, int whence) { s64 abs_ofs; win32_fd *fd = (win32_fd *)dev->d_private; ntfs_log_trace("seek offset = 0x%llx, whence = %d.\n", offset, whence); switch (whence) { case SEEK_SET: abs_ofs = offset; break; case SEEK_CUR: abs_ofs = fd->pos + offset; break; case SEEK_END: /* End of partition != end of disk. */ if (fd->part_length == -1) { ntfs_log_trace("Position relative to end of disk not " "implemented.\n"); errno = EOPNOTSUPP; return -1; } abs_ofs = fd->part_length + offset; break; default: ntfs_log_trace("Wrong mode %d.\n", whence); errno = EINVAL; return -1; } if ((abs_ofs < 0) || (fd->ntdll && (abs_ofs > fd->part_length))) { ntfs_log_trace("Seeking outsize seekable area.\n"); errno = EINVAL; return -1; } fd->pos = abs_ofs; return abs_ofs; } /** * ntfs_device_win32_pio - positioned low level i/o * @fd: win32 device descriptor obtained via ->open * @pos: at which position to do i/o from/to * @count: how many bytes should be transfered * @b: source/destination buffer * @write: TRUE if write transfer and FALSE if read transfer * * On success returns the number of bytes transfered (can be < @count) and on * error returns -1 and errno set. Transfer starts from position @pos on @fd. * * Notes: * - @pos, @buf, and @count must be aligned to geo_sector_size * - When dealing with volumes, a single call must not span both volume * and disk extents. * - Does not use/set @fd->pos. */ static s64 ntfs_device_win32_pio(win32_fd *fd, const s64 pos, const s64 count, void *rbuf, const void *wbuf) { LARGE_INTEGER li; HANDLE handle; DWORD bt; BOOL res; s64 bytes; ntfs_log_trace("pos = 0x%llx, count = 0x%llx, direction = %s.\n", (long long)pos, (long long)count, write ? "write" : "read"); li.QuadPart = pos; if (fd->vol_handle != INVALID_HANDLE_VALUE && pos < fd->geo_size) { ntfs_log_debug("Transfering via vol_handle.\n"); handle = fd->vol_handle; } else { ntfs_log_debug("Transfering via handle.\n"); handle = fd->handle; li.QuadPart += fd->part_start; } if (fd->ntdll) { IO_STATUS_BLOCK io_status; NTSTATUS res; LARGE_INTEGER offset; io_status.Status = STATUS_SUCCESS; io_status.Information = 0; offset.QuadPart = pos; if (wbuf) { res = NtWriteFile(fd->handle,(HANDLE)NULL, (PIO_APC_ROUTINE)NULL,(void*)NULL, &io_status, wbuf, count, &offset, (PULONG)NULL); } else { res = NtReadFile(fd->handle,(HANDLE)NULL, (PIO_APC_ROUTINE)NULL,(void*)NULL, &io_status, rbuf, count, &offset, (PULONG)NULL); } if (res == STATUS_SUCCESS) { bytes = io_status.Information; } else { bytes = -1; errno = ntfs_ntstatus_to_errno(res); } } else { if (!fnSetFilePointerEx(handle, li, NULL, FILE_BEGIN)) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("SetFilePointer failed.\n"); return -1; } if (wbuf) res = WriteFile(handle, wbuf, count, &bt, NULL); else res = ReadFile(handle, rbuf, count, &bt, NULL); bytes = bt; if (!res) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("%sFile() failed.\n", write ? "Write" : "Read"); return -1; } if (rbuf && !pos) { /* get the sector size from the boot sector */ char *boot = (char*)rbuf; fd->geo_sector_size = (boot[11] & 255) + ((boot[12] & 255) << 8); } } return bytes; } /** * ntfs_device_win32_pread_simple - positioned simple read * @fd: win32 device descriptor obtained via ->open * @pos: at which position to read from * @count: how many bytes should be read * @b: a pointer to where to put the contents * * On success returns the number of bytes read (can be < @count) and on error * returns -1 and errno set. Read starts from position @pos. * * Notes: * - @pos, @buf, and @count must be aligned to geo_sector_size. * - When dealing with volumes, a single call must not span both volume * and disk extents. * - Does not use/set @fd->pos. */ static inline s64 ntfs_device_win32_pread_simple(win32_fd *fd, const s64 pos, const s64 count, void *b) { return ntfs_device_win32_pio(fd, pos, count, b, (void*)NULL); } /** * ntfs_device_win32_read - read bytes from an ntfs device * @dev: ntfs device obtained via ->open * @b: pointer to where to put the contents * @count: how many bytes should be read * * On success returns the number of bytes actually read (can be < @count). * On error returns -1 with errno set. */ static s64 ntfs_device_win32_read(struct ntfs_device *dev, void *b, s64 count) { s64 old_pos, to_read, i, br = 0; win32_fd *fd = (win32_fd *)dev->d_private; BYTE *alignedbuffer; int old_ofs, ofs; old_pos = fd->pos; old_ofs = ofs = old_pos & (fd->geo_sector_size - 1); to_read = (ofs + count + fd->geo_sector_size - 1) & ~(s64)(fd->geo_sector_size - 1); /* Impose maximum of 2GB to be on the safe side. */ if (to_read > 0x80000000) { int delta = to_read - count; to_read = 0x80000000; count = to_read - delta; } ntfs_log_trace("fd = %p, b = %p, count = 0x%llx, pos = 0x%llx, " "ofs = %i, to_read = 0x%llx.\n", fd, b, (long long)count, (long long)old_pos, ofs, (long long)to_read); if (!((unsigned long)b & (fd->geo_sector_size - 1)) && !old_ofs && !(count & (fd->geo_sector_size - 1))) alignedbuffer = b; else { alignedbuffer = (BYTE *)VirtualAlloc(NULL, to_read, MEM_COMMIT, PAGE_READWRITE); if (!alignedbuffer) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("VirtualAlloc failed for read.\n"); return -1; } } if (fd->vol_handle != INVALID_HANDLE_VALUE && old_pos < fd->geo_size) { s64 vol_to_read = fd->geo_size - old_pos; if (count > vol_to_read) { br = ntfs_device_win32_pread_simple(fd, old_pos & ~(s64)(fd->geo_sector_size - 1), ofs + vol_to_read, alignedbuffer); if (br == -1) goto read_error; to_read -= br; if (br < ofs) { br = 0; goto read_partial; } br -= ofs; fd->pos += br; ofs = fd->pos & (fd->geo_sector_size - 1); if (br != vol_to_read) goto read_partial; } } i = ntfs_device_win32_pread_simple(fd, fd->pos & ~(s64)(fd->geo_sector_size - 1), to_read, alignedbuffer + br); if (i == -1) { if (br) goto read_partial; goto read_error; } if (i < ofs) goto read_partial; i -= ofs; br += i; if (br > count) br = count; fd->pos = old_pos + br; read_partial: if (alignedbuffer != b) { memcpy((void*)b, alignedbuffer + old_ofs, br); VirtualFree(alignedbuffer, 0, MEM_RELEASE); } return br; read_error: if (alignedbuffer != b) VirtualFree(alignedbuffer, 0, MEM_RELEASE); return -1; } /** * ntfs_device_win32_close - close an open ntfs deivce * @dev: ntfs device obtained via ->open * * Return 0 if o.k. * -1 if not, and errno set. Note if error fd->vol_handle is trashed. */ static int ntfs_device_win32_close(struct ntfs_device *dev) { win32_fd *fd = (win32_fd *)dev->d_private; BOOL rvl; ntfs_log_trace("Closing device %p.\n", dev); if (!NDevOpen(dev)) { errno = EBADF; return -1; } if (fd->vol_handle != INVALID_HANDLE_VALUE) { if (!NDevReadOnly(dev)) { ntfs_device_win32_dismount(fd->vol_handle); ntfs_device_win32_unlock(fd->vol_handle); } if (!CloseHandle(fd->vol_handle)) ntfs_log_trace("CloseHandle() failed for volume.\n"); } if (fd->ntdll) { ntfs_device_win32_setlock(fd->handle,FSCTL_UNLOCK_VOLUME); rvl = NtClose(fd->handle) == STATUS_SUCCESS; } else rvl = CloseHandle(fd->handle); NDevClearOpen(dev); free(fd); if (!rvl) { errno = ntfs_w32error_to_errno(GetLastError()); if (fd->ntdll) ntfs_log_trace("NtClose() failed.\n"); else ntfs_log_trace("CloseHandle() failed.\n"); return -1; } return 0; } /** * ntfs_device_win32_sync - flush write buffers to disk * @dev: ntfs device obtained via ->open * * Return 0 if o.k. * -1 if not, and errno set. * * Note: Volume syncing works differently in windows. * Disk cannot be synced in windows. */ static int ntfs_device_win32_sync(struct ntfs_device *dev) { int err = 0; BOOL to_clear = TRUE; if (!NDevReadOnly(dev) && NDevDirty(dev)) { win32_fd *fd = (win32_fd *)dev->d_private; if ((fd->vol_handle != INVALID_HANDLE_VALUE) && !FlushFileBuffers(fd->vol_handle)) { to_clear = FALSE; err = ntfs_w32error_to_errno(GetLastError()); } if (!FlushFileBuffers(fd->handle)) { to_clear = FALSE; if (!err) err = ntfs_w32error_to_errno(GetLastError()); } if (!to_clear) { ntfs_log_trace("Could not sync.\n"); errno = err; return -1; } NDevClearDirty(dev); } return 0; } /** * ntfs_device_win32_pwrite_simple - positioned simple write * @fd: win32 device descriptor obtained via ->open * @pos: at which position to write to * @count: how many bytes should be written * @b: a pointer to the data to write * * On success returns the number of bytes written and on error returns -1 and * errno set. Write starts from position @pos. * * Notes: * - @pos, @buf, and @count must be aligned to geo_sector_size. * - When dealing with volumes, a single call must not span both volume * and disk extents. * - Does not use/set @fd->pos. */ static inline s64 ntfs_device_win32_pwrite_simple(win32_fd *fd, const s64 pos, const s64 count, const void *b) { return ntfs_device_win32_pio(fd, pos, count, (void*)NULL, b); } /** * ntfs_device_win32_write - write bytes to an ntfs device * @dev: ntfs device obtained via ->open * @b: pointer to the data to write * @count: how many bytes should be written * * On success returns the number of bytes actually written. * On error returns -1 with errno set. */ static s64 ntfs_device_win32_write(struct ntfs_device *dev, const void *b, s64 count) { s64 old_pos, to_write, i, bw = 0; win32_fd *fd = (win32_fd *)dev->d_private; const BYTE *alignedbuffer; BYTE *readbuffer; int old_ofs, ofs; old_pos = fd->pos; old_ofs = ofs = old_pos & (fd->geo_sector_size - 1); to_write = (ofs + count + fd->geo_sector_size - 1) & ~(s64)(fd->geo_sector_size - 1); /* Impose maximum of 2GB to be on the safe side. */ if (to_write > 0x80000000) { int delta = to_write - count; to_write = 0x80000000; count = to_write - delta; } ntfs_log_trace("fd = %p, b = %p, count = 0x%llx, pos = 0x%llx, " "ofs = %i, to_write = 0x%llx.\n", fd, b, (long long)count, (long long)old_pos, ofs, (long long)to_write); if (NDevReadOnly(dev)) { ntfs_log_trace("Can't write on a R/O device.\n"); errno = EROFS; return -1; } if (!count) return 0; NDevSetDirty(dev); readbuffer = (BYTE*)NULL; if (!((unsigned long)b & (fd->geo_sector_size - 1)) && !old_ofs && !(count & (fd->geo_sector_size - 1))) alignedbuffer = (const BYTE *)b; else { s64 end; readbuffer = (BYTE *)VirtualAlloc(NULL, to_write, MEM_COMMIT, PAGE_READWRITE); if (!readbuffer) { errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("VirtualAlloc failed for write.\n"); return -1; } /* Read first sector if start of write not sector aligned. */ if (ofs) { i = ntfs_device_win32_pread_simple(fd, old_pos & ~(s64)(fd->geo_sector_size - 1), fd->geo_sector_size, readbuffer); if (i != fd->geo_sector_size) { if (i >= 0) errno = EIO; goto write_error; } } /* * Read last sector if end of write not sector aligned and last * sector is either not the same as the first sector or it is * the same as the first sector but this has not been read in * yet, i.e. the start of the write is sector aligned. */ end = old_pos + count; if ((end & (fd->geo_sector_size - 1)) && ((to_write > fd->geo_sector_size) || !ofs)) { i = ntfs_device_win32_pread_simple(fd, end & ~(s64)(fd->geo_sector_size - 1), fd->geo_sector_size, readbuffer + to_write - fd->geo_sector_size); if (i != fd->geo_sector_size) { if (i >= 0) errno = EIO; goto write_error; } } /* Copy the data to be written into @readbuffer. */ memcpy(readbuffer + ofs, b, count); alignedbuffer = readbuffer; } if (fd->vol_handle != INVALID_HANDLE_VALUE && old_pos < fd->geo_size) { s64 vol_to_write = fd->geo_size - old_pos; if (count > vol_to_write) { bw = ntfs_device_win32_pwrite_simple(fd, old_pos & ~(s64)(fd->geo_sector_size - 1), ofs + vol_to_write, alignedbuffer); if (bw == -1) goto write_error; to_write -= bw; if (bw < ofs) { bw = 0; goto write_partial; } bw -= ofs; fd->pos += bw; ofs = fd->pos & (fd->geo_sector_size - 1); if (bw != vol_to_write) goto write_partial; } } i = ntfs_device_win32_pwrite_simple(fd, fd->pos & ~(s64)(fd->geo_sector_size - 1), to_write, alignedbuffer + bw); if (i == -1) { if (bw) goto write_partial; goto write_error; } if (i < ofs) goto write_partial; i -= ofs; bw += i; if (bw > count) bw = count; fd->pos = old_pos + bw; write_partial: if (readbuffer) VirtualFree(readbuffer, 0, MEM_RELEASE); return bw; write_error: bw = -1; goto write_partial; } /** * ntfs_device_win32_stat - get a unix-like stat structure for an ntfs device * @dev: ntfs device obtained via ->open * @buf: pointer to the stat structure to fill * * Note: Only st_mode, st_size, and st_blocks are filled. * * Return 0 if o.k. * -1 if not and errno set. in this case handle is trashed. */ static int ntfs_device_win32_stat(struct ntfs_device *dev, struct stat *buf) { win32_fd *fd = (win32_fd *)dev->d_private; mode_t st_mode; if ((dev->d_name[1] == ':') && (dev->d_name[2] == '\0')) st_mode = S_IFBLK; else switch (GetFileType(fd->handle)) { case FILE_TYPE_CHAR: st_mode = S_IFCHR; break; case FILE_TYPE_DISK: st_mode = S_IFREG; break; case FILE_TYPE_PIPE: st_mode = S_IFIFO; break; default: st_mode = 0; } memset(buf, 0, sizeof(struct stat)); buf->st_mode = st_mode; buf->st_size = fd->part_length; if (buf->st_size != -1) buf->st_blocks = buf->st_size >> 9; else buf->st_size = 0; return 0; } #ifdef HDIO_GETGEO /** * ntfs_win32_hdio_getgeo - get drive geometry * @dev: ntfs device obtained via ->open * @argp: pointer to where to put the output * * Note: Works on windows NT/2k/XP only. * * Return 0 if o.k. * -1 if not, and errno set. Note if error fd->handle is trashed. */ static __inline__ int ntfs_win32_hdio_getgeo(struct ntfs_device *dev, struct hd_geometry *argp) { win32_fd *fd = (win32_fd *)dev->d_private; argp->heads = fd->geo_heads; argp->sectors = fd->geo_sectors; argp->cylinders = fd->geo_cylinders; argp->start = fd->part_hidden_sectors; return 0; } #endif /** * ntfs_win32_blksszget - get block device sector size * @dev: ntfs device obtained via ->open * @argp: pointer to where to put the output * * Note: Works on windows NT/2k/XP only. * * Return 0 if o.k. * -1 if not, and errno set. Note if error fd->handle is trashed. */ static __inline__ int ntfs_win32_blksszget(struct ntfs_device *dev,int *argp) { win32_fd *fd = (win32_fd *)dev->d_private; DWORD bytesReturned; DISK_GEOMETRY dg; if (DeviceIoControl(fd->handle, IOCTL_DISK_GET_DRIVE_GEOMETRY, NULL, 0, &dg, sizeof(DISK_GEOMETRY), &bytesReturned, NULL)) { /* success */ *argp = dg.BytesPerSector; return 0; } errno = ntfs_w32error_to_errno(GetLastError()); ntfs_log_trace("GET_DRIVE_GEOMETRY failed.\n"); return -1; } static int ntfs_device_win32_ioctl(struct ntfs_device *dev, unsigned long request, void *argp) { #if defined(BLKGETSIZE) | defined(BLKGETSIZE64) win32_fd *fd = (win32_fd *)dev->d_private; #endif ntfs_log_trace("win32_ioctl(0x%lx) called.\n", request); switch (request) { #if defined(BLKGETSIZE) case BLKGETSIZE: ntfs_log_debug("BLKGETSIZE detected.\n"); if (fd->part_length >= 0) { *(int *)argp = (int)(fd->part_length / 512); return 0; } errno = EOPNOTSUPP; return -1; #endif #if defined(BLKGETSIZE64) case BLKGETSIZE64: ntfs_log_debug("BLKGETSIZE64 detected.\n"); if (fd->part_length >= 0) { *(s64 *)argp = fd->part_length; return 0; } errno = EOPNOTSUPP; return -1; #endif #ifdef HDIO_GETGEO case HDIO_GETGEO: ntfs_log_debug("HDIO_GETGEO detected.\n"); return ntfs_win32_hdio_getgeo(dev, (struct hd_geometry *)argp); #endif #ifdef BLKSSZGET case BLKSSZGET: ntfs_log_debug("BLKSSZGET detected.\n"); if (fd && !fd->ntdll) { *(int*)argp = fd->geo_sector_size; return (0); } else return ntfs_win32_blksszget(dev, (int *)argp); #endif #ifdef BLKBSZSET case BLKBSZSET: ntfs_log_debug("BLKBSZSET detected.\n"); /* Nothing to do on Windows. */ return 0; #endif default: ntfs_log_debug("unimplemented ioctl 0x%lx.\n", request); errno = EOPNOTSUPP; return -1; } } static s64 ntfs_device_win32_pread(struct ntfs_device *dev, void *b, s64 count, s64 offset) { s64 got; win32_fd *fd; /* read the fast way if sector aligned */ fd = (win32_fd*)dev->d_private; if (!((count | offset) & (fd->geo_sector_size - 1))) { got = ntfs_device_win32_pio(fd, offset, count, b, (void*)NULL); } else { if (ntfs_device_win32_seek(dev, offset, 0) == -1) got = 0; else got = ntfs_device_win32_read(dev, b, count); } return (got); } static s64 ntfs_device_win32_pwrite(struct ntfs_device *dev, const void *b, s64 count, s64 offset) { s64 put; win32_fd *fd; /* write the fast way if sector aligned */ fd = (win32_fd*)dev->d_private; if (!((count | offset) & (fd->geo_sector_size - 1))) { put = ntfs_device_win32_pio(fd, offset, count, (void*)NULL, b); } else { if (ntfs_device_win32_seek(dev, offset, 0) == -1) put = 0; else put = ntfs_device_win32_write(dev, b, count); } return (put); } struct ntfs_device_operations ntfs_device_win32_io_ops = { .open = ntfs_device_win32_open, .close = ntfs_device_win32_close, .seek = ntfs_device_win32_seek, .read = ntfs_device_win32_read, .write = ntfs_device_win32_write, .pread = ntfs_device_win32_pread, .pwrite = ntfs_device_win32_pwrite, .sync = ntfs_device_win32_sync, .stat = ntfs_device_win32_stat, .ioctl = ntfs_device_win32_ioctl }; /* * Mark an open file as sparse * * This is only called by ntfsclone when cloning a volume to a file. * The argument is the target file, not a volume. * * Returns 0 if successful. */ int ntfs_win32_set_sparse(int fd) { BOOL ok; HANDLE handle; DWORD bytes; handle = get_osfhandle(fd); if (handle == INVALID_HANDLE_VALUE) ok = FALSE; else ok = DeviceIoControl(handle, FSCTL_SET_SPARSE, (void*)NULL, 0, (void*)NULL, 0, &bytes, (LPOVERLAPPED)NULL); return (!ok); } /* * Resize an open file * * This is only called by ntfsclone when cloning a volume to a file. * The argument must designate a file, not a volume. * * Returns 0 if successful. */ static int win32_ftruncate(HANDLE handle, s64 size) { BOOL ok; LONG hsize, lsize; LONG ohsize, olsize; if (handle == INVALID_HANDLE_VALUE) ok = FALSE; else { SetLastError(NO_ERROR); /* save original position */ ohsize = 0; olsize = SetFilePointer(handle, 0, &ohsize, 1); hsize = size >> 32; lsize = size & 0xffffffff; ok = (SetFilePointer(handle, lsize, &hsize, 0) == (DWORD)lsize) && (GetLastError() == NO_ERROR) && SetEndOfFile(handle); /* restore original position, even if above failed */ SetFilePointer(handle, olsize, &ohsize, 0); if (GetLastError() != NO_ERROR) ok = FALSE; } if (!ok) errno = EINVAL; return (ok ? 0 : -1); } int ntfs_device_win32_ftruncate(struct ntfs_device *dev, s64 size) { win32_fd *fd; int ret; ret = -1; fd = (win32_fd*)dev->d_private; if (fd && !fd->ntdll) ret = win32_ftruncate(fd->handle, size); return (ret); } int ntfs_win32_ftruncate(int fd, s64 size) { int ret; HANDLE handle; handle = get_osfhandle(fd); ret = win32_ftruncate(handle, size); return (ret); } ntfsprogs-plus-1.0.0/libntfs/xattrs.c000066400000000000000000000464241507404161300176630ustar00rootroot00000000000000/** * xattrs.c : common functions to deal with system extended attributes * * Copyright (c) 2010-2014 Jean-Pierre Andre * * This program/include file 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/include file 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include "types.h" #include "param.h" #include "layout.h" #include "attrib.h" #include "index.h" #include "dir.h" #include "security.h" #include "acls.h" #include "efs.h" #include "reparse.h" #include "object_id.h" #include "ea.h" #include "misc.h" #include "logging.h" #include "xattrs.h" #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN /* * Posix ACL structures */ struct LE_POSIX_ACE { le16 tag; le16 perms; le32 id; } __attribute__((__packed__)); struct LE_POSIX_ACL { u8 version; u8 flags; le16 filler; struct LE_POSIX_ACE ace[0]; } __attribute__((__packed__)); #endif #endif static const char nf_ns_xattr_ntfs_acl[] = "system.ntfs_acl"; static const char nf_ns_xattr_attrib[] = "system.ntfs_attrib"; static const char nf_ns_xattr_attrib_be[] = "system.ntfs_attrib_be"; static const char nf_ns_xattr_efsinfo[] = "system.ntfs_efsinfo"; static const char nf_ns_xattr_reparse[] = "system.ntfs_reparse_data"; static const char nf_ns_xattr_object_id[] = "system.ntfs_object_id"; static const char nf_ns_xattr_dos_name[] = "system.ntfs_dos_name"; static const char nf_ns_xattr_times[] = "system.ntfs_times"; static const char nf_ns_xattr_times_be[] = "system.ntfs_times_be"; static const char nf_ns_xattr_crtime[] = "system.ntfs_crtime"; static const char nf_ns_xattr_crtime_be[] = "system.ntfs_crtime_be"; static const char nf_ns_xattr_ea[] = "system.ntfs_ea"; static const char nf_ns_xattr_posix_access[] = "system.posix_acl_access"; static const char nf_ns_xattr_posix_default[] = "system.posix_acl_default"; static const char nf_ns_alt_xattr_efsinfo[] = "user.ntfs.efsinfo"; struct XATTRNAME { enum SYSTEMXATTRS xattr; const char *name; } ; static struct XATTRNAME nf_ns_xattr_names[] = { { XATTR_NTFS_ACL, nf_ns_xattr_ntfs_acl }, { XATTR_NTFS_ATTRIB, nf_ns_xattr_attrib }, { XATTR_NTFS_ATTRIB_BE, nf_ns_xattr_attrib_be }, { XATTR_NTFS_EFSINFO, nf_ns_xattr_efsinfo }, { XATTR_NTFS_REPARSE_DATA, nf_ns_xattr_reparse }, { XATTR_NTFS_OBJECT_ID, nf_ns_xattr_object_id }, { XATTR_NTFS_DOS_NAME, nf_ns_xattr_dos_name }, { XATTR_NTFS_TIMES, nf_ns_xattr_times }, { XATTR_NTFS_TIMES_BE, nf_ns_xattr_times_be }, { XATTR_NTFS_CRTIME, nf_ns_xattr_crtime }, { XATTR_NTFS_CRTIME_BE, nf_ns_xattr_crtime_be }, { XATTR_NTFS_EA, nf_ns_xattr_ea }, { XATTR_POSIX_ACC, nf_ns_xattr_posix_access }, { XATTR_POSIX_DEF, nf_ns_xattr_posix_default }, { XATTR_UNMAPPED, (char*)NULL } /* terminator */ }; /* * Make an integer big-endian * * Swap bytes on a small-endian computer and does nothing on a * big-endian computer. */ static void fix_big_endian(char *p, int size) { #if __BYTE_ORDER == __LITTLE_ENDIAN int i,j; int c; i = 0; j = size - 1; while (i < j) { c = p[i]; p[i++] = p[j]; p[j--] = c; } #endif } #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN /* * Make a Posix ACL CPU endian */ static int le_acl_to_cpu(const struct LE_POSIX_ACL *le_acl, size_t size, struct POSIX_ACL *acl) { int i; int cnt; acl->version = le_acl->version; acl->flags = le_acl->flags; acl->filler = 0; cnt = (size - sizeof(struct LE_POSIX_ACL)) / sizeof(struct LE_POSIX_ACE); for (i=0; iace[i].tag = le16_to_cpu(le_acl->ace[i].tag); acl->ace[i].perms = le16_to_cpu(le_acl->ace[i].perms); acl->ace[i].id = le32_to_cpu(le_acl->ace[i].id); } return (0); } /* * Make a Posix ACL little endian */ int cpu_to_le_acl(const struct POSIX_ACL *acl, size_t size, struct LE_POSIX_ACL *le_acl) { int i; int cnt; le_acl->version = acl->version; le_acl->flags = acl->flags; le_acl->filler = const_cpu_to_le16(0); cnt = (size - sizeof(struct POSIX_ACL)) / sizeof(struct POSIX_ACE); for (i=0; iace[i].tag = cpu_to_le16(acl->ace[i].tag); le_acl->ace[i].perms = cpu_to_le16(acl->ace[i].perms); le_acl->ace[i].id = cpu_to_le32(acl->ace[i].id); } return (0); } #endif #endif /* * Determine whether an extended attribute is mapped to * internal data (original name in system namespace, or renamed) */ enum SYSTEMXATTRS ntfs_xattr_system_type(const char *name, ntfs_volume *vol) { struct XATTRNAME *p; enum SYSTEMXATTRS ret; #ifdef XATTR_MAPPINGS const struct XATTRMAPPING *q; #endif /* XATTR_MAPPINGS */ p = nf_ns_xattr_names; while (p->name && strcmp(p->name,name)) p++; ret = p->xattr; #ifdef XATTR_MAPPINGS if (!p->name && vol && vol->xattr_mapping) { q = vol->xattr_mapping; while (q && strcmp(q->name,name)) q = q->next; if (q) ret = q->xattr; } #else /* XATTR_MAPPINGS */ if (!p->name && vol && vol->efs_raw && !strcmp(nf_ns_alt_xattr_efsinfo,name)) ret = XATTR_NTFS_EFSINFO; #endif /* XATTR_MAPPINGS */ return (ret); } #ifdef XATTR_MAPPINGS /* * Basic read from a user mapping file on another volume */ static int basicread(void *fileid, char *buf, size_t size, off_t offs __attribute__((unused))) { return (read(*(int*)fileid, buf, size)); } /* * Read from a user mapping file on current NTFS partition */ static int localread(void *fileid, char *buf, size_t size, off_t offs) { return (ntfs_attr_data_read((ntfs_inode*)fileid, AT_UNNAMED, 0, buf, size, offs)); } /* * Get a single mapping item from buffer * * Always reads a full line, truncating long lines * Refills buffer when exhausted * Returns pointer to item, or NULL when there is no more * Note : errors are logged, but not returned // TODO partially share with acls.c */ static struct XATTRMAPPING *getmappingitem(FILEREADER reader, void *fileid, off_t *poffs, char *buf, int *psrc, s64 *psize) { int src; int dst; char *pe; char *ps; char *pu; enum SYSTEMXATTRS xattr; int gotend; char maptext[LINESZ]; struct XATTRMAPPING *item; src = *psrc; dst = 0; do { gotend = 0; while ((src < *psize) && (buf[src] != '\n')) { /* ignore spaces */ if ((dst < LINESZ) && (buf[src] != '\r') && (buf[src] != '\t') && (buf[src] != ' ')) maptext[dst++] = buf[src]; src++; } if (src >= *psize) { *poffs += *psize; *psize = reader(fileid, buf, (size_t)BUFSZ, *poffs); src = 0; } else { gotend = 1; src++; maptext[dst] = '\0'; dst = 0; } } while (*psize && ((maptext[0] == '#') || !gotend)); item = (struct XATTRMAPPING*)NULL; if (gotend) { /* decompose into system name and user name */ ps = maptext; pu = strchr(maptext,':'); if (pu) { *pu++ = 0; pe = strchr(pu,':'); if (pe) *pe = 0; /* check name validity */ if ((strlen(pu) < 6) || strncmp(pu,"user.",5)) pu = (char*)NULL; xattr = ntfs_xattr_system_type(ps, (ntfs_volume*)NULL); if (xattr == XATTR_UNMAPPED) pu = (char*)NULL; } if (pu) { item = (struct XATTRMAPPING*)ntfs_malloc( sizeof(struct XATTRMAPPING) + strlen(pu)); if (item) { item->xattr = xattr; strcpy(item->name,pu); item->next = (struct XATTRMAPPING*)NULL; } } else { ntfs_log_early_error("Bad xattr mapping item, aborting\n"); } } *psrc = src; return (item); } /* * Read xattr mapping file and split into their attribute. * Parameters are kept in a chained list. * Returns the head of list, if any * Errors are logged, but not returned * * If an absolute path is provided, the mapping file is assumed * to be located in another mounted file system, and plain read() * are used to get its contents. * If a relative path is provided, the mapping file is assumed * to be located on the current file system, and internal IO * have to be used since we are still mounting and we have not * entered the fuse loop yet. */ static struct XATTRMAPPING *ntfs_read_xattr_mapping(FILEREADER reader, void *fileid) { char buf[BUFSZ]; struct XATTRMAPPING *item; struct XATTRMAPPING *current; struct XATTRMAPPING *firstitem; struct XATTRMAPPING *lastitem; BOOL duplicated; int src; off_t offs; s64 size; firstitem = (struct XATTRMAPPING*)NULL; lastitem = (struct XATTRMAPPING*)NULL; offs = 0; size = reader(fileid, buf, (size_t)BUFSZ, (off_t)0); if (size > 0) { src = 0; do { item = getmappingitem(reader, fileid, &offs, buf, &src, &size); if (item) { /* check no double mapping */ duplicated = FALSE; for (current=firstitem; current; current=current->next) if ((current->xattr == item->xattr) || !strcmp(current->name,item->name)) duplicated = TRUE; if (duplicated) { free(item); ntfs_log_early_error("Conflicting xattr mapping ignored\n"); } else { item->next = (struct XATTRMAPPING*)NULL; if (lastitem) lastitem->next = item; else firstitem = item; lastitem = item; } } } while (item); } return (firstitem); } /* * Build the extended attribute mappings to user namespace * * Note : no error is returned. If we refused mounting when there * is an error it would be too difficult to fix the offending file */ struct XATTRMAPPING *ntfs_xattr_build_mapping(ntfs_volume *vol, const char *xattrmap_path) { struct XATTRMAPPING *firstmapping; struct XATTRMAPPING *mapping; BOOL user_efs; BOOL notfound; ntfs_inode *ni; int fd; firstmapping = (struct XATTRMAPPING*)NULL; notfound = FALSE; if (!xattrmap_path) xattrmap_path = XATTRMAPPINGFILE; if (xattrmap_path[0] == '/') { fd = open(xattrmap_path,O_RDONLY); if (fd > 0) { firstmapping = ntfs_read_xattr_mapping(basicread, (void*)&fd); close(fd); } else notfound = TRUE; } else { ni = ntfs_pathname_to_inode(vol, NULL, xattrmap_path); if (ni) { firstmapping = ntfs_read_xattr_mapping(localread, ni); ntfs_inode_close(ni); } else notfound = TRUE; } if (notfound && strcmp(xattrmap_path, XATTRMAPPINGFILE)) { ntfs_log_early_error("Could not open \"%s\"\n",xattrmap_path); } if (vol->efs_raw) { user_efs = TRUE; for (mapping=firstmapping; mapping; mapping=mapping->next) if (mapping->xattr == XATTR_NTFS_EFSINFO) user_efs = FALSE; } else user_efs = FALSE; if (user_efs) { mapping = (struct XATTRMAPPING*)ntfs_malloc( sizeof(struct XATTRMAPPING) + strlen(nf_ns_alt_xattr_efsinfo)); if (mapping) { mapping->next = firstmapping; mapping->xattr = XATTR_NTFS_EFSINFO; strcpy(mapping->name,nf_ns_alt_xattr_efsinfo); firstmapping = mapping; } } return (firstmapping); } void ntfs_xattr_free_mapping(struct XATTRMAPPING *mapping) { struct XATTRMAPPING *p, *q; p = mapping; while (p) { q = p->next; free(p); p = q; } } #endif /* XATTR_MAPPINGS */ /* * Get an NTFS attribute into an extended attribute * * Returns the non-negative size of attribute if successful, * or negative, with errno set, when fails * Note : the size is returned even if no buffer is provided * for returning the attribute, or if it is zero-sized. */ int ntfs_xattr_system_getxattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni, char *value, size_t size) { int res; int i; #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN struct POSIX_ACL *acl; #endif #endif switch (attr) { case XATTR_NTFS_ACL : res = ntfs_get_ntfs_acl(scx, ni, value, size); break; #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN case XATTR_POSIX_ACC : acl = (struct POSIX_ACL*)ntfs_malloc(size); if (acl) { res = ntfs_get_posix_acl(scx, ni, nf_ns_xattr_posix_access, (char*)acl, size); if (res > 0) { if (cpu_to_le_acl(acl,res, (struct LE_POSIX_ACL*)value)) res = -errno; } free(acl); } else res = -errno; break; case XATTR_POSIX_DEF : acl = (struct POSIX_ACL*)ntfs_malloc(size); if (acl) { res = ntfs_get_posix_acl(scx, ni, nf_ns_xattr_posix_default, (char*)acl, size); if (res > 0) { if (cpu_to_le_acl(acl,res, (struct LE_POSIX_ACL*)value)) res = -errno; } free(acl); } else res = -errno; break; #else case XATTR_POSIX_ACC : res = ntfs_get_posix_acl(scx, ni, nf_ns_xattr_posix_access, value, size); break; case XATTR_POSIX_DEF : res = ntfs_get_posix_acl(scx, ni, nf_ns_xattr_posix_default, value, size); break; #endif #endif case XATTR_NTFS_ATTRIB : res = ntfs_get_ntfs_attrib(ni, value, size); break; case XATTR_NTFS_ATTRIB_BE : res = ntfs_get_ntfs_attrib(ni, value, size); if ((res == 4) && value) { if (size >= 4) fix_big_endian(value,4); else res = -EINVAL; } break; case XATTR_NTFS_EFSINFO : if (ni->vol->efs_raw) res = ntfs_get_efs_info(ni, value, size); else res = -EPERM; break; case XATTR_NTFS_REPARSE_DATA : res = ntfs_get_ntfs_reparse_data(ni, value, size); break; case XATTR_NTFS_OBJECT_ID : res = ntfs_get_ntfs_object_id(ni, value, size); break; case XATTR_NTFS_DOS_NAME: if (dir_ni) res = ntfs_get_ntfs_dos_name(ni, dir_ni, value, size); else res = -errno; break; case XATTR_NTFS_TIMES: res = ntfs_inode_get_times(ni, value, size); break; case XATTR_NTFS_TIMES_BE: res = ntfs_inode_get_times(ni, value, size); if ((res > 0) && value) { for (i=0; (i+1)*sizeof(u64)<=(unsigned int)res; i++) fix_big_endian(&value[i*sizeof(u64)], sizeof(u64)); } break; case XATTR_NTFS_CRTIME: res = ntfs_inode_get_times(ni, value, (size >= sizeof(u64) ? sizeof(u64) : size)); break; case XATTR_NTFS_CRTIME_BE: res = ntfs_inode_get_times(ni, value, (size >= sizeof(u64) ? sizeof(u64) : size)); if ((res >= (int)sizeof(u64)) && value) fix_big_endian(value,sizeof(u64)); break; case XATTR_NTFS_EA : res = ntfs_get_ntfs_ea(ni, value, size); break; default : errno = EOPNOTSUPP; res = -errno; break; } return (res); } /* * Set an NTFS attribute from an extended attribute * * Returns 0 if successful, * non-zero, with errno set, when fails */ int ntfs_xattr_system_setxattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni, const char *value, size_t size, int flags) { int res; int i; char buf[4*sizeof(u64)]; #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN struct POSIX_ACL *acl; #endif #endif switch (attr) { case XATTR_NTFS_ACL : res = ntfs_set_ntfs_acl(scx, ni, value, size, flags); break; #if POSIXACLS #if __BYTE_ORDER == __BIG_ENDIAN case XATTR_POSIX_ACC : acl = (struct POSIX_ACL*)ntfs_malloc(size); if (acl) { if (!le_acl_to_cpu((const struct LE_POSIX_ACL*)value, size, acl)) { res = ntfs_set_posix_acl(scx ,ni , nf_ns_xattr_posix_access, (char*)acl, size, flags); } else res = -errno; free(acl); } else res = -errno; break; case XATTR_POSIX_DEF : acl = (struct POSIX_ACL*)ntfs_malloc(size); if (acl) { if (!le_acl_to_cpu((const struct LE_POSIX_ACL*)value, size, acl)) { res = ntfs_set_posix_acl(scx ,ni , nf_ns_xattr_posix_default, (char*)acl, size, flags); } else res = -errno; free(acl); } else res = -errno; break; #else case XATTR_POSIX_ACC : res = ntfs_set_posix_acl(scx ,ni , nf_ns_xattr_posix_access, value, size, flags); break; case XATTR_POSIX_DEF : res = ntfs_set_posix_acl(scx, ni, nf_ns_xattr_posix_default, value, size, flags); break; #endif #endif case XATTR_NTFS_ATTRIB : res = ntfs_set_ntfs_attrib(ni, value, size, flags); break; case XATTR_NTFS_ATTRIB_BE : if (value && (size >= 4)) { memcpy(buf,value,4); fix_big_endian(buf,4); res = ntfs_set_ntfs_attrib(ni, buf, 4, flags); } else res = ntfs_set_ntfs_attrib(ni, value, size, flags); break; case XATTR_NTFS_EFSINFO : if (ni->vol->efs_raw) res = ntfs_set_efs_info(ni, value, size, flags); else { errno = EPERM; res = -EPERM; } break; case XATTR_NTFS_REPARSE_DATA : res = ntfs_set_ntfs_reparse_data(ni, value, size, flags); break; case XATTR_NTFS_OBJECT_ID : res = ntfs_set_ntfs_object_id(ni, value, size, flags); break; case XATTR_NTFS_DOS_NAME: if (dir_ni) /* warning : this closes both inodes */ res = ntfs_set_ntfs_dos_name(ni, dir_ni, value, size, flags); else { errno = EINVAL; res = -errno; } break; case XATTR_NTFS_TIMES: res = ntfs_inode_set_times(ni, value, size, flags); break; case XATTR_NTFS_TIMES_BE: if (value && (size > 0) && (size <= 4*sizeof(u64))) { memcpy(buf,value,size); for (i=0; (i+1)*sizeof(u64)<=size; i++) fix_big_endian(&buf[i*sizeof(u64)], sizeof(u64)); res = ntfs_inode_set_times(ni, buf, size, flags); } else res = ntfs_inode_set_times(ni, value, size, flags); break; case XATTR_NTFS_CRTIME: res = ntfs_inode_set_times(ni, value, (size >= sizeof(u64) ? sizeof(u64) : size), flags); break; case XATTR_NTFS_CRTIME_BE: if (value && (size >= sizeof(u64))) { memcpy(buf,value,sizeof(u64)); fix_big_endian(buf,sizeof(u64)); res = ntfs_inode_set_times(ni, buf, sizeof(u64), flags); } else res = ntfs_inode_set_times(ni, value, size, flags); break; case XATTR_NTFS_EA : res = ntfs_set_ntfs_ea(ni, value, size, flags); break; default : errno = EOPNOTSUPP; res = -errno; break; } return (res); } int ntfs_xattr_system_removexattr(struct SECURITY_CONTEXT *scx, enum SYSTEMXATTRS attr, ntfs_inode *ni, ntfs_inode *dir_ni) { int res; res = 0; switch (attr) { /* * Removal of NTFS ACL, ATTRIB, EFSINFO or TIMES * is never allowed */ case XATTR_NTFS_ACL : case XATTR_NTFS_ATTRIB : case XATTR_NTFS_ATTRIB_BE : case XATTR_NTFS_EFSINFO : case XATTR_NTFS_TIMES : case XATTR_NTFS_TIMES_BE : case XATTR_NTFS_CRTIME : case XATTR_NTFS_CRTIME_BE : res = -EPERM; break; #if POSIXACLS case XATTR_POSIX_ACC : case XATTR_POSIX_DEF : if (ni) { if (!ntfs_allowed_as_owner(scx, ni) || ntfs_remove_posix_acl(scx, ni, (attr == XATTR_POSIX_ACC ? nf_ns_xattr_posix_access : nf_ns_xattr_posix_default))) res = -errno; } else res = -errno; break; #endif case XATTR_NTFS_REPARSE_DATA : if (ni) { if (!ntfs_allowed_as_owner(scx, ni) || ntfs_remove_ntfs_reparse_data(ni)) res = -errno; } else res = -errno; break; case XATTR_NTFS_OBJECT_ID : if (ni) { if (!ntfs_allowed_as_owner(scx, ni) || ntfs_remove_ntfs_object_id(ni)) res = -errno; } else res = -errno; break; case XATTR_NTFS_DOS_NAME: if (ni && dir_ni) { if (ntfs_remove_ntfs_dos_name(ni,dir_ni)) res = -errno; /* ni and dir_ni have been closed */ } else res = -errno; break; case XATTR_NTFS_EA : res = ntfs_remove_ntfs_ea(ni); break; default : errno = EOPNOTSUPP; res = -errno; break; } return (res); } ntfsprogs-plus-1.0.0/src/000077500000000000000000000000001507404161300153065ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/src/Makefile.am000066400000000000000000000050021507404161300173370ustar00rootroot00000000000000if REALLYSTATIC AM_LIBS = $(top_builddir)/libntfs/.libs/libntfs.a $(NTFSPROGS_STATIC_LIBS) # older builds may need -static instead of newer -all-static AM_LFLAGS = -static STATIC_LINK = $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ else AM_LIBS = $(top_builddir)/libntfs/libntfs.la AM_LFLAGS = $(all_libraries) LIBTOOL_LINK = $(LIBTOOL) --mode=link $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ endif # Workaround to make REALLYSTATIC work with automake 1.5. LINK=$(STATIC_LINK) $(LIBTOOL_LINK) bin_PROGRAMS = ntfsinfo ntfscluster sbin_PROGRAMS = mkntfs ntfslabel ntfsclone ntfsck ntfsresize man_MANS = mkntfs.8 ntfslabel.8 ntfsinfo.8 ntfsck.8 \ ntfsprogs-plus.8 ntfsclone.8 ntfscluster.8 \ ntfsresize.8 EXTRA_MANS = MAINTAINERCLEANFILES = Makefile.in # Set the include path. AM_CPPFLAGS = -I$(top_srcdir)/include $(all_includes) mkntfs_CPPFLAGS = $(AM_CPPFLAGS) $(MKNTFS_CPPFLAGS) mkntfs_SOURCES = attrdef.c attrdef.h sd.c sd.h mkntfs.c utils.c utils.h mkntfs_LDADD = $(AM_LIBS) $(MKNTFS_LIBS) mkntfs_LDFLAGS = $(AM_LFLAGS) ntfslabel_SOURCES = ntfslabel.c utils.c utils.h ntfslabel_LDADD = $(AM_LIBS) ntfslabel_LDFLAGS = $(AM_LFLAGS) ntfsinfo_SOURCES = ntfsinfo.c utils.c utils.h ntfsinfo_LDADD = $(AM_LIBS) ntfsinfo_LDFLAGS = $(AM_LFLAGS) ntfsresize_SOURCES = ntfsresize.c utils.c utils.h ntfsresize_LDADD = $(AM_LIBS) ntfsresize_LDFLAGS = $(AM_LFLAGS) ntfsclone_SOURCES = ntfsclone.c utils.c utils.h ntfsclone_LDADD = $(AM_LIBS) ntfsclone_LDFLAGS = $(AM_LFLAGS) ntfscluster_SOURCES = ntfscluster.c ntfscluster.h cluster.c cluster.h utils.c utils.h ntfscluster_LDADD = $(AM_LIBS) ntfscluster_LDFLAGS = $(AM_LFLAGS) ntfsck_SOURCES = ntfsck.c utils.c utils.h ntfsck_LDADD = $(AM_LIBS) ntfsck_LDFLAGS = $(AM_LFLAGS) # Extra targets strip: $(bin_PROGRAMS) $(sbin_PROGRAMS) $(STRIP) $^ libs: (cd ../libntfs && $(MAKE) libs) || exit 1; # mkfs.ntfs[.8] hard link install-exec-hook: $(INSTALL) -d $(DESTDIR)/$(sbindir) $(LN_S) -f $(sbindir)/mkntfs $(DESTDIR)$(sbindir)/mkfs.ntfs $(LN_S) -f $(sbindir)/ntfsck $(DESTDIR)$(sbindir)/fsck.ntfs $(LN_S) -f $(sbindir)/mkntfs $(DESTDIR)$(sbindir)/mkfs.ntfsplus $(LN_S) -f $(sbindir)/ntfsck $(DESTDIR)$(sbindir)/fsck.ntfsplus install-data-hook: $(INSTALL) -d $(DESTDIR)$(man8dir) $(LN_S) -f mkntfs.8 $(DESTDIR)$(man8dir)/mkfs.ntfs.8 $(LN_S) -f ntfsck.8 $(DESTDIR)$(man8dir)/fsck.ntfs.8 uninstall-local: $(RM) -f $(DESTDIR)/sbin/mkfs.ntfs $(RM) -f $(DESTDIR)/sbin/fsck.ntfs $(RM) -f $(DESTDIR)$(man8dir)/mkfs.ntfs.8 $(RM) -f $(DESTDIR)$(man8dir)/fsck.ntfs.8 ntfsprogs-plus-1.0.0/src/attrdef.c000066400000000000000000000361531507404161300171130ustar00rootroot00000000000000#include "attrdef.h" /** * attrdef_ntfs3x_array */ const unsigned char attrdef_ntfs3x_array[2560] = { 0x24, 0x00, 0x53, 0x00, 0x54, 0x00, 0x41, 0x00, 0x4E, 0x00, 0x44, 0x00, 0x41, 0x00, 0x52, 0x00, 0x44, 0x00, 0x5F, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x46, 0x00, 0x4F, 0x00, 0x52, 0x00, 0x4D, 0x00, 0x41, 0x00, 0x54, 0x00, 0x49, 0x00, 0x4F, 0x00, 0x4E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x48, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x41, 0x00, 0x54, 0x00, 0x54, 0x00, 0x52, 0x00, 0x49, 0x00, 0x42, 0x00, 0x55, 0x00, 0x54, 0x00, 0x45, 0x00, 0x5F, 0x00, 0x4C, 0x00, 0x49, 0x00, 0x53, 0x00, 0x54, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x46, 0x00, 0x49, 0x00, 0x4C, 0x00, 0x45, 0x00, 0x5F, 0x00, 0x4E, 0x00, 0x41, 0x00, 0x4D, 0x00, 0x45, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x42, 0x00, 0x00, 0x00, 0x44, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x42, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x4F, 0x00, 0x42, 0x00, 0x4A, 0x00, 0x45, 0x00, 0x43, 0x00, 0x54, 0x00, 0x5F, 0x00, 0x49, 0x00, 0x44, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x53, 0x00, 0x45, 0x00, 0x43, 0x00, 0x55, 0x00, 0x52, 0x00, 0x49, 0x00, 0x54, 0x00, 0x59, 0x00, 0x5F, 0x00, 0x44, 0x00, 0x45, 0x00, 0x53, 0x00, 0x43, 0x00, 0x52, 0x00, 0x49, 0x00, 0x50, 0x00, 0x54, 0x00, 0x4F, 0x00, 0x52, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x50, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x56, 0x00, 0x4F, 0x00, 0x4C, 0x00, 0x55, 0x00, 0x4D, 0x00, 0x45, 0x00, 0x5F, 0x00, 0x4E, 0x00, 0x41, 0x00, 0x4D, 0x00, 0x45, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x56, 0x00, 0x4F, 0x00, 0x4C, 0x00, 0x55, 0x00, 0x4D, 0x00, 0x45, 0x00, 0x5F, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x46, 0x00, 0x4F, 0x00, 0x52, 0x00, 0x4D, 0x00, 0x41, 0x00, 0x54, 0x00, 0x49, 0x00, 0x4F, 0x00, 0x4E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x70, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x0C, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0C, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x44, 0x00, 0x41, 0x00, 0x54, 0x00, 0x41, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x44, 0x00, 0x45, 0x00, 0x58, 0x00, 0x5F, 0x00, 0x52, 0x00, 0x4F, 0x00, 0x4F, 0x00, 0x54, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x90, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x44, 0x00, 0x45, 0x00, 0x58, 0x00, 0x5F, 0x00, 0x41, 0x00, 0x4C, 0x00, 0x4C, 0x00, 0x4F, 0x00, 0x43, 0x00, 0x41, 0x00, 0x54, 0x00, 0x49, 0x00, 0x4F, 0x00, 0x4E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xA0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x42, 0x00, 0x49, 0x00, 0x54, 0x00, 0x4D, 0x00, 0x41, 0x00, 0x50, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xB0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x24, 0x00, 0x52, 0x00, 0x45, 0x00, 0x50, 0x00, 0x41, 0x00, 0x52, 0x00, 0x53, 0x00, 0x45, 0x00, 0x5F, 0x00, 0x50, 0x00, 0x4F, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x54, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x45, 0x00, 0x41, 0x00, 0x5F, 0x00, 0x49, 0x00, 0x4E, 0x00, 0x46, 0x00, 0x4F, 0x00, 0x52, 0x00, 0x4D, 0x00, 0x41, 0x00, 0x54, 0x00, 0x49, 0x00, 0x4F, 0x00, 0x4E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xD0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x45, 0x00, 0x41, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x24, 0x00, 0x4C, 0x00, 0x4F, 0x00, 0x47, 0x00, 0x47, 0x00, 0x45, 0x00, 0x44, 0x00, 0x5F, 0x00, 0x55, 0x00, 0x54, 0x00, 0x49, 0x00, 0x4C, 0x00, 0x49, 0x00, 0x54, 0x00, 0x59, 0x00, 0x5F, 0x00, 0x53, 0x00, 0x54, 0x00, 0x52, 0x00, 0x45, 0x00, 0x41, 0x00, 0x4D, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; ntfsprogs-plus-1.0.0/src/attrdef.h000066400000000000000000000002111507404161300171020ustar00rootroot00000000000000#ifndef _NTFS_ATTRDEF_H_ #define _NTFS_ATTRDEF_H_ extern const unsigned char attrdef_ntfs3x_array[2560]; #endif /* _NTFS_ATTRDEF_H_ */ ntfsprogs-plus-1.0.0/src/cluster.c000066400000000000000000000066151507404161300171430ustar00rootroot00000000000000/** * cluster - Part of the Linux-NTFS project. * * Copyright (c) 2002-2003 Richard Russon * Copyright (c) 2014 Jean-Pierre Andre * * This function will locate the owner of any given sector or cluster range. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #include "cluster.h" #include "utils.h" #include "logging.h" /** * cluster_find */ int cluster_find(ntfs_volume *vol, LCN c_begin, LCN c_end, cluster_cb *cb, void *data) { int j; int result = -1; struct mft_search_ctx *m_ctx = NULL; ntfs_attr_search_ctx *a_ctx = NULL; s64 count; BOOL found; ATTR_RECORD *rec; runlist *runs; if (!vol || !cb) return -1; m_ctx = mft_get_search_ctx(vol); m_ctx->flags_search = FEMR_IN_USE | FEMR_BASE_RECORD; count = 0; while (mft_next_record(m_ctx) == 0) { if (!(m_ctx->flags_match & FEMR_BASE_RECORD)) continue; ntfs_log_verbose("Inode: %llu\n", (unsigned long long) m_ctx->inode->mft_no); a_ctx = ntfs_attr_get_search_ctx(m_ctx->inode, NULL); found = FALSE; while ((rec = find_attribute(AT_UNUSED, a_ctx))) { if (!rec->non_resident) { ntfs_log_verbose("0x%02x skipped - attr is resident\n", (int)le32_to_cpu(a_ctx->attr->type)); continue; } runs = ntfs_mapping_pairs_decompress(vol, a_ctx->attr, NULL); if (!runs) { ntfs_log_error("Couldn't read the data runs.\n"); goto done; } ntfs_log_verbose("\t[0x%02X]\n", (int)le32_to_cpu(a_ctx->attr->type)); ntfs_log_verbose("\t\tVCN\tLCN\tLength\n"); for (j = 0; runs[j].length > 0; j++) { LCN a_begin = runs[j].lcn; LCN a_end = a_begin + runs[j].length - 1; if (a_begin < 0) continue; // sparse, discontiguous, etc ntfs_log_verbose("\t\t%lld\t%lld-%lld (%lld)\n", (long long)runs[j].vcn, (long long)runs[j].lcn, (long long)(runs[j].lcn + runs[j].length - 1), (long long)runs[j].length); //dprint list if ((a_begin > c_end) || (a_end < c_begin)) continue; // before or after search range if ((*cb) (m_ctx->inode, a_ctx->attr, runs+j, data)) { result = 1; goto done; } found = TRUE; } if (runs) { free(runs); runs = NULL; } } ntfs_attr_put_search_ctx(a_ctx); a_ctx = NULL; if (found) count++; } if (count > 1) ntfs_log_info("* %lld inodes found\n",(long long)count); else ntfs_log_info("* %s inode found\n", (count ? "one" : "no")); result = 0; done: if (runs) free(runs); if (a_ctx) ntfs_attr_put_search_ctx(a_ctx); if (m_ctx) mft_put_search_ctx(m_ctx); return result; } ntfsprogs-plus-1.0.0/src/cluster.h000066400000000000000000000024251507404161300171430ustar00rootroot00000000000000/* * cluster - Part of the Linux-NTFS project. * * Copyright (c) 2003 Richard Russon * * This function will locate the owner of any given sector or cluster range. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _CLUSTER_H_ #define _CLUSTER_H_ #include "types.h" #include "volume.h" typedef struct { int x; } ntfs_cluster; typedef int (cluster_cb)(ntfs_inode *ino, ATTR_RECORD *attr, runlist_element *run, void *data); int cluster_find(ntfs_volume *vol, LCN c_begin, LCN c_end, cluster_cb *cb, void *data); #endif /* _CLUSTER_H_ */ ntfsprogs-plus-1.0.0/src/deprecated/000077500000000000000000000000001507404161300174065ustar00rootroot00000000000000ntfsprogs-plus-1.0.0/src/deprecated/ntfscat.8.in000066400000000000000000000066001507404161300215500ustar00rootroot00000000000000.\" Copyright (c) 2003\-2005 Richard Russon. .\" Copyright (c) 2007 Yura Pakhuchiy. .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSCAT 8 "September 2007" "ntfs-3g @VERSION@" .SH NAME ntfscat \- print NTFS files and streams on the standard output .SH SYNOPSIS [\fIoptions\fR] \fIdevice \fR[\fIfile\fR] .SH DESCRIPTION .B ntfscat will read a file or stream from an NTFS volume and display the contents on the standard output. .PP The case of the filename passed to .B ntfscat is ignored. .SH OPTIONS Below is a summary of all the options that .B ntfscat accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-a\fR, \fB\-\-attribute\fR TYPE Display the contents of a particular attribute type. By default, the unnamed $DATA attribute will be shown. The attribute can be specified by a number in decimal or hexadecimal, or by name. .TS box; lB lB lB l l l. Hex Decimal Name 0x10 16 "$STANDARD_INFORMATION" 0x20 32 "$ATTRIBUTE_LIST" 0x30 48 "$FILE_NAME" 0x40 64 "$OBJECT_ID" 0x50 80 "$SECURITY_DESCRIPTOR" 0x60 96 "$VOLUME_NAME" 0x70 112 "$VOLUME_INFORMATION" 0x80 128 "$DATA" 0x90 144 "$INDEX_ROOT" 0xA0 160 "$INDEX_ALLOCATION" 0xB0 176 "$BITMAP" 0xC0 192 "$REPARSE_POINT" 0xD0 208 "$EA_INFORMATION" 0xE0 224 "$EA" 0xF0 240 "$PROPERTY_SET" 0x100 256 "$LOGGED_UTILITY_STREAM" .TE .sp .sp .B Notes The attribute names may be given without the leading $ symbol. .br If you use the $ symbol, you must quote the name to prevent the shell interpreting the name. .TP \fB\-n\fR, \fB\-\-attribute\-name\fR NAME Display this named attribute, stream. .TP \fB\-i\fR, \fB\-\-inode\fR NUM Specify a file by its inode number instead of its name. .TP \fB\-f\fR, \fB\-\-force\fR This will override some sensible defaults, such as not using a mounted volume. Use this option with caution. .TP \fB\-h\fR, \fB\-\-help\fR Show a list of options with a brief description of each one. .TP \fB\-q\fR, \fB\-\-quiet\fR Suppress some debug/warning/error messages. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license .BR ntfscat . .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .SH EXAMPLES Display the contents of a file in the root of an NTFS volume. .RS .sp .B ntfscat /dev/hda1 boot.ini .sp .RE Display the contents of a file in a subdirectory of an NTFS volume. .RS .sp .B ntfscat /dev/hda1 /winnt/system32/drivers/etc/hosts .sp .RE Display the contents of the $INDEX_ROOT attribute of the root directory (inode 5). .RS .sp .B ntfscat /dev/hda1 \-a INDEX_ROOT \-i 5 | hexdump \-C .sp .RE .SH BUGS There are no known problems with .BR ntfscat . If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS .B ntfscat was written by Richard Russon, Anton Altaparmakov and Szabolcs Szakacsits. It was ported to ntfs-3g by Erik Larsson. .SH AVAILABILITY .B ntfscat is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO Read \fBlibntfs\fR(8) for details how to access encrypted files. .sp .BR libntfs (8), .BR ntfsls (8), .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfscat.c000066400000000000000000000260001507404161300212120ustar00rootroot00000000000000/** * ntfscat - Part of the Linux-NTFS project. * * Copyright (c) 2003-2005 Richard Russon * Copyright (c) 2003-2005 Anton Altaparmakov * Copyright (c) 2003-2005 Szabolcs Szakacsits * Copyright (c) 2007 Yura Pakhuchiy * * This utility will concatenate files and print on the standard output. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #include "types.h" #include "attrib.h" #include "utils.h" #include "volume.h" #include "debug.h" #include "dir.h" #include "ntfscat.h" /* #include "version.h" */ #include "utils.h" static const char *EXEC_NAME = "ntfscat"; static struct options opts; /** * version - Print version information about the program * * Print a copyright statement and a brief description of the program. * * Return: none */ static void version(void) { ntfs_log_info("\n%s v%s (libntfs-3g) - Concatenate files and print " "on the standard output.\n\n", EXEC_NAME, VERSION); ntfs_log_info("Copyright (c) 2003-2005 Richard Russon\n"); ntfs_log_info("Copyright (c) 2003-2005 Anton Altaparmakov\n"); ntfs_log_info("Copyright (c) 2003-2005 Szabolcs Szakacsits\n"); ntfs_log_info("Copyright (c) 2007 Yura Pakhuchiy\n"); ntfs_log_info("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ static void usage(void) { ntfs_log_info("\nUsage: %s [options] device [file]\n\n" " -a, --attribute TYPE Display this attribute type\n" " -n, --attribute-name NAME Display this attribute name\n" " -i, --inode NUM Display this inode\n\n" " -f, --force Use less caution\n" " -h, --help Print this help\n" " -q, --quiet Less output\n" " -V, --version Version information\n" " -v, --verbose More output\n\n", // Does not work for compressed files at present so leave undocumented... // " -r --raw Display the raw data (e.g. for compressed or encrypted file)", EXEC_NAME); ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home); } /** * parse_attribute - Read an attribute name, or number * @value: String to be parsed * @attr: Resulting attribute id (on success) * * Read a string representing an attribute. It may be a decimal, octal or * hexadecimal number, or the attribute name in full. The leading $ sign is * optional. * * Return: 1 Success, a valid attribute name or number * 0 Error, not an attribute name or number */ static int parse_attribute(const char *value, ATTR_TYPES *attr) { static const char *attr_name[] = { "$STANDARD_INFORMATION", "$ATTRIBUTE_LIST", "$FILE_NAME", "$OBJECT_ID", "$SECURITY_DESCRIPTOR", "$VOLUME_NAME", "$VOLUME_INFORMATION", "$DATA", "$INDEX_ROOT", "$INDEX_ALLOCATION", "$BITMAP", "$REPARSE_POINT", "$EA_INFORMATION", "$EA", "$PROPERTY_SET", "$LOGGED_UTILITY_STREAM", NULL }; int i; long num; for (i = 0; attr_name[i]; i++) { if ((strcmp(value, attr_name[i]) == 0) || (strcmp(value, attr_name[i] + 1) == 0)) { *attr = (ATTR_TYPES)cpu_to_le32((i + 1) * 16); return 1; } } num = strtol(value, NULL, 0); if ((num > 0) && (num < 257)) { *attr = (ATTR_TYPES)cpu_to_le32(num); return 1; } return 0; } /** * parse_options - Read and validate the programs command line * * Read the command line, verify the syntax and parse the options. * This function is very long, but quite simple. * * Return: 1 Success * 0 Error, one or more problems */ static int parse_options(int argc, char **argv) { static const char *sopt = "-a:fh?i:n:qVvr"; static const struct option lopt[] = { { "attribute", required_argument, NULL, 'a' }, { "attribute-name", required_argument, NULL, 'n' }, { "force", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "inode", required_argument, NULL, 'i' }, { "quiet", no_argument, NULL, 'q' }, { "version", no_argument, NULL, 'V' }, { "verbose", no_argument, NULL, 'v' }, { "raw", no_argument, NULL, 'r' }, { NULL, 0, NULL, 0 } }; int c = -1; int err = 0; int ver = 0; int help = 0; int levels = 0; ATTR_TYPES attr = AT_UNUSED; opterr = 0; /* We'll handle the errors, thank you. */ opts.inode = -1; opts.attr = const_cpu_to_le32(-1); opts.attr_name = NULL; opts.attr_name_len = 0; while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opts.device) { opts.device = argv[optind - 1]; } else if (!opts.file) { opts.file = argv[optind - 1]; } else { ntfs_log_error("You must specify exactly one " "file.\n"); err++; } break; case 'a': if (opts.attr != const_cpu_to_le32(-1)) { ntfs_log_error("You must specify exactly one " "attribute.\n"); } else if (parse_attribute(optarg, &attr) > 0) { opts.attr = attr; break; } else { ntfs_log_error("Couldn't parse attribute.\n"); } err++; break; case 'f': opts.force++; break; case 'h': help++; break; case 'i': if (opts.inode != -1) ntfs_log_error("You must specify exactly one inode.\n"); else if (utils_parse_size(optarg, &opts.inode, FALSE)) break; else ntfs_log_error("Couldn't parse inode number.\n"); err++; break; case 'n': opts.attr_name_len = ntfs_mbstoucs(optarg, &opts.attr_name); if (opts.attr_name_len < 0) { ntfs_log_perror("Invalid attribute name '%s'", optarg); usage(); } break; case 'q': opts.quiet++; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'V': ver++; break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case 'r': opts.raw = TRUE; break; case '?': if (strncmp (argv[optind-1], "--log-", 6) == 0) { if (!ntfs_log_parse_option (argv[optind-1])) err++; break; } /* fall through */ default: ntfs_log_error("Unknown option '%s'.\n", argv[optind-1]); err++; break; } } /* Make sure we're in sync with the log levels */ levels = ntfs_log_get_levels(); if (levels & NTFS_LOG_LEVEL_VERBOSE) opts.verbose++; if (!(levels & NTFS_LOG_LEVEL_QUIET)) opts.quiet++; if (help || ver) { opts.quiet = 0; } else { if (opts.device == NULL) { ntfs_log_error("You must specify a device.\n"); err++; } else if (opts.file == NULL && opts.inode == -1) { ntfs_log_error("You must specify a file or inode " "with the -i option.\n"); err++; } else if (opts.file != NULL && opts.inode != -1) { ntfs_log_error("You can't specify both a file and inode.\n"); err++; } if (opts.quiet && opts.verbose) { ntfs_log_error("You may not use --quiet and --verbose at the " "same time.\n"); err++; } } if (ver) version(); if (help || err) usage(); /* tri-state 0 : done, 1 : error, -1 : proceed */ return (err ? 1 : (help || ver ? 0 : -1)); } /** * index_get_size - Find the INDX block size from the index root * @inode: Inode of the directory to be checked * * Find the size of a directory's INDX block from the INDEX_ROOT attribute. * * Return: n Success, the INDX blocks are n bytes in size * 0 Error, not a directory */ static int index_get_size(ntfs_inode *inode) { ATTR_RECORD *attr90; INDEX_ROOT *iroot; attr90 = find_first_attribute(AT_INDEX_ROOT, inode->mrec); if (!attr90) return 0; // not a directory iroot = (INDEX_ROOT*)((u8*)attr90 + le16_to_cpu(attr90->value_offset)); return le32_to_cpu(iroot->index_block_size); } /** * cat */ static int cat(ntfs_volume *vol, ntfs_inode *inode, ATTR_TYPES type, ntfschar *name, int namelen) { const int bufsize = 4096; char *buffer; ntfs_attr *attr; s64 bytes_read, written; s64 offset; u32 block_size; buffer = malloc(bufsize); if (!buffer) return 1; attr = ntfs_attr_open(inode, type, name, namelen); if (!attr) { ntfs_log_error("Cannot find attribute type 0x%x.\n", le32_to_cpu(type)); free(buffer); return 1; } if ((inode->mft_no < 2) && (attr->type == AT_DATA)) block_size = vol->mft_record_size; else if (attr->type == AT_INDEX_ALLOCATION) block_size = index_get_size(inode); else block_size = 0; offset = 0; for (;;) { if (!opts.raw && block_size > 0) { // These types have fixup bytes_read = ntfs_attr_mst_pread(attr, offset, 1, block_size, buffer); if (bytes_read > 0) bytes_read *= block_size; } else { bytes_read = ntfs_attr_pread(attr, offset, bufsize, buffer); } //ntfs_log_info("read %lld bytes\n", bytes_read); if (bytes_read == -1) { ntfs_log_perror("ERROR: Couldn't read file"); break; } if (!bytes_read) break; written = fwrite(buffer, 1, bytes_read, stdout); if (written != bytes_read) { ntfs_log_perror("ERROR: Couldn't output all data!"); break; } offset += bytes_read; } ntfs_attr_close(attr); free(buffer); return 0; } /** * main - Begin here * * Start from here. * * Return: 0 Success, the program worked * 1 Error, something went wrong */ int main(int argc, char *argv[]) { ntfs_volume *vol; ntfs_inode *inode; ATTR_TYPES attr; int res; int result = 1; ntfs_log_set_handler(ntfs_log_handler_stderr); res = parse_options(argc, argv); if (res >= 0) return (res); utils_set_locale(); vol = utils_mount_volume(opts.device, NTFS_MNT_RDONLY | (opts.force ? NTFS_MNT_RECOVER : 0)); if (!vol) { ntfs_log_perror("ERROR: couldn't mount volume"); return 1; } if (opts.inode != -1) inode = ntfs_inode_open(vol, opts.inode); else { #ifdef HAVE_WINDOWS_H char *unix_name; unix_name = ntfs_utils_unix_path(opts.file); if (unix_name) { inode = ntfs_pathname_to_inode(vol, NULL, unix_name); free(unix_name); } else inode = (ntfs_inode*)NULL; #else inode = ntfs_pathname_to_inode(vol, NULL, opts.file); #endif } if (!inode) { ntfs_log_perror("ERROR: Couldn't open inode"); return 1; } attr = AT_DATA; if (opts.attr != const_cpu_to_le32(-1)) attr = opts.attr; result = cat(vol, inode, attr, opts.attr_name, opts.attr_name_len); ntfs_inode_close(inode); ntfs_umount(vol, FALSE); return result; } ntfsprogs-plus-1.0.0/src/deprecated/ntfscat.h000066400000000000000000000030261507404161300212220ustar00rootroot00000000000000/* * ntfscat - Part of the Linux-NTFS project. * * Copyright (c) 2003 Richard Russon * Copyright (c) 2003 Anton Altaparmakov * * This utility will concatenate files and print on the standard output. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFSCAT_H_ #define _NTFSCAT_H_ #include "types.h" #include "layout.h" struct options { char *device; /* Device/File to work with */ char *file; /* File to display */ s64 inode; /* Inode to work with */ ATTR_TYPES attr; /* Attribute type to display */ ntfschar *attr_name; /* Attribute name to display */ int attr_name_len; /* Attribute name length */ int force; /* Override common sense */ int quiet; /* Less output */ int verbose; /* Extra output */ BOOL raw; /* Raw data output */ }; #endif /* _NTFSCAT_H_ */ ntfsprogs-plus-1.0.0/src/deprecated/ntfscmp.8.in000066400000000000000000000040021507404161300215520ustar00rootroot00000000000000.\" Copyright (c) 2005\-2006 Szabolcs Szakacsits. .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSCMP 8 "April 2006" "ntfs-3g @VERSION@" .SH NAME ntfscmp \- compare two NTFS filesystems and tell the differences .SH SYNOPSIS .B ntfscmp [\fIOPTIONS\fR] .I DEVICE1 .I DEVICE2 .br .SH DESCRIPTION The .B ntfscmp program makes a comparison between two NTFS filesystems from all aspects and reports all variances it finds. The filesystems can be on block devices or images files. Ntfscmp can be used for volume verification however its primary purpose was to be an efficient development tool, used to quickly locate, identify and check the correctness of the metadata changes made to NTFS. If one is interested only in the NTFS metadata changes then it could be useful to compare the metadata images created by using the --metadata option of .BR ntfsclone (8) to eliminate the usually uninteresting timestamp changes. The terse output of .B ntfscmp is intentional because the provided information is enough in each case to determine the exact differences. This can be achieved, for instance, if one compares the verbose outputs of .BR ntfsinfo (8) for each reported inodes by the .BR diff (1) utility. .SH OPTIONS Below is a summary of the options that .B ntfscmp accepts. .TP \fB\-P\fR, \fB\-\-no\-progress\-bar\fR Don't show progress bars. .TP \fB\-v\fR, \fB\-\-verbose\fR More informational output. .TP \fB\-h\fR, \fB\-\-help\fR Display help and exit. .SH EXIT CODES The exit code is 0 on success, non\-zero otherwise. .SH KNOWN ISSUES No problem is known. If you would find otherwise then please send your report to the development team: .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHOR .B ntfscmp was written by Szabolcs Szakacsits. It was ported to ntfs-3g by Erik Larsson. .SH AVAILABILITY .B ntfscmp is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO .BR ntfsinfo (8), .BR ntfscat (8), .BR diff (1), .BR ntfsclone (8), .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfscmp.c000066400000000000000000000513351507404161300212330ustar00rootroot00000000000000/** * ntfscmp - Part of the Linux-NTFS project. * * Copyright (c) 2005-2006 Szabolcs Szakacsits * Copyright (c) 2005 Anton Altaparmakov * Copyright (c) 2007 Yura Pakhuchiy * * This utility compare two NTFS volumes. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #include #include #include #include #include #include #include #include "mst.h" #include "support.h" #include "utils.h" #include "misc.h" /* #include "version.h" */ static const char *EXEC_NAME = "ntfscmp"; static const char *invalid_ntfs_msg = "Apparently device '%s' doesn't have a valid NTFS.\n" "Maybe you selected the wrong partition? Or the whole disk instead of a\n" "partition (e.g. /dev/hda, not /dev/hda1)?\n"; static const char *corrupt_volume_msg = "Apparently you have a corrupted NTFS. Please run the filesystem checker\n" "on Windows by invoking chkdsk /f. Don't forget the /f (force) parameter,\n" "it's important! You probably also need to reboot Windows to take effect.\n"; static const char *hibernated_volume_msg = "Apparently the NTFS partition is hibernated. Windows must be resumed and\n" "turned off properly\n"; static struct { int debug; int show_progress; int verbose; char *vol1; char *vol2; } opt; /* WARNING: don't modify the text, external tools grep for it */ #define ERR_PREFIX "ERROR" #define PERR_PREFIX ERR_PREFIX "(%d): " #define NERR_PREFIX ERR_PREFIX ": " __attribute__((format(printf, 2, 3))) static void perr_printf(int newline, const char *fmt, ...) { va_list ap; int eo = errno; fprintf(stdout, PERR_PREFIX, eo); va_start(ap, fmt); vfprintf(stdout, fmt, ap); va_end(ap); fprintf(stdout, ": %s", strerror(eo)); if (newline) fprintf(stdout, "\n"); fflush(stdout); fflush(stderr); } #define perr_print(...) perr_printf(0, __VA_ARGS__) #define perr_println(...) perr_printf(1, __VA_ARGS__) __attribute__((format(printf, 1, 2))) static void err_printf(const char *fmt, ...) { va_list ap; fprintf(stdout, NERR_PREFIX); va_start(ap, fmt); vfprintf(stdout, fmt, ap); va_end(ap); fflush(stdout); fflush(stderr); } /** * err_exit * * Print and error message and exit the program. */ __attribute__((noreturn)) __attribute__((format(printf, 1, 2))) static int err_exit(const char *fmt, ...) { va_list ap; fprintf(stdout, NERR_PREFIX); va_start(ap, fmt); vfprintf(stdout, fmt, ap); va_end(ap); fflush(stdout); fflush(stderr); exit(1); } /** * perr_exit * * Print and error message and exit the program */ __attribute__((noreturn)) __attribute__((format(printf, 1, 2))) static int perr_exit(const char *fmt, ...) { va_list ap; int eo = errno; fprintf(stdout, PERR_PREFIX, eo); va_start(ap, fmt); vfprintf(stdout, fmt, ap); va_end(ap); printf(": %s\n", strerror(eo)); fflush(stdout); fflush(stderr); exit(1); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ __attribute__((noreturn)) static void usage(void) { printf("\nUsage: %s [OPTIONS] DEVICE1 DEVICE2\n" " Compare two NTFS volumes and tell the differences.\n" "\n" " -P, --no-progress-bar Don't show progress bar\n" " -v, --verbose More output\n" " -h, --help Display this help\n" #ifdef DEBUG " -d, --debug Show debug information\n" #endif "\n", EXEC_NAME); printf("%s%s", ntfs_bugs, ntfs_home); exit(1); } static void parse_options(int argc, char **argv) { static const char *sopt = "-dhPv"; static const struct option lopt[] = { #ifdef DEBUG { "debug", no_argument, NULL, 'd' }, #endif { "help", no_argument, NULL, 'h' }, { "no-progress-bar", no_argument, NULL, 'P' }, { "verbose", no_argument, NULL, 'v' }, { NULL, 0, NULL, 0 } }; int c; memset(&opt, 0, sizeof(opt)); opt.show_progress = 1; while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opt.vol1) { opt.vol1 = argv[optind - 1]; } else if (!opt.vol2) { opt.vol2 = argv[optind - 1]; } else { err_printf("Too many arguments!\n"); usage(); } break; #ifdef DEBUG case 'd': opt.debug++; break; #endif case 'h': case '?': usage(); case 'P': opt.show_progress = 0; break; case 'v': opt.verbose++; break; default: err_printf("Unknown option '%s'.\n", argv[optind - 1]); usage(); break; } } if (opt.vol1 == NULL || opt.vol2 == NULL) { err_printf("You must specify exactly 2 volumes.\n"); usage(); } /* Redirect stderr to stdout, note fflush()es are essential! */ fflush(stdout); fflush(stderr); if (dup2(STDOUT_FILENO, STDERR_FILENO) == -1) { perror("Failed to redirect stderr to stdout"); exit(1); } fflush(stdout); fflush(stderr); #ifdef DEBUG if (!opt.debug) if (!freopen("/dev/null", "w", stderr)) perr_exit("Failed to redirect stderr to /dev/null"); #endif } static ntfs_attr_search_ctx *attr_get_search_ctx(ntfs_inode *ni) { ntfs_attr_search_ctx *ret; if ((ret = ntfs_attr_get_search_ctx(ni, NULL)) == NULL) perr_println("ntfs_attr_get_search_ctx"); return ret; } static u64 inumber(ntfs_inode *ni) { if (ni->nr_extents >= 0) return ni->mft_no; return ni->base_ni->mft_no; } static int inode_close(ntfs_inode *ni) { if (ni == NULL) return 0; if (ntfs_inode_close(ni)) { perr_println("ntfs_inode_close: inode %llu", (unsigned long long)inumber(ni)); return -1; } return 0; } static inline s64 get_nr_mft_records(ntfs_volume *vol) { return vol->mft_na->initialized_size >> vol->mft_record_size_bits; } #define NTFSCMP_OK 0 #define NTFSCMP_INODE_OPEN_ERROR 1 #define NTFSCMP_INODE_OPEN_IO_ERROR 2 #define NTFSCMP_INODE_OPEN_ENOENT_ERROR 3 #define NTFSCMP_EXTENSION_RECORD 4 #define NTFSCMP_INODE_CLOSE_ERROR 5 static const char *ntfscmp_errs[] = { "OK", "INODE_OPEN_ERROR", "INODE_OPEN_IO_ERROR", "INODE_OPEN_ENOENT_ERROR", "EXTENSION_RECORD", "INODE_CLOSE_ERROR", "" }; static const char *err2string(int err) { return ntfscmp_errs[err]; } static const char *pret2str(void *p) { if (p == NULL) return "FAILED"; return "OK"; } static int inode_open(ntfs_volume *vol, MFT_REF mref, ntfs_inode **ni) { *ni = ntfs_inode_open(vol, mref); if (*ni == NULL) { if (errno == EIO) return NTFSCMP_INODE_OPEN_IO_ERROR; if (errno == ENOENT) return NTFSCMP_INODE_OPEN_ENOENT_ERROR; perr_println("Reading inode %lld failed", (long long)mref); return NTFSCMP_INODE_OPEN_ERROR; } if ((*ni)->mrec->base_mft_record) { if (inode_close(*ni) != 0) return NTFSCMP_INODE_CLOSE_ERROR; return NTFSCMP_EXTENSION_RECORD; } return NTFSCMP_OK; } static ntfs_inode *base_inode(ntfs_attr_search_ctx *ctx) { if (ctx->base_ntfs_ino) return ctx->base_ntfs_ino; return ctx->ntfs_ino; } static void print_inode(u64 inum) { printf("Inode %llu ", (unsigned long long)inum); } static void print_inode_ni(ntfs_inode *ni) { print_inode(inumber(ni)); } static void print_attribute_type(ATTR_TYPES atype) { printf("attribute 0x%x", le32_to_cpu(atype)); } static void print_attribute_name(char *name) { if (name) printf(":%s", name); } #define GET_ATTR_NAME(a) \ ((ntfschar *)(((u8 *)(a)) + le16_to_cpu((a)->name_offset))), \ ((a)->name_length) static void free_name(char **name) { if (*name) { free(*name); *name = NULL; } } static char *get_attr_name(u64 mft_no, ATTR_TYPES atype, const ntfschar *uname, const int uname_len) { char *name = NULL; int name_len; if (atype == AT_END) return NULL; name_len = ntfs_ucstombs(uname, uname_len, &name, 0); if (name_len < 0) { perr_print("ntfs_ucstombs"); print_inode(mft_no); print_attribute_type(atype); puts(""); exit(1); } else if (name_len > 0) return name; free_name(&name); return NULL; } static char *get_attr_name_na(ntfs_attr *na) { return get_attr_name(inumber(na->ni), na->type, na->name, na->name_len); } static char *get_attr_name_ctx(ntfs_attr_search_ctx *ctx) { u64 mft_no = inumber(ctx->ntfs_ino); ATTR_TYPES atype = ctx->attr->type; return get_attr_name(mft_no, atype, GET_ATTR_NAME(ctx->attr)); } static void print_attribute(ATTR_TYPES atype, char *name) { print_attribute_type(atype); print_attribute_name(name); printf(" "); } static void print_na(ntfs_attr *na) { char *name = get_attr_name_na(na); print_inode_ni(na->ni); print_attribute(na->type, name); free_name(&name); } static void print_attribute_ctx(ntfs_attr_search_ctx *ctx) { char *name = get_attr_name_ctx(ctx); print_attribute(ctx->attr->type, name); free_name(&name); } static void print_ctx(ntfs_attr_search_ctx *ctx) { char *name = get_attr_name_ctx(ctx); print_inode_ni(base_inode(ctx)); print_attribute(ctx->attr->type, name); free_name(&name); } static void print_differ(ntfs_attr *na) { print_na(na); printf("content: DIFFER\n"); } static int cmp_buffer(u8 *buf1, u8 *buf2, long long int size, ntfs_attr *na) { if (memcmp(buf1, buf2, size)) { print_differ(na); return -1; } return 0; } struct cmp_ia { INDEX_ALLOCATION *ia; INDEX_ALLOCATION *tmp_ia; u8 *bitmap; u8 *byte; s64 bm_size; }; static int setup_cmp_ia(ntfs_attr *na, struct cmp_ia *cia) { cia->bitmap = ntfs_attr_readall(na->ni, AT_BITMAP, na->name, na->name_len, &cia->bm_size); if (!cia->bitmap) { perr_println("Failed to readall BITMAP"); return -1; } cia->byte = cia->bitmap; cia->tmp_ia = cia->ia = ntfs_malloc(na->data_size); if (!cia->tmp_ia) goto free_bm; if (ntfs_attr_pread(na, 0, na->data_size, cia->ia) != na->data_size) { perr_println("Failed to pread INDEX_ALLOCATION"); goto free_ia; } return 0; free_ia: free(cia->ia); free_bm: free(cia->bitmap); return -1; } static void cmp_index_allocation(ntfs_attr *na1, ntfs_attr *na2) { struct cmp_ia cia1, cia2; int bit, ret1, ret2; u32 ib_size; if (setup_cmp_ia(na1, &cia1)) return; if (setup_cmp_ia(na2, &cia2)) return; /* * FIXME: ia can be the same even if the bitmap sizes are different. */ if (cia1.bm_size != cia2.bm_size) goto out; if (cmp_buffer(cia1.bitmap, cia2.bitmap, cia1.bm_size, na1)) goto out; if (cmp_buffer((u8 *)cia1.ia, (u8 *)cia2.ia, 0x18, na1)) goto out; ib_size = le32_to_cpu(cia1.ia->index.allocated_size) + 0x18; bit = 0; while ((u8 *)cia1.tmp_ia < (u8 *)cia1.ia + na1->data_size) { if (*cia1.byte & (1 << bit)) { ret1 = ntfs_mst_post_read_fixup((NTFS_RECORD *) cia1.tmp_ia, ib_size); ret2 = ntfs_mst_post_read_fixup((NTFS_RECORD *) cia2.tmp_ia, ib_size); if (ret1 != ret2) { print_differ(na1); goto out; } if (ret1 == -1) continue; if (cmp_buffer(((u8 *)cia1.tmp_ia) + 0x18, ((u8 *)cia2.tmp_ia) + 0x18, le32_to_cpu(cia1.ia-> index.index_length), na1)) goto out; } cia1.tmp_ia = (INDEX_ALLOCATION *)((u8 *)cia1.tmp_ia + ib_size); cia2.tmp_ia = (INDEX_ALLOCATION *)((u8 *)cia2.tmp_ia + ib_size); bit++; if (bit > 7) { bit = 0; cia1.byte++; } } out: free(cia1.ia); free(cia2.ia); free(cia1.bitmap); free(cia2.bitmap); return; } static void cmp_attribute_data(ntfs_attr *na1, ntfs_attr *na2) { s64 pos; s64 count1 = 0, count2; u8 buf1[NTFS_BUF_SIZE]; u8 buf2[NTFS_BUF_SIZE]; for (pos = 0; pos <= na1->data_size; pos += count1) { count1 = ntfs_attr_pread(na1, pos, NTFS_BUF_SIZE, buf1); count2 = ntfs_attr_pread(na2, pos, NTFS_BUF_SIZE, buf2); if (count1 != count2) { print_na(na1); printf("abrupt length: %lld != %lld ", (long long)na1->data_size, (long long)na2->data_size); printf("(count: %lld != %lld)", (long long)count1, (long long)count2); puts(""); return; } if (count1 == -1) { err_printf("%s read error: ", __FUNCTION__); print_na(na1); printf("len = %lld, pos = %lld\n", (long long)na1->data_size, (long long)pos); exit(1); } if (count1 == 0) { if (pos + count1 == na1->data_size) return; /* we are ready */ err_printf("%s read error before EOF: ", __FUNCTION__); print_na(na1); printf("%lld != %lld\n", (long long)pos + count1, (long long)na1->data_size); exit(1); } if (cmp_buffer(buf1, buf2, count1, na1)) return; } err_printf("%s read overrun: ", __FUNCTION__); print_na(na1); err_printf("(len = %lld, pos = %lld, count = %lld)\n", (long long)na1->data_size, (long long)pos, (long long)count1); exit(1); } static int cmp_attribute_header(ATTR_RECORD *a1, ATTR_RECORD *a2) { u32 header_size = offsetof(ATTR_RECORD, resident_end); if (a1->non_resident != a2->non_resident) return 1; if (a1->non_resident) { /* * FIXME: includes paddings which are not handled by ntfsinfo! */ header_size = le32_to_cpu(a1->length); } return memcmp(a1, a2, header_size); } static void cmp_attribute(ntfs_attr_search_ctx *ctx1, ntfs_attr_search_ctx *ctx2) { ATTR_RECORD *a1 = ctx1->attr; ATTR_RECORD *a2 = ctx2->attr; ntfs_attr *na1, *na2; if (cmp_attribute_header(a1, a2)) { print_ctx(ctx1); printf("header: DIFFER\n"); } na1 = ntfs_attr_open(base_inode(ctx1), a1->type, GET_ATTR_NAME(a1)); na2 = ntfs_attr_open(base_inode(ctx2), a2->type, GET_ATTR_NAME(a2)); if ((!na1 && na2) || (na1 && !na2)) { print_ctx(ctx1); printf("open: %s != %s\n", pret2str(na1), pret2str(na2)); goto close_attribs; } if (na1 == NULL) goto close_attribs; if (na1->data_size != na2->data_size) { print_na(na1); printf("length: %lld != %lld\n", (long long)na1->data_size, (long long)na2->data_size); goto close_attribs; } if (ntfs_inode_badclus_bad(inumber(ctx1->ntfs_ino), ctx1->attr) == 1) { /* * If difference exists then it's already reported at the * attribute header since the mapping pairs must differ. */ goto close_attribs; } if (na1->type == AT_INDEX_ALLOCATION) cmp_index_allocation(na1, na2); else cmp_attribute_data(na1, na2); close_attribs: ntfs_attr_close(na1); ntfs_attr_close(na2); } static void vprint_attribute(ATTR_TYPES atype, char *name) { if (!opt.verbose) return; printf("0x%x", le32_to_cpu(atype)); if (name) printf(":%s", name); printf(" "); } static void print_attributes(ntfs_inode *ni, ATTR_TYPES atype1, ATTR_TYPES atype2, char *name1, char *name2) { if (!opt.verbose) return; printf("Walking inode %llu attributes: ", (unsigned long long)inumber(ni)); vprint_attribute(atype1, name1); vprint_attribute(atype2, name2); printf("\n"); } static int new_name(ntfs_attr_search_ctx *ctx, char *prev_name) { int ret = 0; char *name = get_attr_name_ctx(ctx); if (prev_name && name) { if (strcmp(prev_name, name) != 0) ret = 1; } else if (prev_name || name) ret = 1; free_name(&name); return ret; } static int new_attribute(ntfs_attr_search_ctx *ctx, ATTR_TYPES prev_atype, char *prev_name) { if (!prev_atype && !prev_name) return 1; if (!ctx->attr->non_resident) return 1; if (prev_atype != ctx->attr->type) return 1; if (new_name(ctx, prev_name)) return 1; if (opt.verbose) { print_inode(base_inode(ctx)->mft_no); print_attribute_ctx(ctx); printf("record %llu lowest_vcn %lld: SKIPPED\n", (unsigned long long)ctx->ntfs_ino->mft_no, (long long)sle64_to_cpu(ctx->attr->lowest_vcn)); } return 0; } static void set_prev(char **prev_name, ATTR_TYPES *prev_atype, char *name, ATTR_TYPES atype) { free_name(prev_name); if (name) { *prev_name = strdup(name); if (!*prev_name) perr_exit("strdup error"); } *prev_atype = atype; } static void set_cmp_attr(ntfs_attr_search_ctx *ctx, ATTR_TYPES *atype, char **name) { *atype = ctx->attr->type; free_name(name); *name = get_attr_name_ctx(ctx); } static int next_attr(ntfs_attr_search_ctx *ctx, ATTR_TYPES *atype, char **name, int *err) { int ret; ret = ntfs_attrs_walk(ctx); *err = errno; if (ret) { *atype = AT_END; free_name(name); } else set_cmp_attr(ctx, atype, name); return ret; } static int cmp_attributes(ntfs_inode *ni1, ntfs_inode *ni2) { int ret = -1; int old_ret1, ret1 = 0, ret2 = 0; int errno1 = 0, errno2 = 0; char *prev_name = NULL, *name1 = NULL, *name2 = NULL; ATTR_TYPES old_atype1, prev_atype = const_cpu_to_le32(0), atype1, atype2; ntfs_attr_search_ctx *ctx1, *ctx2; if (!(ctx1 = attr_get_search_ctx(ni1))) return -1; if (!(ctx2 = attr_get_search_ctx(ni2))) goto out; set_cmp_attr(ctx1, &atype1, &name1); set_cmp_attr(ctx2, &atype2, &name2); while (1) { old_atype1 = atype1; old_ret1 = ret1; if (!ret1 && (le32_to_cpu(atype1) <= le32_to_cpu(atype2) || ret2)) ret1 = next_attr(ctx1, &atype1, &name1, &errno1); if (!ret2 && (le32_to_cpu(old_atype1) >= le32_to_cpu(atype2) || old_ret1)) ret2 = next_attr(ctx2, &atype2, &name2, &errno2); print_attributes(ni1, atype1, atype2, name1, name2); if (ret1 && ret2) { if (errno1 != errno2) { print_inode_ni(ni1); printf("attribute walk (errno): %d != %d\n", errno1, errno2); } break; } if (ret2 || le32_to_cpu(atype1) < le32_to_cpu(atype2)) { if (new_attribute(ctx1, prev_atype, prev_name)) { print_ctx(ctx1); printf("presence: EXISTS != MISSING\n"); set_prev(&prev_name, &prev_atype, name1, atype1); } } else if (ret1 || le32_to_cpu(atype1) > le32_to_cpu(atype2)) { if (new_attribute(ctx2, prev_atype, prev_name)) { print_ctx(ctx2); printf("presence: MISSING != EXISTS \n"); set_prev(&prev_name, &prev_atype, name2, atype2); } } else /* atype1 == atype2 */ { if (new_attribute(ctx1, prev_atype, prev_name)) { cmp_attribute(ctx1, ctx2); set_prev(&prev_name, &prev_atype, name1, atype1); } } } free_name(&prev_name); ret = 0; ntfs_attr_put_search_ctx(ctx2); out: ntfs_attr_put_search_ctx(ctx1); return ret; } static int cmp_inodes(ntfs_volume *vol1, ntfs_volume *vol2) { u64 inode; int ret1, ret2; ntfs_inode *ni1, *ni2; struct progress_bar progress; int pb_flags = 0; /* progress bar flags */ u64 nr_mft_records, nr_mft_records2; if (opt.show_progress) pb_flags |= NTFS_PROGBAR; nr_mft_records = get_nr_mft_records(vol1); nr_mft_records2 = get_nr_mft_records(vol2); if (nr_mft_records != nr_mft_records2) { printf("Number of mft records: %lld != %lld\n", (long long)nr_mft_records, (long long)nr_mft_records2); if (nr_mft_records > nr_mft_records2) nr_mft_records = nr_mft_records2; } progress_init(&progress, 0, nr_mft_records - 1, 100, pb_flags); progress_update(&progress, 0); for (inode = 0; inode < nr_mft_records; inode++) { ret1 = inode_open(vol1, (MFT_REF)inode, &ni1); ret2 = inode_open(vol2, (MFT_REF)inode, &ni2); if (ret1 != ret2) { print_inode(inode); printf("open: %s != %s\n", err2string(ret1), err2string(ret2)); goto close_inodes; } if (ret1 != NTFSCMP_OK) goto close_inodes; if (cmp_attributes(ni1, ni2) != 0) { inode_close(ni1); inode_close(ni2); return -1; } close_inodes: if (inode_close(ni1) != 0) return -1; if (inode_close(ni2) != 0) return -1; progress_update(&progress, inode); } return 0; } static ntfs_volume *mount_volume(const char *volume) { unsigned long mntflag; ntfs_volume *vol = NULL; if (ntfs_check_if_mounted(volume, &mntflag)) { perr_println("Failed to check '%s' mount state", volume); printf("Probably /etc/mtab is missing. It's too risky to " "continue. You might try\nan another Linux distro.\n"); exit(1); } if (mntflag & NTFS_MF_MOUNTED) { if (!(mntflag & NTFS_MF_READONLY)) err_exit("Device '%s' is mounted read-write. " "You must 'umount' it first.\n", volume); } vol = ntfs_mount(volume, NTFS_MNT_RDONLY); if (vol == NULL) { int err = errno; perr_println("Opening '%s' as NTFS failed", volume); if (err == EINVAL) printf(invalid_ntfs_msg, volume); else if (err == EIO) puts(corrupt_volume_msg); else if (err == EPERM) puts(hibernated_volume_msg); exit(1); } return vol; } int main(int argc, char **argv) { ntfs_volume *vol1; ntfs_volume *vol2; printf("%s v%s (libntfs-3g)\n", EXEC_NAME, VERSION); parse_options(argc, argv); utils_set_locale(); vol1 = mount_volume(opt.vol1); vol2 = mount_volume(opt.vol2); if (cmp_inodes(vol1, vol2) != 0) exit(1); ntfs_umount(vol1, FALSE); ntfs_umount(vol2, FALSE); return (0); } ntfsprogs-plus-1.0.0/src/deprecated/ntfscp.8.in000066400000000000000000000075671507404161300214200ustar00rootroot00000000000000.\" Copyright (c) 2004\-2007 Yura Pakhuchiy. .\" Copyright (c) 2005 Richard Russon. .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSCP 8 "September 2007" "ntfs-3g @VERSION@" .SH NAME ntfscp \- copy file to an NTFS volume. .SH SYNOPSIS \fBntfscp\fR [\fIoptions\fR] \fIdevice source_file destination\fR .SH DESCRIPTION \fBntfscp\fR will copy file to an NTFS volume. \fIdestination\fR can be either file or directory. In case if \fIdestination\fR is directory specified by name then \fIsource_file\fR is copied into this directory, in case if \fIdestination\fR is directory and specified by inode number then unnamed data attribute is created for this inode and \fIsource_file\fR is copied into it (WARNING: it's unusual to have unnamed data streams in the directories, think twice before specifying directory by inode number). .SH OPTIONS Below is a summary of all the options that .B ntfscp accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-a\fR, \fB\-\-attribute\fR NUM Write to this attribute. .TP \fB\-i\fR, \fB\-\-inode\fR Treat .I destination as inode number. .TP \fB\-m\fR, \fB\-\-min-fragments\fR Minimize fragmentation when allocating space to the attribute. This is mostly useful when creating big files. .TP \fB\-N\fR, \fB\-\-attr\-name\fR NAME Write to attribute with this name. .TP \fB\-n\fR, \fB\-\-no\-action\fR Use this option to make a test run before doing the real copy operation. Volume will be opened read\-only and no write will be done. .TP \fB\-f\fR, \fB\-\-force\fR This will override some sensible defaults, such as not working with a mounted volume. Use this option with caution. .TP \fB\-h\fR, \fB\-\-help\fR Show a list of options with a brief description of each one. .TP \fB\-q\fR, \fB\-\-quiet\fR Suppress some debug/warning/error messages. .TP \fB\-t\fR, \fB\-\-timestamp\fR Copy the modification time of source_file to destination. This is not compatible with \fB\-\-attr\-name\fR and \fB\-\-attribute\fR. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license .BR ntfscp . .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .SH DATA STREAMS All data on NTFS is stored in streams, which can have names. A file can have more than one data streams, but exactly one must have no name. The size of a file is the size of its unnamed data stream. Usually when you don't specify stream name you are access to unnamed data stream. If you want access to named data stream you need to add ":stream_name" to the filename. For example: by opening "some.mp3:artist" you will open stream "artist" in "some.mp3". But windows usually prevent you from accessing to named data streams, so you need to use some program like FAR or utils from cygwin to access named data streams. .SH EXAMPLES Copy new_boot.ini from /home/user as boot.ini to the root of an /dev/hda1 NTFS volume: .RS .sp .B ntfscp /dev/hda1 /home/user/new_boot.ini boot.ini .sp .RE Copy myfile to C:\\some\\path\\myfile:stream (assume that /dev/hda1 letter in windows is C): .RS .sp .B ntfscp \-N stream /dev/hda1 myfile /some/path .sp .RE .SH BUGS There are no known problems with \fBntfscp\fR. If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS \fBntfscp\fR was written by Yura Pakhuchiy, with contributions from Anton Altaparmakov and Hil Liao. It was ported to ntfs-3g by Erik Larsson. .SH DEDICATION With love to Marina Sapego. .SH AVAILABILITY .B ntfscp is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g .hy .SH SEE ALSO .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfscp.c000066400000000000000000000704031507404161300210530ustar00rootroot00000000000000/** * ntfscp - Part of the Linux-NTFS project. * * Copyright (c) 2004-2007 Yura Pakhuchiy * Copyright (c) 2005 Anton Altaparmakov * Copyright (c) 2006 Hil Liao * Copyright (c) 2014-2019 Jean-Pierre Andre * * This utility will copy file to an NTFS volume. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #include #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_LIBGEN_H #include #endif #include "types.h" #include "attrib.h" #include "utils.h" #include "volume.h" #include "dir.h" #include "bitmap.h" #include "debug.h" /* #include "version.h" */ #include "logging.h" #include "ntfstime.h" #include "misc.h" struct options { char *device; /* Device/File to work with */ char *src_file; /* Source file */ char *dest_file; /* Destination file */ char *attr_name; /* Write to attribute with this name. */ int force; /* Override common sense */ int quiet; /* Less output */ int verbose; /* Extra output */ int minfragments; /* Do minimal fragmentation */ int timestamp; /* Copy the modification time */ int noaction; /* Do not write to disk */ ATTR_TYPES attribute; /* Write to this attribute. */ int inode; /* Treat dest_file as inode number. */ }; struct ALLOC_CONTEXT { ntfs_volume *vol; ntfs_attr *na; runlist_element *rl; unsigned char *buf; s64 gathered_clusters; s64 wanted_clusters; s64 new_size; s64 lcn; int rl_allocated; int rl_count; } ; enum STEP { STEP_ERR, STEP_ZERO, STEP_ONE } ; static const char *EXEC_NAME = "ntfscp"; static struct options opts; static volatile sig_atomic_t caught_terminate = 0; /** * version - Print version information about the program * * Print a copyright statement and a brief description of the program. * * Return: none */ static void version(void) { ntfs_log_info("\n%s v%s (libntfs-3g) - Copy file to an NTFS " "volume.\n\n", EXEC_NAME, VERSION); ntfs_log_info("Copyright (c) 2004-2007 Yura Pakhuchiy\n"); ntfs_log_info("Copyright (c) 2005 Anton Altaparmakov\n"); ntfs_log_info("Copyright (c) 2006 Hil Liao\n"); ntfs_log_info("Copyright (c) 2014 Jean-Pierre Andre\n"); ntfs_log_info("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ static void usage(void) { ntfs_log_info("\nUsage: %s [options] device src_file dest_file\n\n" " -a, --attribute NUM Write to this attribute\n" " -i, --inode Treat dest_file as inode number\n" " -f, --force Use less caution\n" " -h, --help Print this help\n" " -m, --min_fragments Do minimal fragmentation\n" " -N, --attr-name NAME Write to attribute with this name\n" " -n, --no-action Do not write to disk\n" " -q, --quiet Less output\n" " -t, --timestamp Copy the modification time\n" " -V, --version Version information\n" " -v, --verbose More output\n\n", EXEC_NAME); ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home); } /** * parse_options - Read and validate the programs command line * * Read the command line, verify the syntax and parse the options. * This function is very long, but quite simple. * * Return: 1 Success * 0 Error, one or more problems */ static int parse_options(int argc, char **argv) { static const char *sopt = "-a:ifh?mN:no:qtVv"; static const struct option lopt[] = { { "attribute", required_argument, NULL, 'a' }, { "inode", no_argument, NULL, 'i' }, { "force", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "min-fragments", no_argument, NULL, 'm' }, { "attr-name", required_argument, NULL, 'N' }, { "no-action", no_argument, NULL, 'n' }, { "quiet", no_argument, NULL, 'q' }, { "timestamp", no_argument, NULL, 't' }, { "version", no_argument, NULL, 'V' }, { "verbose", no_argument, NULL, 'v' }, { NULL, 0, NULL, 0 } }; char *s; int c = -1; int err = 0; int ver = 0; int help = 0; int levels = 0; s64 attr; opts.device = NULL; opts.src_file = NULL; opts.dest_file = NULL; opts.attr_name = NULL; opts.inode = 0; opts.attribute = AT_DATA; opts.timestamp = 0; opterr = 0; /* We'll handle the errors, thank you. */ while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opts.device) { opts.device = argv[optind - 1]; } else if (!opts.src_file) { opts.src_file = argv[optind - 1]; } else if (!opts.dest_file) { opts.dest_file = argv[optind - 1]; } else { ntfs_log_error("You must specify exactly two " "files.\n"); err++; } break; case 'a': if (opts.attribute != AT_DATA) { ntfs_log_error("You can specify only one " "attribute.\n"); err++; break; } attr = strtol(optarg, &s, 0); if (*s) { ntfs_log_error("Couldn't parse attribute.\n"); err++; } else opts.attribute = (ATTR_TYPES)cpu_to_le32(attr); break; case 'i': opts.inode++; break; case 'f': opts.force++; break; case 'h': help++; break; case 'm': opts.minfragments++; break; case 'N': if (opts.attr_name) { ntfs_log_error("You can specify only one " "attribute name.\n"); err++; } else opts.attr_name = argv[optind - 1]; break; case 'n': opts.noaction++; break; case 'q': opts.quiet++; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 't': opts.timestamp++; break; case 'V': ver++; break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case '?': if (strncmp(argv[optind - 1], "--log-", 6) == 0) { if (!ntfs_log_parse_option(argv[optind - 1])) err++; break; } /* fall through */ default: ntfs_log_error("Unknown option '%s'.\n", argv[optind - 1]); err++; break; } } /* Make sure we're in sync with the log levels */ levels = ntfs_log_get_levels(); if (levels & NTFS_LOG_LEVEL_VERBOSE) opts.verbose++; if (!(levels & NTFS_LOG_LEVEL_QUIET)) opts.quiet++; if (help || ver) { opts.quiet = 0; } else { if (!opts.device) { ntfs_log_error("You must specify a device.\n"); err++; } else if (!opts.src_file) { ntfs_log_error("You must specify a source file.\n"); err++; } else if (!opts.dest_file) { ntfs_log_error("You must specify a destination " "file.\n"); err++; } if (opts.quiet && opts.verbose) { ntfs_log_error("You may not use --quiet and --verbose " "at the same time.\n"); err++; } if (opts.timestamp && (opts.attr_name || (opts.attribute != AT_DATA))) { ntfs_log_error("Setting --timestamp is only possible" " with unname data attribute.\n"); err++; } } if (ver) version(); if (help || err) usage(); /* tri-state 0 : done, 1 : error, -1 : proceed */ return (err ? 1 : (help || ver ? 0 : -1)); } /** * signal_handler - Handle SIGINT and SIGTERM: abort write, sync and exit. */ static void signal_handler(int arg __attribute__((unused))) { caught_terminate++; } /* * Search for the next '0' in a bitmap chunk * * Returns the position of next '0' * or -1 if there are no more '0's */ static int next_zero(struct ALLOC_CONTEXT *alctx, s32 bufpos, s32 count) { s32 index; unsigned int q,b; index = -1; while ((index < 0) && (bufpos < count)) { q = alctx->buf[bufpos >> 3]; if (q == 255) bufpos = (bufpos | 7) + 1; else { b = bufpos & 7; while ((b < 8) && ((1 << b) & q)) b++; if (b < 8) { index = (bufpos & -8) | b; } else { bufpos = (bufpos | 7) + 1; } } } return (index); } /* * Search for the next '1' in a bitmap chunk * * Returns the position of next '1' * or -1 if there are no more '1's */ static int next_one(struct ALLOC_CONTEXT *alctx, s32 bufpos, s32 count) { s32 index; unsigned int q,b; index = -1; while ((index < 0) && (bufpos < count)) { q = alctx->buf[bufpos >> 3]; if (q == 0) bufpos = (bufpos | 7) + 1; else { b = bufpos & 7; while ((b < 8) && !((1 << b) & q)) b++; if (b < 8) { index = (bufpos & -8) | b; } else { bufpos = (bufpos | 7) + 1; } } } return (index); } /* * Allocate a bigger runlist when needed * * The allocation is done by multiple of 4096 entries to avoid * frequent reallocations. * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int run_alloc(struct ALLOC_CONTEXT *alctx, s32 count) { runlist_element *prl; int err; err = 0; if (count > alctx->rl_allocated) { prl = (runlist_element*)ntfs_malloc( (alctx->rl_allocated + 4096)*sizeof(runlist_element)); if (prl) { if (alctx->rl) { memcpy(prl, alctx->rl, alctx->rl_allocated *sizeof(runlist_element)); free(alctx->rl); } alctx->rl = prl; alctx->rl_allocated += 4096; } else err = -1; } return (err); } /* * Merge a new run into the current optimal runlist * * The new run is inserted only if it leads to improving the runlist. * Runs in the current list are dropped when inserting the new one * make them unneeded. * The current runlist is sorted by run sizes, and there is no * terminator. * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int merge_run(struct ALLOC_CONTEXT *alctx, s64 lcn, s32 count) { s64 excess; BOOL replace; int k; int drop; int err; err = 0; if (alctx->rl_count) { excess = alctx->gathered_clusters + count - alctx->wanted_clusters; if (alctx->rl_count > 1) /* replace if we can reduce the number of runs */ replace = excess > (alctx->rl[0].length + alctx->rl[1].length); else /* replace if we can shorten a single run */ replace = (excess > alctx->rl[0].length) && (count < alctx->rl[0].length); } else replace = FALSE; if (replace) { /* Using this run, we can now drop smaller runs */ drop = 0; excess = alctx->gathered_clusters + count - alctx->wanted_clusters; /* Compute how many clusters we can drop */ while ((drop < alctx->rl_count) && (alctx->rl[drop].length <= excess)) { excess -= alctx->rl[drop].length; drop++; } k = 0; while (((k + drop) < alctx->rl_count) && (alctx->rl[k + drop].length < count)) { alctx->rl[k] = alctx->rl[k + drop]; k++; } alctx->rl[k].length = count; alctx->rl[k].lcn = lcn; if (drop > 1) { while ((k + drop) < alctx->rl_count) { alctx->rl[k + 1] = alctx->rl[k + drop]; k++; } } alctx->rl_count -= (drop - 1); alctx->gathered_clusters = alctx->wanted_clusters + excess; } else { if (alctx->gathered_clusters < alctx->wanted_clusters) { /* We had not gathered enough clusters */ if (!run_alloc(alctx, alctx->rl_count + 1)) { k = alctx->rl_count - 1; while ((k >= 0) && (alctx->rl[k].length > count)) { alctx->rl[k+1] = alctx->rl[k]; k--; } alctx->rl[k+1].length = count; alctx->rl[k+1].lcn = lcn; alctx->rl_count++; alctx->gathered_clusters += count; } } } return (err); } /* * Examine a buffer from the global bitmap * in order to locate free runs of clusters * * Returns STEP_ZERO or STEP_ONE depending on whether the last * bit examined was in a search for '0' or '1'. This must be * put as argument to next examination. * Returns STEP_ERR if there was an error. */ static enum STEP examine_buf(struct ALLOC_CONTEXT *alctx, s64 pos, s64 br, enum STEP step) { s32 count; s64 offbuf; /* first bit available in buf */ s32 bufpos; /* bit index in buf */ s32 index; bufpos = pos & ((alctx->vol->cluster_size << 3) - 1); offbuf = pos - bufpos; while (bufpos < (br << 3)) { if (step == STEP_ZERO) { /* find first zero */ index = next_zero(alctx, bufpos, br << 3); if (index >= 0) { alctx->lcn = offbuf + index; step = STEP_ONE; bufpos = index; } else { bufpos = br << 3; } } else { /* find first one */ index = next_one(alctx, bufpos, br << 3); if (index >= 0) { count = offbuf + index - alctx->lcn; step = STEP_ZERO; bufpos = index; if (merge_run(alctx, alctx->lcn, count)) { step = STEP_ERR; bufpos = br << 3; } } else { bufpos = br << 3; } } } return (step); } /* * Sort the final runlist by lcn's and insert a terminator * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int sort_runlist(struct ALLOC_CONTEXT *alctx) { LCN lcn; VCN vcn; s64 length; BOOL sorted; int err; int k; err = 0; /* This sorting can be much improved... */ do { sorted = TRUE; for (k=0; (k+1)rl_count; k++) { if (alctx->rl[k+1].lcn < alctx->rl[k].lcn) { length = alctx->rl[k].length; lcn = alctx->rl[k].lcn; alctx->rl[k] = alctx->rl[k+1]; alctx->rl[k+1].length = length; alctx->rl[k+1].lcn = lcn; sorted = FALSE; } } } while (!sorted); /* compute the vcns */ vcn = 0; for (k=0; krl_count; k++) { alctx->rl[k].vcn = vcn; vcn += alctx->rl[k].length; } /* Shorten the last run if we got too much */ if (vcn > alctx->wanted_clusters) { k = alctx->rl_count - 1; alctx->rl[k].length -= vcn - alctx->wanted_clusters; vcn = alctx->wanted_clusters; } /* Append terminator */ if (run_alloc(alctx, alctx->rl_count + 1)) err = -1; else { k = alctx->rl_count++; alctx->rl[k].vcn = vcn; alctx->rl[k].length = 0; alctx->rl[k].lcn = LCN_ENOENT; } return (err); } /* * Update the sizes of an attribute * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int set_sizes(struct ALLOC_CONTEXT *alctx, ntfs_attr_search_ctx *ctx) { ntfs_attr *na; ntfs_inode *ni; ATTR_RECORD *attr; na = alctx->na; /* Compute the sizes */ na->data_size = alctx->new_size; na->initialized_size = 0; na->allocated_size = alctx->wanted_clusters << alctx->vol->cluster_size_bits; /* Feed the sizes into the attribute */ attr = ctx->attr; attr->non_resident = 1; attr->data_size = cpu_to_sle64(na->data_size); attr->initialized_size = cpu_to_sle64(na->initialized_size); attr->allocated_size = cpu_to_sle64(na->allocated_size); if (na->data_flags & ATTR_IS_SPARSE) attr->compressed_size = cpu_to_sle64(na->compressed_size); /* Copy the unnamed data attribute sizes to inode */ if ((opts.attribute == AT_DATA) && !na->name_len) { ni = na->ni; ni->data_size = na->data_size; if (na->data_flags & ATTR_IS_SPARSE) { ni->allocated_size = na->compressed_size; ni->flags |= FILE_ATTR_SPARSE_FILE; } else ni->allocated_size = na->allocated_size; } return (0); } /* * Assign a runlist to an attribute and store * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int assign_runlist(struct ALLOC_CONTEXT *alctx) { ntfs_attr *na; ntfs_attr_search_ctx *ctx; int k; int err; err = 0; na = alctx->na; if (na->rl) free(na->rl); na->rl = alctx->rl; /* Allocate the clusters */ for (k=0; ((k + 1) < alctx->rl_count) && !err; k++) { if (ntfs_bitmap_set_run(alctx->vol->lcnbmp_na, alctx->rl[k].lcn, alctx->rl[k].length)) { err = -1; } } na->allocated_size = alctx->wanted_clusters << alctx->vol->cluster_size_bits; NAttrSetNonResident(na); NAttrSetFullyMapped(na); if (err || ntfs_attr_update_mapping_pairs(na, 0)) { err = -1; } else { ctx = ntfs_attr_get_search_ctx(alctx->na->ni, NULL); if (ctx) { if (ntfs_attr_lookup(opts.attribute, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { err = -1; } else { if (set_sizes(alctx, ctx)) err = -1; } } else err = -1; ntfs_attr_put_search_ctx(ctx); } return (err); } /* * Find the runs which minimize fragmentation * * Only the first and second data zones are examined, the MFT zone * is preserved. * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int find_best_runs(struct ALLOC_CONTEXT *alctx) { ntfs_volume *vol; s64 pos; /* bit index in bitmap */ s64 br; /* byte count in buf */ int err; enum STEP step; err = 0; vol = alctx->vol; /* examine the first data zone */ pos = vol->mft_zone_end; br = vol->cluster_size; step = STEP_ZERO; while ((step != STEP_ERR) && (br == vol->cluster_size) && (pos < vol->nr_clusters)) { br = ntfs_attr_pread(vol->lcnbmp_na, (pos >> 3) & -vol->cluster_size, vol->cluster_size, alctx->buf); if (br > 0) { step = examine_buf(alctx, pos, br, step); pos = (pos | ((vol->cluster_size << 3) - 1)) + 1; } } /* examine the second data zone */ pos = 0; br = vol->cluster_size; step = STEP_ZERO; while ((step != STEP_ERR) && (br == vol->cluster_size) && (pos < vol->mft_zone_start)) { br = ntfs_attr_pread(vol->lcnbmp_na, (pos >> 3) & -vol->cluster_size, vol->cluster_size, alctx->buf); if (br > 0) { step = examine_buf(alctx, pos, br, step); pos = (pos | ((vol->cluster_size << 3) - 1)) + 1; } } if (alctx->gathered_clusters < alctx->wanted_clusters) { errno = ENOSPC; ntfs_log_error("Error : not enough space on device\n"); err = -1; } else { if ((step == STEP_ERR) || sort_runlist(alctx)) err = -1; } return (err); } /* * Preallocate clusters with minimal fragmentation * * Returns 0 if successful * -1 otherwise, with errno set accordingly */ static int preallocate(ntfs_attr *na, s64 new_size) { struct ALLOC_CONTEXT *alctx; ntfs_volume *vol; int err; err = 0; vol = na->ni->vol; alctx = (struct ALLOC_CONTEXT*)ntfs_malloc(sizeof(struct ALLOC_CONTEXT)); if (alctx) { alctx->buf = (unsigned char*)ntfs_malloc(vol->cluster_size); if (alctx->buf) { alctx->na = na; alctx->vol = vol; alctx->rl_count = 0; alctx->rl_allocated = 0; alctx->rl = (runlist_element*)NULL; alctx->new_size = new_size; alctx->wanted_clusters = (new_size + vol->cluster_size - 1) >> vol->cluster_size_bits; alctx->gathered_clusters = 0; if (find_best_runs(alctx)) err = -1; if (!err && !opts.noaction) { if (assign_runlist(alctx)) err = -1; } else free(alctx->rl); free(alctx->buf); } else err = -1; free(alctx); } else err = -1; return (err); } /** * Create a regular file under the given directory inode * * It is a wrapper function to ntfs_create(...) * * Return: the created file inode */ static ntfs_inode *ntfs_new_file(ntfs_inode *dir_ni, const char *filename) { ntfschar *ufilename; /* inode to the file that is being created */ ntfs_inode *ni; int ufilename_len; /* ntfs_mbstoucs(...) will allocate memory for ufilename if it's NULL */ ufilename = NULL; ufilename_len = ntfs_mbstoucs(filename, &ufilename); if (ufilename_len == -1) { ntfs_log_perror("ERROR: Failed to convert '%s' to unicode", filename); return NULL; } ni = ntfs_create(dir_ni, const_cpu_to_le32(0), ufilename, ufilename_len, S_IFREG); free(ufilename); return ni; } /** * main - Begin here * * Start from here. * * Return: 0 Success, the program worked * 1 Error, something went wrong */ int main(int argc, char *argv[]) { FILE *in; struct stat st; ntfs_volume *vol; ntfs_inode *out; ntfs_attr *na; int flags = 0; int res; int result = 1; s64 new_size; u64 offset; char *buf; s64 br, bw; ntfschar *attr_name; int attr_name_len = 0; #ifdef HAVE_WINDOWS_H char *unix_name; #endif ntfs_log_set_handler(ntfs_log_handler_stderr); res = parse_options(argc, argv); if (res >= 0) return (res); utils_set_locale(); /* Set SIGINT handler. */ if (signal(SIGINT, signal_handler) == SIG_ERR) { ntfs_log_perror("Failed to set SIGINT handler"); return 1; } /* Set SIGTERM handler. */ if (signal(SIGTERM, signal_handler) == SIG_ERR) { ntfs_log_perror("Failed to set SIGTERM handler"); return 1; } if (opts.noaction) flags = NTFS_MNT_RDONLY; if (opts.force) flags |= NTFS_MNT_RECOVER; vol = utils_mount_volume(opts.device, flags); if (!vol) { ntfs_log_perror("ERROR: couldn't mount volume"); return 1; } if ((vol->flags & VOLUME_IS_DIRTY) && !opts.force) goto umount; NVolSetCompression(vol); /* allow compression */ if (ntfs_volume_get_free_space(vol)) { ntfs_log_perror("ERROR: couldn't get free space"); goto umount; } { struct stat fst; if (stat(opts.src_file, &fst) == -1) { ntfs_log_perror("ERROR: Couldn't stat source file"); goto umount; } new_size = fst.st_size; } ntfs_log_verbose("New file size: %lld\n", (long long)new_size); in = fopen(opts.src_file, "r"); if (!in) { ntfs_log_perror("ERROR: Couldn't open source file"); goto umount; } if (opts.inode) { s64 inode_num; char *s; inode_num = strtoll(opts.dest_file, &s, 0); if (*s) { ntfs_log_error("ERROR: Couldn't parse inode number.\n"); goto close_src; } out = ntfs_inode_open(vol, inode_num); } else { #ifdef HAVE_WINDOWS_H unix_name = ntfs_utils_unix_path(opts.dest_file); if (unix_name) { out = ntfs_pathname_to_inode(vol, NULL, unix_name); } else out = (ntfs_inode*)NULL; #else out = ntfs_pathname_to_inode(vol, NULL, opts.dest_file); #endif } if (!out) { /* Copy the file if the dest_file's parent dir can be opened. */ char *parent_dirname; char *filename; ntfs_inode *dir_ni; ntfs_inode *ni; char *dirname_last_whack; #ifdef HAVE_WINDOWS_H filename = basename(unix_name); parent_dirname = strdup(unix_name); #else filename = basename(opts.dest_file); parent_dirname = strdup(opts.dest_file); #endif if (!parent_dirname) { ntfs_log_perror("strdup() failed"); goto close_src; } dirname_last_whack = strrchr(parent_dirname, '/'); if (dirname_last_whack) { if (dirname_last_whack == parent_dirname) dirname_last_whack[1] = 0; else *dirname_last_whack = 0; dir_ni = ntfs_pathname_to_inode(vol, NULL, parent_dirname); } else { ntfs_log_verbose("Target path does not contain '/'. " "Using root directory as parent.\n"); dir_ni = ntfs_inode_open(vol, FILE_root); } if (dir_ni) { if (!(dir_ni->mrec->flags & MFT_RECORD_IS_DIRECTORY)) { /* Remove the last '/' for estetic reasons. */ dirname_last_whack[0] = 0; ntfs_log_error("The file '%s' already exists " "and is not a directory. " "Aborting.\n", parent_dirname); free(parent_dirname); ntfs_inode_close(dir_ni); goto close_src; } ntfs_log_verbose("Creating a new file '%s' under '%s'" "\n", filename, parent_dirname); ni = ntfs_new_file(dir_ni, filename); ntfs_inode_close(dir_ni); if (!ni) { ntfs_log_perror("Failed to create '%s' under " "'%s'", filename, parent_dirname); free(parent_dirname); goto close_src; } out = ni; } else { ntfs_log_perror("ERROR: Couldn't open '%s'", parent_dirname); free(parent_dirname); goto close_src; } free(parent_dirname); } /* The destination is a directory. */ if ((out->mrec->flags & MFT_RECORD_IS_DIRECTORY) && !opts.inode) { char *filename; char *overwrite_filename; int overwrite_filename_len; ntfs_inode *ni; ntfs_inode *dir_ni; int filename_len; int dest_dirname_len; filename = basename(opts.src_file); dir_ni = out; filename_len = strlen(filename); dest_dirname_len = strlen(opts.dest_file); overwrite_filename_len = filename_len+dest_dirname_len + 2; overwrite_filename = malloc(overwrite_filename_len); if (!overwrite_filename) { ntfs_log_perror("ERROR: Failed to allocate %i bytes " "memory for the overwrite filename", overwrite_filename_len); ntfs_inode_close(out); goto close_src; } #ifdef HAVE_WINDOWS_H strcpy(overwrite_filename, unix_name); #else strcpy(overwrite_filename, opts.dest_file); #endif if (overwrite_filename[dest_dirname_len - 1] != '/') { strcat(overwrite_filename, "/"); } strcat(overwrite_filename, filename); ni = ntfs_pathname_to_inode(vol, dir_ni, overwrite_filename); /* Does a file with the same name exist in the dest dir? */ if (ni) { ntfs_log_verbose("Destination path has a file with " "the same name\nOverwriting the file " "'%s'\n", overwrite_filename); ntfs_inode_close(out); out = ni; } else { ntfs_log_verbose("Creating a new file '%s' under " "'%s'\n", filename, opts.dest_file); ni = ntfs_new_file(dir_ni, filename); ntfs_inode_close(dir_ni); if (!ni) { ntfs_log_perror("ERROR: Failed to create the " "destination file under '%s'", opts.dest_file); free(overwrite_filename); goto close_src; } out = ni; } free(overwrite_filename); } attr_name = ntfs_str2ucs(opts.attr_name, &attr_name_len); if (!attr_name) { ntfs_log_perror("ERROR: Failed to parse attribute name '%s'", opts.attr_name); goto close_dst; } na = ntfs_attr_open(out, opts.attribute, attr_name, attr_name_len); if (!na) { if (errno != ENOENT) { ntfs_log_perror("ERROR: Couldn't open attribute"); goto close_dst; } /* Requested attribute isn't present, add it. */ if (ntfs_attr_add(out, opts.attribute, attr_name, attr_name_len, NULL, 0)) { ntfs_log_perror("ERROR: Couldn't add attribute"); goto close_dst; } na = ntfs_attr_open(out, opts.attribute, attr_name, attr_name_len); if (!na) { ntfs_log_perror("ERROR: Couldn't open just added " "attribute"); goto close_dst; } } ntfs_log_verbose("Old file size: %lld\n", (long long)na->data_size); if (opts.minfragments && NAttrCompressed(na)) { ntfs_log_info("Warning : Cannot avoid fragmentation" " of a compressed attribute\n"); opts.minfragments = 0; } if (na->data_size && opts.minfragments) { if (ntfs_attr_truncate(na, 0)) { ntfs_log_perror( "ERROR: Couldn't truncate existing attribute"); goto close_attr; } } if (na->data_size != new_size) { if (opts.minfragments) { /* * Do a standard truncate() to check whether the * attribute has to be made non-resident. * If still resident, preallocation is not needed. */ if (ntfs_attr_truncate(na, new_size)) { ntfs_log_perror( "ERROR: Couldn't resize attribute"); goto close_attr; } if (NAttrNonResident(na) && preallocate(na, new_size)) { ntfs_log_perror( "ERROR: Couldn't preallocate attribute"); goto close_attr; } } else { if (ntfs_attr_truncate_solid(na, new_size)) { ntfs_log_perror( "ERROR: Couldn't resize attribute"); goto close_attr; } } } buf = malloc(NTFS_BUF_SIZE); if (!buf) { ntfs_log_perror("ERROR: malloc failed"); goto close_attr; } ntfs_log_verbose("Starting write.\n"); offset = 0; while (!feof(in)) { if (caught_terminate) { ntfs_log_error("SIGTERM or SIGINT received. " "Aborting write.\n"); break; } br = fread(buf, 1, NTFS_BUF_SIZE, in); if (!br) { if (!feof(in)) ntfs_log_perror("ERROR: fread failed"); break; } bw = ntfs_attr_pwrite(na, offset, br, buf); if (bw != br) { ntfs_log_perror("ERROR: ntfs_attr_pwrite failed"); break; } offset += bw; } if ((na->data_flags & ATTR_COMPRESSION_MASK) && ntfs_attr_pclose(na)) ntfs_log_perror("ERROR: ntfs_attr_pclose failed"); ntfs_log_verbose("Syncing.\n"); result = 0; free(buf); close_attr: ntfs_attr_close(na); if (opts.timestamp) { if (!fstat(fileno(in),&st)) { s64 change_time = st.st_mtime*10000000LL + NTFS_TIME_OFFSET; out->last_data_change_time = cpu_to_sle64(change_time); ntfs_inode_update_times(out, 0); } else { ntfs_log_error("Failed to get the time stamp.\n"); } } close_dst: while (ntfs_inode_close(out) && !opts.noaction) { if (errno != EBUSY) { ntfs_log_error("Sync failed. Run chkdsk.\n"); break; } ntfs_log_error("Device busy. Will retry sync in 3 seconds.\n"); sleep(3); } close_src: fclose(in); umount: ntfs_umount(vol, FALSE); ntfs_log_verbose("Done.\n"); return result; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsdecrypt.8.in000066400000000000000000000106571507404161300224620ustar00rootroot00000000000000.\" Copyright (c) 2014 Jean-Pierre Andre .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSDECRYPT 8 "June 2014" "ntfs-3g @VERSION@" .SH NAME ntfsdecrypt \- decrypt or update NTFS files encrypted according to EFS .SH SYNOPSIS \fBntfsdecrypt\fR [\fIoptions\fR] -k \fIkey.pfx \fIdevice file\fR .SH DESCRIPTION .B ntfsdecrypt decrypts a file from an unmounted device and print the decrypted data on the standard output. It can also update an encrypted file with the encryption key unchanged. .PP The NTFS file encryption (known as EFS) uses a two-level encryption : first, the file contents is encrypted with a random symmetric key, then this symmetric key is encrypted with the public keys of each of the users allowed to decrypt the file (RSA public key encryptions). .P Three symmetric encryption modes are currently implemented in ntfsdecrypt : DESX (a DES variant), 3DES (triple DES) and AES_256 (an AES variant). .P All the encrypted symmetric keys are stored along with the file in a special extended attribute named "$LOGGED_UTILITY_STREAM". Usually, at least two users are allowed to read the file : its owner and the recovery manager who is able to decrypt all the files in a company. When backing up an encrypted file, it is important to also backup the corresponding $LOGGED_UTILITY_STREAM, otherwise the file cannot be decrypted, even by the recovery manager. Also note that encrypted files are slightly bigger than apparent, and the option "efs_raw" has to be used when backing up encrypted files with ntfs-3g. .P When ntfsdecrypt is used to update a file, the keys and the $LOGGED_UTILITY_STREAM are kept unchanged, so a single key file has to be designated. .P Note : the EFS encryption is only available in professional versions of Windows; .SH OPTIONS Below is a summary of all the options that .B ntfsdecrypt accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-i\fR, \fB\-\-inode\fR NUM Display or update the contents of a file designated through its inode number instead of its name. .TP \fB\-e\fR, \fB\-\-encrypt\fR Update an existing encrypted file and get the new contents from the standard input. The full public and private key file has to be designated, as the symmetric key is kept unchanged, so the private key is needed to extract it. .TP \fB\-f\fR, \fB\-\-force\fR This will override some sensible defaults, such as not using a mounted volume. Use this option with caution. .TP \fB\-k\fR, \fB\-\-keyfile\-name\fR key.pfx Define the file which contains the public and private keys in PKCS#12 format. This file obviously contains the keys of one of the users allowed to decrypt or update the file. It has to be extracted from Windows in PKCS#12 format (its usual suffix is .p12 or .pfx), and it is protected by a passphrase which has to be typed in for the keys to be extracted. This can be the key file of any user allowed to read the file, including the one of the recovery manager. .TP \fB\-h\fR, \fB\-\-help\fR Show a list of options with a brief description of each one. .TP \fB\-q\fR, \fB\-\-quiet\fR Suppress some debug/warning/error messages. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license of .BR ntfsdecrypt . .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .SH EXAMPLES Display the contents of the file hamlet.doc in the directory Documents of the root of the NTFS file system on the device /dev/sda1 .RS .sp .B ntfsdecrypt -k foo.key /dev/sda1 Documents/hamlet.doc .sp .RE Update the file hamlet.doc .RS .sp .B ntfsdecrypt -k foo.key /dev/sda1 Documents/hamlet.doc < new.doc .sp .RE .SH BUGS There are no known problems with .BR ntfsdecrypt . If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS .B ntfsdecrypt was written by Yuval Fledel, Anton Altaparmakov and Yura Pakhuchiy. It was ported to ntfs-3g by Erik Larsson and upgraded by Jean-Pierre Andre. .SH AVAILABILITY .B ntfsdecrypt is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO Read \fBntfs-3g\fR(8) for details on option efs_raw, .RE .BR ntfscat (8), .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfsdecrypt.c000066400000000000000000001270631507404161300221300ustar00rootroot00000000000000/** * ntfsdecrypt - Decrypt ntfs encrypted files. Part of the Linux-NTFS project. * * Copyright (c) 2005 Yuval Fledel * Copyright (c) 2005-2007 Anton Altaparmakov * Copyright (c) 2007 Yura Pakhuchiy * Copyright (c) 2014-2015 Jean-Pierre Andre * * This utility will decrypt files and print the decrypted data on the standard * output. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #include #include #include "types.h" #include "attrib.h" #include "utils.h" #include "volume.h" #include "debug.h" #include "dir.h" #include "layout.h" /* #include "version.h" */ #include "misc.h" typedef gcry_sexp_t ntfs_rsa_private_key; #define NTFS_SHA1_THUMBPRINT_SIZE 0x14 #define NTFS_CRED_TYPE_CERT_THUMBPRINT const_cpu_to_le32(3) #define NTFS_EFS_CERT_PURPOSE_OID_DDF "1.3.6.1.4.1.311.10.3.4" /* decryption */ #define NTFS_EFS_CERT_PURPOSE_OID_DRF "1.3.6.1.4.1.311.10.3.4.1" /* recovery */ typedef enum { DF_TYPE_UNKNOWN, DF_TYPE_DDF, /* decryption */ DF_TYPE_DRF, /* recovery */ } NTFS_DF_TYPES; /** * enum NTFS_CRYPTO_ALGORITHMS - List of crypto algorithms used by EFS (32 bit) * * To choose which one is used in Windows, create or set the REG_DWORD registry * key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\EFS\ * AlgorithmID to the value of your chosen crypto algorithm, e.g. to use DesX, * set AlgorithmID to 0x6604. * * Note that the Windows versions I have tried so far (all are high crypto * enabled) ignore the AlgorithmID value if it is not one of CALG_3DES, * CALG_DESX, or CALG_AES_256, i.e. you cannot select CALG_DES at all using * this registry key. It would be interesting to check out encryption on one * of the "crippled" crypto Windows versions... */ typedef enum { CALG_DES = const_cpu_to_le32(0x6601), /* If not one of the below three, fall back to standard Des. */ CALG_3DES = const_cpu_to_le32(0x6603), CALG_DESX = const_cpu_to_le32(0x6604), CALG_AES_256 = const_cpu_to_le32(0x6610), } NTFS_CRYPTO_ALGORITHMS; typedef struct { u64 in_whitening, out_whitening; u8 des_key[8]; u64 prev_blk; } ntfs_desx_ctx; /** * struct ntfs_fek - Decrypted, in-memory file encryption key. */ typedef struct { gcry_cipher_hd_t gcry_cipher_hd; le32 alg_id; u8 *key_data; gcry_cipher_hd_t *des_gcry_cipher_hd_ptr; ntfs_desx_ctx desx_ctx; } ntfs_fek; struct options { char *keyfile; /* .pfx file containing the user's private key. */ char *device; /* Device/File to work with */ char *file; /* File to display */ s64 inode; /* Inode to work with */ ATTR_TYPES attr; /* Attribute type to display */ int force; /* Override common sense */ int quiet; /* Less output */ int verbose; /* Extra output */ int encrypt; /* Encrypt */ }; static const char *EXEC_NAME = "ntfsdecrypt"; static struct options opts; static ntfschar EFS[5] = { const_cpu_to_le16('$'), const_cpu_to_le16('E'), const_cpu_to_le16('F'), const_cpu_to_le16('S'), const_cpu_to_le16('\0') }; /** * version - Print version information about the program * * Print a copyright statement and a brief description of the program. * * Return: none */ static void version(void) { ntfs_log_info("\n%s v%s (libntfs-3g) - Decrypt files and print on the " "standard output.\n\n", EXEC_NAME, VERSION); ntfs_log_info("Copyright (c) 2005 Yuval Fledel\n"); ntfs_log_info("Copyright (c) 2005 Anton Altaparmakov\n"); ntfs_log_info("Copyright (c) 2014-2015 Jean-Pierre Andre\n"); ntfs_log_info("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ static void usage(void) { ntfs_log_info("\nUsage: %s [options] -k name.pfx device [file]\n\n" " -i, --inode num Display this inode\n\n" " -k --keyfile name.pfx Use file name as the user's private key file.\n" " -e --encrypt Update an encrypted file\n" " -f --force Use less caution\n" " -h --help Print this help\n" " -q --quiet Less output\n" " -V --version Version information\n" " -v --verbose More output\n\n", EXEC_NAME); ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home); } /** * parse_options - Read and validate the programs command line * * Read the command line, verify the syntax and parse the options. * This function is very long, but quite simple. * * Return: 1 Success * 0 Error, one or more problems */ static int parse_options(int argc, char **argv) { static const char *sopt = "-fh?ei:k:qVv"; static const struct option lopt[] = { {"encrypt", no_argument, NULL, 'e'}, {"force", no_argument, NULL, 'f'}, {"help", no_argument, NULL, 'h'}, {"inode", required_argument, NULL, 'i'}, {"keyfile", required_argument, NULL, 'k'}, {"quiet", no_argument, NULL, 'q'}, {"version", no_argument, NULL, 'V'}, {"verbose", no_argument, NULL, 'v'}, {NULL, 0, NULL, 0} }; int c = -1; int err = 0; int ver = 0; int help = 0; opterr = 0; /* We'll handle the errors, thank you. */ opts.inode = -1; while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opts.device) opts.device = argv[optind - 1]; else if (!opts.file) opts.file = argv[optind - 1]; else { ntfs_log_error("You must specify exactly one " "file.\n"); err++; } break; case 'e': opts.encrypt++; break; case 'f': opts.force++; break; case 'h': help++; break; case 'k': if (!opts.keyfile) opts.keyfile = argv[optind - 1]; else { ntfs_log_error("You must specify exactly one " "key file.\n"); err++; } break; case 'i': if (opts.inode != -1) ntfs_log_error("You must specify exactly one " "inode.\n"); else if (utils_parse_size(optarg, &opts.inode, FALSE)) break; else ntfs_log_error("Couldn't parse inode number.\n"); err++; break; case 'q': opts.quiet++; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'V': ver++; break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case '?': default: ntfs_log_error("Unknown option '%s'.\n", argv[optind - 1]); err++; break; } } if (help || ver) { opts.quiet = 0; ntfs_log_set_levels(NTFS_LOG_LEVEL_QUIET); } else { if (!opts.keyfile) { ntfs_log_error("You must specify a key file.\n"); err++; } else if (opts.device == NULL) { ntfs_log_error("You must specify a device.\n"); err++; } else if (opts.file == NULL && opts.inode == -1) { ntfs_log_error("You must specify a file or inode with " "the -i option.\n"); err++; } else if (opts.file != NULL && opts.inode != -1) { ntfs_log_error("You can't specify both a file and " "inode.\n"); err++; } if (opts.quiet && opts.verbose) { ntfs_log_error("You may not use --quiet and --verbose " "at the same time.\n"); err++; } } if (ver) version(); if (help || err) usage(); /* tri-state 0 : done, 1 : error, -1 : proceed */ return (err ? 1 : (help || ver ? 0 : -1)); } /** * ntfs_pkcs12_load_pfxfile */ static int ntfs_pkcs12_load_pfxfile(const char *keyfile, u8 **pfx, unsigned *pfx_size) { int f, to_read, total, attempts, br; struct stat key_stat; if (!keyfile || !pfx || !pfx_size) { ntfs_log_error("You have to specify the key file, a pointer " "to hold the key file contents, and a pointer " "to hold the size of the key file contents.\n"); return -1; } f = open(keyfile, O_RDONLY); if (f == -1) { ntfs_log_perror("Failed to open key file"); return -1; } if (fstat(f, &key_stat) == -1) { ntfs_log_perror("Failed to stat key file"); goto file_out; } if (!S_ISREG(key_stat.st_mode)) { ntfs_log_error("Key file is not a regular file, cannot read " "it.\n"); goto file_out; } if (!key_stat.st_size) { ntfs_log_error("Key file has zero size.\n"); goto file_out; } *pfx = malloc(key_stat.st_size + 1); if (!*pfx) { ntfs_log_perror("Failed to allocate buffer for key file " "contents"); goto file_out; } to_read = key_stat.st_size; total = attempts = 0; do { br = read(f, *pfx + total, to_read); if (br == -1) { ntfs_log_perror("Failed to read from key file"); goto free_out; } if (!br) attempts++; to_read -= br; total += br; } while (to_read > 0 && attempts < 3); close(f); /* Make sure it is zero terminated. */ (*pfx)[key_stat.st_size] = 0; *pfx_size = key_stat.st_size; return 0; free_out: free(*pfx); file_out: close(f); return -1; } /** * ntfs_crypto_init */ static int ntfs_crypto_init(void) { int err; /* Initialize gcrypt library. Note: Must come before GNU TLS init. */ if (gcry_control(GCRYCTL_DISABLE_SECMEM, 0) != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to initialize the gcrypt library.\n"); return -1; } /* Initialize GNU TLS library. Note: Must come after libgcrypt init. */ err = gnutls_global_init(); if (err < 0) { ntfs_log_error("Failed to initialize GNU TLS library: %s\n", gnutls_strerror(err)); return -1; } return 0; } /** * ntfs_crypto_deinit */ static void ntfs_crypto_deinit(void) { gnutls_global_deinit(); } /** * ntfs_rsa_private_key_import_from_gnutls */ static ntfs_rsa_private_key ntfs_rsa_private_key_import_from_gnutls( gnutls_x509_privkey_t priv_key) { int i, j; size_t tmp_size; gnutls_datum_t rd[6]; gcry_mpi_t rm[6]; gcry_sexp_t rsa_key; /* Extract the RSA parameters from the GNU TLS private key. */ if (gnutls_x509_privkey_export_rsa_raw(priv_key, &rd[0], &rd[1], &rd[2], &rd[3], &rd[4], &rd[5])) { ntfs_log_error("Failed to export rsa parameters. (Is the " "key an RSA private key?)\n"); return NULL; } /* Convert each RSA parameter to mpi format. */ for (i = 0; i < 6; i++) { if (gcry_mpi_scan(&rm[i], GCRYMPI_FMT_USG, rd[i].data, rd[i].size, &tmp_size) != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to convert RSA parameter %i " "to mpi format (size %d)\n", i, rd[i].size); rsa_key = NULL; break; } } /* Release the no longer needed datum values. */ for (j = 0; j < 6; j++) { if (rd[j].data && rd[j].size) gnutls_free(rd[j].data); } /* * Build the gcrypt private key, note libgcrypt uses p and q inversed * to what gnutls uses. */ if (i == 6 && gcry_sexp_build(&rsa_key, NULL, "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))", rm[0], rm[1], rm[2], rm[4], rm[3], rm[5]) != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to build RSA private key s-exp.\n"); rsa_key = NULL; } /* Release the no longer needed mpi values. */ for (j = 0; j < i; j++) gcry_mpi_release(rm[j]); return (ntfs_rsa_private_key)rsa_key; } /** * ntfs_rsa_private_key_release */ static void ntfs_rsa_private_key_release(ntfs_rsa_private_key rsa_key) { gcry_sexp_release((gcry_sexp_t)rsa_key); } /** * ntfs_pkcs12_extract_rsa_key */ static ntfs_rsa_private_key ntfs_pkcs12_extract_rsa_key(u8 *pfx, int pfx_size, char *password, char *thumbprint, int thumbprint_size, NTFS_DF_TYPES *df_type) { int err, bag_index, flags; gnutls_datum_t dpfx, dkey; gnutls_pkcs12_t pkcs12 = NULL; gnutls_pkcs12_bag_t bag = NULL; gnutls_x509_privkey_t pkey = NULL; gnutls_x509_crt_t crt = NULL; ntfs_rsa_private_key rsa_key = NULL; char purpose_oid[100]; size_t purpose_oid_size = sizeof(purpose_oid); int oid_index; size_t tp_size = thumbprint_size; BOOL have_thumbprint = FALSE; *df_type = DF_TYPE_UNKNOWN; /* Create a pkcs12 structure. */ err = gnutls_pkcs12_init(&pkcs12); if (err) { ntfs_log_error("Failed to initialize PKCS#12 structure: %s\n", gnutls_strerror(err)); return NULL; } /* Convert the PFX file (DER format) to native pkcs12 format. */ dpfx.data = pfx; dpfx.size = pfx_size; err = gnutls_pkcs12_import(pkcs12, &dpfx, GNUTLS_X509_FMT_DER, 0); if (err) { ntfs_log_error("Failed to convert the PFX file from DER to " "native PKCS#12 format: %s\n", gnutls_strerror(err)); goto err; } /* * Verify that the password is correct and that the key file has not * been tampered with. Note if the password has zero length and the * verification fails, retry with password set to NULL. This is needed * to get passwordless .pfx files generated with Windows XP SP1 (and * probably earlier versions of Windows) to work. */ retry_verify: err = gnutls_pkcs12_verify_mac(pkcs12, password); if (err) { if (err == GNUTLS_E_MAC_VERIFY_FAILED && password && !strlen(password)) { password = NULL; goto retry_verify; } ntfs_log_error("Failed to verify the MAC: %s Is the " "password correct?\n", gnutls_strerror(err)); goto err; } for (bag_index = 0; ; bag_index++) { err = gnutls_pkcs12_bag_init(&bag); if (err) { ntfs_log_error("Failed to initialize PKCS#12 Bag " "structure: %s\n", gnutls_strerror(err)); goto err; } err = gnutls_pkcs12_get_bag(pkcs12, bag_index, bag); if (err) { if (err == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) { err = 0; break; } ntfs_log_error("Failed to obtain Bag from PKCS#12 " "structure: %s\n", gnutls_strerror(err)); goto err; } check_again: err = gnutls_pkcs12_bag_get_count(bag); if (err < 0) { ntfs_log_error("Failed to obtain Bag count: %s\n", gnutls_strerror(err)); goto err; } err = gnutls_pkcs12_bag_get_type(bag, 0); if (err < 0) { ntfs_log_error("Failed to determine Bag type: %s\n", gnutls_strerror(err)); goto err; } flags = 0; switch (err) { case GNUTLS_BAG_PKCS8_KEY: flags = GNUTLS_PKCS_PLAIN; /* FALLTHRU */ case GNUTLS_BAG_PKCS8_ENCRYPTED_KEY: err = gnutls_pkcs12_bag_get_data(bag, 0, &dkey); if (err < 0) { ntfs_log_error("Failed to obtain Bag data: " "%s\n", gnutls_strerror(err)); goto err; } err = gnutls_x509_privkey_init(&pkey); if (err) { ntfs_log_error("Failed to initialized " "private key structure: %s\n", gnutls_strerror(err)); goto err; } /* Decrypt the private key into GNU TLS format. */ err = gnutls_x509_privkey_import_pkcs8(pkey, &dkey, GNUTLS_X509_FMT_DER, password, flags); if (err) { ntfs_log_error("Failed to convert private " "key from DER to GNU TLS " "format: %s\n", gnutls_strerror(err)); goto err; } #if 0 /* * Export the key again, but unencrypted, and output it * to stderr. Note the output has an RSA header so to * compare to openssl pkcs12 -nodes -in myfile.pfx * output need to ignore the part of the key between * the first "MII..." up to the second "MII...". The * actual RSA private key begins at the second "MII..." * and in my testing at least was identical to openssl * output and was also identical both on big and little * endian so gnutls should be endianness safe. */ char *buf = malloc(8192); size_t bufsize = 8192; err = gnutls_x509_privkey_export_pkcs8(pkey, GNUTLS_X509_FMT_PEM, "", GNUTLS_PKCS_PLAIN, buf, &bufsize); if (err) { ntfs_log_error("eek1\n"); exit(1); } ntfs_log_error("%s\n", buf); free(buf); #endif /* Convert the private key to our internal format. */ rsa_key = ntfs_rsa_private_key_import_from_gnutls(pkey); if (!rsa_key) goto err; break; case GNUTLS_BAG_ENCRYPTED: err = gnutls_pkcs12_bag_decrypt(bag, password); if (err) { ntfs_log_error("Failed to decrypt Bag: %s\n", gnutls_strerror(err)); goto err; } goto check_again; case GNUTLS_BAG_CERTIFICATE: err = gnutls_pkcs12_bag_get_data(bag, 0, &dkey); if (err < 0) { ntfs_log_error("Failed to obtain Bag data: " "%s\n", gnutls_strerror(err)); goto err; } err = gnutls_x509_crt_init(&crt); if (err) { ntfs_log_error("Failed to initialize " "certificate structure: %s\n", gnutls_strerror(err)); goto err; } err = gnutls_x509_crt_import(crt, &dkey, GNUTLS_X509_FMT_DER); if (err) { ntfs_log_error("Failed to convert certificate " "from DER to GNU TLS format: " "%s\n", gnutls_strerror(err)); goto err; } oid_index = 0; /* * Search in the key purposes for an EFS * encryption purpose or an EFS recovery * purpose, and use the first one found. */ do { purpose_oid_size = sizeof(purpose_oid); err = gnutls_x509_crt_get_key_purpose_oid(crt, oid_index, purpose_oid, &purpose_oid_size, NULL); if (!err) { purpose_oid[purpose_oid_size - 1] = '\0'; if (!strcmp(purpose_oid, NTFS_EFS_CERT_PURPOSE_OID_DRF)) *df_type = DF_TYPE_DRF; else if (!strcmp(purpose_oid, NTFS_EFS_CERT_PURPOSE_OID_DDF)) *df_type = DF_TYPE_DDF; else oid_index++; } } while (!err && (*df_type == DF_TYPE_UNKNOWN)); if (*df_type == DF_TYPE_UNKNOWN) { /* End of list reached ? */ if (err == GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE) ntfs_log_error("Key does not have an " "EFS purpose OID\n"); else ntfs_log_error("Failed to get a key " "purpose OID : %s ", gnutls_strerror(err)); goto err; } /* Return the thumbprint to the caller. */ err = gnutls_x509_crt_get_fingerprint(crt, GNUTLS_DIG_SHA1, thumbprint, &tp_size); if (err) { ntfs_log_error("Failed to get thumbprint: " "%s\n", gnutls_strerror(err)); goto err; } if (tp_size != NTFS_SHA1_THUMBPRINT_SIZE) { ntfs_log_error("Invalid thumbprint size %zd. " "Should be %d.\n", tp_size, thumbprint_size); err = EINVAL; goto err; } have_thumbprint = TRUE; gnutls_x509_crt_deinit(crt); crt = NULL; break; default: /* We do not care about other types. */ break; } gnutls_pkcs12_bag_deinit(bag); } err: if (rsa_key && (err || *df_type == DF_TYPE_UNKNOWN || !have_thumbprint)) { if (!err) ntfs_log_error("Key type or thumbprint not found, " "aborting.\n"); ntfs_rsa_private_key_release(rsa_key); rsa_key = NULL; } if (crt) gnutls_x509_crt_deinit(crt); if (pkey) gnutls_x509_privkey_deinit(pkey); if (bag) gnutls_pkcs12_bag_deinit(bag); if (pkcs12) gnutls_pkcs12_deinit(pkcs12); return rsa_key; } /** * ntfs_buffer_reverse - * * This is a utility function for reversing the order of a buffer in place. * Users of this function should be very careful not to sweep byte order * problems under the rug. */ static inline void ntfs_buffer_reverse(u8 *buf, unsigned buf_size) { unsigned i; u8 t; for (i = 0; i < buf_size / 2; i++) { t = buf[i]; buf[i] = buf[buf_size - i - 1]; buf[buf_size - i - 1] = t; } } #ifndef HAVE_STRNLEN /** * strnlen - strnlen is a gnu extension so emulate it if not present */ static size_t strnlen(const char *s, size_t maxlen) { const char *p, *end; /* Look for a '\0' character. */ for (p = s, end = s + maxlen; p < end && *p; p++) ; return p - s; } #endif /* ! HAVE_STRNLEN */ /** * ntfs_raw_fek_decrypt - * * Note: decrypting into the input buffer. */ static unsigned ntfs_raw_fek_decrypt(u8 *fek, u32 fek_size, ntfs_rsa_private_key rsa_key) { gcry_mpi_t fek_mpi; gcry_sexp_t fek_sexp, fek_sexp2; gcry_error_t err; size_t size, padding; /* Reverse the raw FEK. */ ntfs_buffer_reverse(fek, fek_size); /* Convert the FEK to internal MPI format. */ err = gcry_mpi_scan(&fek_mpi, GCRYMPI_FMT_USG, fek, fek_size, NULL); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to convert file encryption key to " "internal MPI format: %s\n", gcry_strerror(err)); return 0; } /* Create an internal S-expression from the FEK. */ err = gcry_sexp_build(&fek_sexp, NULL, "(enc-val (flags) (rsa (a %m)))", fek_mpi); gcry_mpi_release(fek_mpi); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to create internal S-expression of " "the file encryption key: %s\n", gcry_strerror(err)); return 0; } /* Decrypt the FEK. */ err = gcry_pk_decrypt(&fek_sexp2, fek_sexp, (gcry_sexp_t)rsa_key); gcry_sexp_release(fek_sexp); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to decrypt the file encryption key: " "%s\n", gcry_strerror(err)); return 0; } /* Extract the actual FEK from the decrypted raw S-expression. */ fek_sexp = gcry_sexp_find_token(fek_sexp2, "value", 0); gcry_sexp_release(fek_sexp2); if (!fek_sexp) { ntfs_log_error("Failed to find the decrypted file encryption " "key in the internal S-expression.\n"); return 0; } /* Convert the decrypted FEK S-expression into MPI format. */ fek_mpi = gcry_sexp_nth_mpi(fek_sexp, 1, GCRYMPI_FMT_USG); gcry_sexp_release(fek_sexp); if (!fek_mpi) { ntfs_log_error("Failed to convert the decrypted file " "encryption key S-expression to internal MPI " "format.\n"); return 0; } /* Convert the decrypted FEK from MPI format to binary data. */ err = gcry_mpi_print(GCRYMPI_FMT_USG, fek, fek_size, &size, fek_mpi); gcry_mpi_release(fek_mpi); if (err != GPG_ERR_NO_ERROR || !size) { ntfs_log_error("Failed to convert decrypted file encryption " "key from internal MPI format to binary data: " "%s\n", gcry_strerror(err)); return 0; } /* * Finally, remove the PKCS#1 padding and return the size of the * decrypted FEK. */ padding = strnlen((char *)fek, size) + 1; if (padding > size) { ntfs_log_error("Failed to remove PKCS#1 padding from " "decrypted file encryption key.\n"); return 0; } size -= padding; memmove(fek, fek + padding, size); return size; } /** * ntfs_desx_key_expand - expand a 128-bit desx key to the needed 192-bit key * @src: source buffer containing 128-bit key * * Expands the on-disk 128-bit desx key to the needed des key, the in-, and the * out-whitening keys required to perform desx {de,en}cryption. */ static gcry_error_t ntfs_desx_key_expand(const u8 *src, u32 *des_key, u64 *out_whitening, u64 *in_whitening) { static const u8 *salt1 = (const u8*)"Dan Simon "; static const u8 *salt2 = (const u8*)"Scott Field"; static const int salt_len = 12; gcry_md_hd_t hd1, hd2; u32 *md; gcry_error_t err; err = gcry_md_open(&hd1, GCRY_MD_MD5, 0); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to open MD5 digest.\n"); return err; } /* Hash the on-disk key. */ gcry_md_write(hd1, src, 128 / 8); /* Copy the current hash for efficiency. */ err = gcry_md_copy(&hd2, hd1); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to copy MD5 digest object.\n"); goto out; } /* Hash with the first salt and store the result. */ gcry_md_write(hd1, salt1, salt_len); md = (u32*)gcry_md_read(hd1, 0); des_key[0] = md[0] ^ md[1]; des_key[1] = md[2] ^ md[3]; /* Hash with the second salt and store the result. */ gcry_md_write(hd2, salt2, salt_len); md = (u32*)gcry_md_read(hd2, 0); *out_whitening = *(u64*)md; *in_whitening = *(u64*)(md + 2); gcry_md_close(hd2); out: gcry_md_close(hd1); return err; } /** * ntfs_desx_decrypt */ static gcry_error_t ntfs_desx_decrypt(ntfs_fek *fek, u8 *outbuf, const u8 *inbuf) { gcry_error_t err; u64 curr_blk; ntfs_desx_ctx *ctx = &fek->desx_ctx; curr_blk = *(const u64*)inbuf; *(u64*)outbuf = curr_blk ^ ctx->out_whitening; err = gcry_cipher_encrypt(fek->gcry_cipher_hd, outbuf, 8, NULL, 0); if (err != GPG_ERR_NO_ERROR) ntfs_log_error("Des decryption failed (error 0x%x).\n", err); *(u64*)outbuf ^= ctx->in_whitening ^ ctx->prev_blk; ctx->prev_blk = curr_blk; return (err); } /** * ntfs_desx_encrypt */ static gcry_error_t ntfs_desx_encrypt(ntfs_fek *fek, u8 *outbuf, const u8 *inbuf) { gcry_error_t err; ntfs_desx_ctx *ctx = &fek->desx_ctx; *(u64*)outbuf = *(const u64*)inbuf ^ ctx->in_whitening ^ ctx->prev_blk; err = gcry_cipher_decrypt(fek->gcry_cipher_hd, outbuf, 8, NULL, 0); if (err != GPG_ERR_NO_ERROR) ntfs_log_error("Des decryption failed (error 0x%x).\n", err); *(u64*)outbuf ^= ctx->out_whitening; ctx->prev_blk = *(u64*)outbuf; return (err); } //#define DO_CRYPTO_TESTS 1 #ifdef DO_CRYPTO_TESTS /* Do not remove this test code from this file! AIA */ /** * ntfs_desx_key_expand_test */ static BOOL ntfs_desx_key_expand_test(void) { const u8 known_desx_on_disk_key[16] = { 0xa1, 0xf9, 0xe0, 0xb2, 0x53, 0x23, 0x9e, 0x8f, 0x0f, 0x91, 0x45, 0xd9, 0x8e, 0x20, 0xec, 0x30 }; const u8 known_des_key[8] = { 0x27, 0xd1, 0x93, 0x09, 0xcb, 0x78, 0x93, 0x1f, }; const u8 known_out_whitening[8] = { 0xed, 0xda, 0x4c, 0x47, 0x60, 0x49, 0xdb, 0x8d, }; const u8 known_in_whitening[8] = { 0x75, 0xf6, 0xa0, 0x1a, 0xc0, 0xca, 0x28, 0x1e }; u64 test_out_whitening, test_in_whitening; union { u64 u64; u32 u32[2]; } test_des_key; gcry_error_t err; BOOL res; err = ntfs_desx_key_expand(known_desx_on_disk_key, test_des_key.u32, &test_out_whitening, &test_in_whitening); if (err != GPG_ERR_NO_ERROR) res = FALSE; else res = test_des_key.u64 == *(u64*)known_des_key && test_out_whitening == *(u64*)known_out_whitening && test_in_whitening == *(u64*)known_in_whitening; ntfs_log_error("Testing whether ntfs_desx_key_expand() works: %s\n", res ? "SUCCESS" : "FAILED"); return res; } /** * ntfs_des_test */ static BOOL ntfs_des_test(void) { const u8 known_des_key[8] = { 0x27, 0xd1, 0x93, 0x09, 0xcb, 0x78, 0x93, 0x1f }; const u8 known_des_encrypted_data[8] = { 0xdc, 0xf7, 0x68, 0x2a, 0xaf, 0x48, 0x53, 0x0f }; const u8 known_decrypted_data[8] = { 0xd8, 0xd9, 0x15, 0x23, 0x5b, 0x88, 0x0e, 0x09 }; u8 test_decrypted_data[8]; int res; gcry_error_t err; gcry_cipher_hd_t gcry_cipher_hd; err = gcry_cipher_open(&gcry_cipher_hd, GCRY_CIPHER_DES, GCRY_CIPHER_MODE_ECB, 0); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to open des cipher (error 0x%x).\n", err); return FALSE; } err = gcry_cipher_setkey(gcry_cipher_hd, known_des_key, sizeof(known_des_key)); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to set des key (error 0x%x.\n", err); gcry_cipher_close(gcry_cipher_hd); return FALSE; } /* * Apply DES decryption (ntfs actually uses encryption when decrypting). */ err = gcry_cipher_encrypt(gcry_cipher_hd, test_decrypted_data, sizeof(test_decrypted_data), known_des_encrypted_data, sizeof(known_des_encrypted_data)); gcry_cipher_close(gcry_cipher_hd); if (err) { ntfs_log_error("Failed to des decrypt test data (error " "0x%x).\n", err); return FALSE; } res = !memcmp(test_decrypted_data, known_decrypted_data, sizeof(known_decrypted_data)); ntfs_log_error("Testing whether des decryption works: %s\n", res ? "SUCCESS" : "FAILED"); return res; } #else /* !defined(DO_CRYPTO_TESTS) */ /** * ntfs_desx_key_expand_test */ static inline BOOL ntfs_desx_key_expand_test(void) { return TRUE; } /** * ntfs_des_test */ static inline BOOL ntfs_des_test(void) { return TRUE; } #endif /* !defined(DO_CRYPTO_TESTS) */ /** * ntfs_fek_import_from_raw */ static ntfs_fek *ntfs_fek_import_from_raw(u8 *fek_buf, unsigned fek_size) { ntfs_fek *fek; u32 key_size, wanted_key_size, gcry_algo; int gcry_mode; gcry_error_t err; ntfs_desx_ctx *ctx; key_size = le32_to_cpup((le32*) fek_buf); ntfs_log_debug("key_size 0x%x\n", key_size); if (key_size + 16 > fek_size) { ntfs_log_debug("Invalid FEK. It was probably decrypted with " "the incorrect RSA key."); errno = EINVAL; return NULL; } fek = malloc(((((sizeof(*fek) + 7) & ~7) + key_size + 7) & ~7) + sizeof(gcry_cipher_hd_t)); if (!fek) { errno = ENOMEM; return NULL; } ctx = &fek->desx_ctx; fek->alg_id = *(le32*)(fek_buf + 8); //ntfs_log_debug("alg_id 0x%x\n", le32_to_cpu(fek->alg_id)); fek->key_data = (u8*)fek + ((sizeof(*fek) + 7) & ~7); memcpy(fek->key_data, fek_buf + 16, key_size); fek->des_gcry_cipher_hd_ptr = NULL; *(gcry_cipher_hd_t***)(fek->key_data + ((key_size + 7) & ~7)) = &fek->des_gcry_cipher_hd_ptr; switch (fek->alg_id) { case CALG_DESX: wanted_key_size = 16; gcry_algo = GCRY_CIPHER_DES; gcry_mode = GCRY_CIPHER_MODE_ECB; break; case CALG_3DES: wanted_key_size = 24; gcry_algo = GCRY_CIPHER_3DES; gcry_mode = GCRY_CIPHER_MODE_CBC; break; case CALG_AES_256: wanted_key_size = 32; gcry_algo = GCRY_CIPHER_AES256; gcry_mode = GCRY_CIPHER_MODE_CBC; break; default: wanted_key_size = 8; gcry_algo = GCRY_CIPHER_DES; gcry_mode = GCRY_CIPHER_MODE_CBC; if (fek->alg_id == CALG_DES) ntfs_log_error("DES is not supported at present\n"); else ntfs_log_error("Unknown crypto algorithm 0x%x\n", le32_to_cpu(fek->alg_id)); ntfs_log_error(". Please email %s and say that you saw this " "message. We will then try to implement " "support for this algorithm.\n", NTFS_DEV_LIST); err = EOPNOTSUPP; goto out; } if (key_size != wanted_key_size) { ntfs_log_error("%s key of %u bytes but needed size is %u " "bytes, assuming corrupt or incorrect key. " "Aborting.\n", gcry_cipher_algo_name(gcry_algo), (unsigned)key_size, (unsigned)wanted_key_size); err = EIO; goto out; } err = gcry_cipher_open(&fek->gcry_cipher_hd, gcry_algo, gcry_mode, 0); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("gcry_cipher_open() failed: %s\n", gcry_strerror(err)); err = EINVAL; goto out; } if (fek->alg_id == CALG_DESX) { err = ntfs_desx_key_expand(fek->key_data, (u32*)ctx->des_key, &ctx->out_whitening, &ctx->in_whitening); if (err == GPG_ERR_NO_ERROR) err = gcry_cipher_setkey(fek->gcry_cipher_hd, ctx->des_key, 8); } else { err = gcry_cipher_setkey(fek->gcry_cipher_hd, fek->key_data, key_size); } if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("gcry_cipher_setkey() failed: %s\n", gcry_strerror(err)); gcry_cipher_close(fek->gcry_cipher_hd); err = EINVAL; goto out; } return fek; out: free(fek); errno = err; return NULL; } /** * ntfs_fek_release */ static void ntfs_fek_release(ntfs_fek *fek) { if (fek->des_gcry_cipher_hd_ptr) gcry_cipher_close(*fek->des_gcry_cipher_hd_ptr); gcry_cipher_close(fek->gcry_cipher_hd); free(fek); } /** * ntfs_df_array_fek_get */ static ntfs_fek *ntfs_df_array_fek_get(EFS_DF_ARRAY_HEADER *df_array, ntfs_rsa_private_key rsa_key, char *thumbprint, int thumbprint_size) { EFS_DF_HEADER *df_header; EFS_DF_CREDENTIAL_HEADER *df_cred; EFS_DF_CERT_THUMBPRINT_HEADER *df_cert; u8 *fek_buf; ntfs_fek *fek; u32 df_count, fek_size; unsigned i; df_count = le32_to_cpu(df_array->df_count); if (!df_count) ntfs_log_error("There are no elements in the DF array.\n"); df_header = (EFS_DF_HEADER*)(df_array + 1); for (i = 0; i < df_count; i++, df_header = (EFS_DF_HEADER*)( (u8*)df_header + le32_to_cpu(df_header->df_length))) { df_cred = (EFS_DF_CREDENTIAL_HEADER*)((u8*)df_header + le32_to_cpu(df_header->cred_header_offset)); if (df_cred->type != NTFS_CRED_TYPE_CERT_THUMBPRINT) { ntfs_log_debug("Credential type is not certificate " "thumbprint, skipping DF entry.\n"); continue; } df_cert = (EFS_DF_CERT_THUMBPRINT_HEADER*)((u8*)df_cred + le32_to_cpu( df_cred->cert_thumbprint_header_offset)); if ((int)le32_to_cpu(df_cert->thumbprint_size) != thumbprint_size) { ntfs_log_error("Thumbprint size %d is not valid " "(should be %d), skipping this DF " "entry.\n", le32_to_cpu(df_cert->thumbprint_size), thumbprint_size); continue; } if (memcmp((u8*)df_cert + le32_to_cpu(df_cert->thumbprint_offset), thumbprint, thumbprint_size)) { ntfs_log_debug("Thumbprints do not match, skipping " "this DF entry.\n"); continue; } /* * The thumbprints match so this is probably the DF entry * matching the RSA key. Try to decrypt the FEK with it. */ fek_size = le32_to_cpu(df_header->fek_size); fek_buf = (u8*)df_header + le32_to_cpu(df_header->fek_offset); /* Decrypt the FEK. Note: This is done in place. */ fek_size = ntfs_raw_fek_decrypt(fek_buf, fek_size, rsa_key); if (fek_size) { /* Convert the FEK to our internal format. */ fek = ntfs_fek_import_from_raw(fek_buf, fek_size); if (fek) return fek; ntfs_log_error("Failed to convert the decrypted file " "encryption key to internal format.\n"); } else ntfs_log_error("Failed to decrypt the file " "encryption key.\n"); } return NULL; } /** * ntfs_inode_fek_get - */ static ntfs_fek *ntfs_inode_fek_get(ntfs_inode *inode, ntfs_rsa_private_key rsa_key, char *thumbprint, int thumbprint_size, NTFS_DF_TYPES df_type) { EFS_ATTR_HEADER *efs; EFS_DF_ARRAY_HEADER *df_array = NULL; ntfs_fek *fek = NULL; /* Obtain the $EFS contents. */ efs = ntfs_attr_readall(inode, AT_LOGGED_UTILITY_STREAM, EFS, 4, NULL); if (!efs) { ntfs_log_perror("Failed to read $EFS attribute"); return NULL; } /* * Depending on whether the key is a normal key or a data recovery key, * iterate through the DDF or DRF array, respectively. */ if (df_type == DF_TYPE_DDF) { if (efs->offset_to_ddf_array) df_array = (EFS_DF_ARRAY_HEADER*)((u8*)efs + le32_to_cpu(efs->offset_to_ddf_array)); else ntfs_log_error("There are no entries in the DDF " "array.\n"); } else if (df_type == DF_TYPE_DRF) { if (efs->offset_to_drf_array) df_array = (EFS_DF_ARRAY_HEADER*)((u8*)efs + le32_to_cpu(efs->offset_to_drf_array)); else ntfs_log_error("There are no entries in the DRF " "array.\n"); } else ntfs_log_error("Invalid DF type.\n"); if (df_array) fek = ntfs_df_array_fek_get(df_array, rsa_key, thumbprint, thumbprint_size); free(efs); return fek; } /** * ntfs_fek_decrypt_sector */ static int ntfs_fek_decrypt_sector(ntfs_fek *fek, u8 *data, const u64 offset) { gcry_error_t err; err = gcry_cipher_reset(fek->gcry_cipher_hd); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to reset cipher: %s\n", gcry_strerror(err)); return -1; } /* * Note: You may wonder why we are not calling gcry_cipher_setiv() here * instead of doing it by hand after the decryption. The answer is * that gcry_cipher_setiv() wants an iv of length 8 bytes but we give * it a length of 16 for AES256 so it does not like it. */ if (fek->alg_id == CALG_DESX) { int k; fek->desx_ctx.prev_blk = 0; for (k=0; (k < 512) && (err == GPG_ERR_NO_ERROR); k+=8) { err = ntfs_desx_decrypt(fek, &data[k], &data[k]); } } else err = gcry_cipher_decrypt(fek->gcry_cipher_hd, data, 512, NULL, 0); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Decryption failed: %s\n", gcry_strerror(err)); return -1; } /* Apply the IV. */ if (fek->alg_id == CALG_AES_256) { ((le64*)data)[0] ^= cpu_to_le64(0x5816657be9161312ULL + offset); ((le64*)data)[1] ^= cpu_to_le64(0x1989adbe44918961ULL + offset); } else { /* All other algos (Des, 3Des, DesX) use the same IV. */ ((le64*)data)[0] ^= cpu_to_le64(0x169119629891ad13ULL + offset); } return 512; } /** * ntfs_fek_encrypt_sector */ static int ntfs_fek_encrypt_sector(ntfs_fek *fek, u8 *data, const u64 offset) { gcry_error_t err; err = gcry_cipher_reset(fek->gcry_cipher_hd); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Failed to reset cipher: %s\n", gcry_strerror(err)); return -1; } /* * Note: You may wonder why we are not calling gcry_cipher_setiv() here * instead of doing it by hand after the decryption. The answer is * that gcry_cipher_setiv() wants an iv of length 8 bytes but we give * it a length of 16 for AES256 so it does not like it. */ /* Apply the IV. */ if (fek->alg_id == CALG_AES_256) { ((le64*)data)[0] ^= cpu_to_le64(0x5816657be9161312ULL + offset); ((le64*)data)[1] ^= cpu_to_le64(0x1989adbe44918961ULL + offset); } else { /* All other algos (Des, 3Des, DesX) use the same IV. */ ((le64*)data)[0] ^= cpu_to_le64(0x169119629891ad13ULL + offset); } if (fek->alg_id == CALG_DESX) { int k; fek->desx_ctx.prev_blk = 0; for (k=0; (k < 512) && (err == GPG_ERR_NO_ERROR); k+=8) { err = ntfs_desx_encrypt(fek, &data[k], &data[k]); } } else err = gcry_cipher_encrypt(fek->gcry_cipher_hd, data, 512, NULL, 0); if (err != GPG_ERR_NO_ERROR) { ntfs_log_error("Encryption failed: %s\n", gcry_strerror(err)); return -1; } return 512; } /** * ntfs_cat_decrypt - Decrypt the contents of an encrypted file to stdout. * @inode: An encrypted file's inode structure, as obtained by * ntfs_inode_open(). * @fek: A file encryption key. As obtained by ntfs_inode_fek_get(). */ static int ntfs_cat_decrypt(ntfs_inode *inode, ntfs_fek *fek) { int bufsize = 512; unsigned char *buffer; ntfs_attr *attr; s64 bytes_read, written, offset, total; s64 old_data_size, old_initialized_size; int i; buffer = malloc(bufsize); if (!buffer) return 1; attr = ntfs_attr_open(inode, AT_DATA, NULL, 0); if (!attr) { ntfs_log_error("Cannot cat a directory.\n"); free(buffer); return 1; } total = attr->data_size; // hack: make sure attr will not be commited to disk if you use this. // clear the encrypted bit, otherwise the library won't allow reading. NAttrClearEncrypted(attr); // extend the size, we may need to read past the end of the stream. old_data_size = attr->data_size; old_initialized_size = attr->initialized_size; attr->data_size = attr->initialized_size = attr->allocated_size; offset = 0; while (total > 0) { bytes_read = ntfs_attr_pread(attr, offset, 512, buffer); if (bytes_read == -1) { ntfs_log_perror("ERROR: Couldn't read file"); break; } if (!bytes_read) break; if ((i = ntfs_fek_decrypt_sector(fek, buffer, offset)) < bytes_read) { ntfs_log_perror("ERROR: Couldn't decrypt all data!"); ntfs_log_error("%u/%lld/%lld/%lld\n", i, (long long)bytes_read, (long long)offset, (long long)total); break; } if (bytes_read > total) bytes_read = total; written = fwrite(buffer, 1, bytes_read, stdout); if (written != bytes_read) { ntfs_log_perror("ERROR: Couldn't output all data!"); break; } offset += bytes_read; total -= bytes_read; } attr->data_size = old_data_size; attr->initialized_size = old_initialized_size; NAttrSetEncrypted(attr); ntfs_attr_close(attr); free(buffer); return 0; } /** * ntfs_feed_encrypt - Encrypt the contents of stdin to an encrypted file * @inode: An encrypted file's inode structure, as obtained by * ntfs_inode_open(). * @fek: A file encryption key. As obtained by ntfs_inode_fek_get(). */ static int ntfs_feed_encrypt(ntfs_inode *inode, ntfs_fek *fek) { const int bufsize = 512; unsigned char *buffer; ntfs_attr *attr; s64 bytes_read, written, offset, total; unsigned char *b; long val; int count; int i; buffer = (unsigned char*)malloc(bufsize); if (!buffer) return 1; attr = ntfs_attr_open(inode, AT_DATA, NULL, 0); if (!attr) { ntfs_log_error("Cannot feed into a directory.\n"); goto rejected; } total = 0; if (!(attr->data_flags & ATTR_IS_ENCRYPTED)) { ntfs_log_error("The data stream was not encrypted\n"); goto rejected; } inode->vol->efs_raw = TRUE; if (ntfs_attr_truncate(attr, 0)) { ntfs_log_error("Failed to truncate the data stream\n"); goto rejected; } offset = 0; do { bytes_read = fread(buffer, 1, bufsize, stdin); if (bytes_read <= 0) { if (bytes_read < 0) ntfs_log_perror("ERROR: Couldn't read data"); } else { if (bytes_read < bufsize) { /* Fill with random data */ srandom((unsigned int)(sle64_to_cpu( inode->last_data_change_time) /100000000)); count = bufsize - bytes_read; b = &buffer[bytes_read]; do { val = random(); switch (count) { default : *b++ = val; val >>= 8; /* FALLTHRU */ case 3 : *b++ = val; val >>= 8; /* FALLTHRU */ case 2 : *b++ = val; val >>= 8; /* FALLTHRU */ case 1 : *b++ = val; val >>= 8; } count -= 4; } while (count > 0); } if ((i = ntfs_fek_encrypt_sector(fek, buffer, offset)) < bufsize) { ntfs_log_perror("ERROR: Couldn't encrypt all data!"); ntfs_log_error("%u/%lld/%lld/%lld\n", i, (long long)bytes_read, (long long)offset, (long long)total); break; } written = ntfs_attr_pwrite(attr, offset, bufsize, buffer); if (written != bufsize) { ntfs_log_perror("ERROR: Couldn't output all data!"); break; } offset += bufsize; total += bytes_read; } } while (bytes_read == bufsize); ntfs_attr_truncate(attr, total); inode->last_data_change_time = ntfs_current_time(); NAttrSetEncrypted(attr); ntfs_attr_close(attr); free(buffer); return 0; rejected : free(buffer); return (-1); } /** * main - Begin here * * Start from here. * * Return: 0 Success, the program worked * 1 Error, something went wrong */ int main(int argc, char *argv[]) { u8 *pfx_buf; char *password; ntfs_rsa_private_key rsa_key; ntfs_volume *vol; ntfs_inode *inode; ntfs_fek *fek; unsigned pfx_size; int res; NTFS_DF_TYPES df_type; char thumbprint[NTFS_SHA1_THUMBPRINT_SIZE]; ntfs_log_set_handler(ntfs_log_handler_stderr); res = parse_options(argc, argv); if (res >= 0) return (res); utils_set_locale(); /* Initialize crypto in ntfs. */ if (ntfs_crypto_init()) { ntfs_log_error("Failed to initialize crypto. Aborting.\n"); return 1; } /* Load the PKCS#12 (.pfx) file containing the user's private key. */ if (ntfs_pkcs12_load_pfxfile(opts.keyfile, &pfx_buf, &pfx_size)) { ntfs_log_error("Failed to load key file. Aborting.\n"); ntfs_crypto_deinit(); return 1; } /* Ask the user for their password. */ password = getpass("Enter the password with which the private key was " "encrypted: "); if (!password) { ntfs_log_perror("Failed to obtain user password"); free(pfx_buf); ntfs_crypto_deinit(); return 1; } /* Obtain the user's private RSA key from the key file. */ rsa_key = ntfs_pkcs12_extract_rsa_key(pfx_buf, pfx_size, password, thumbprint, sizeof(thumbprint), &df_type); /* Destroy the password. */ memset(password, 0, strlen(password)); /* No longer need the pfx file contents. */ free(pfx_buf); if (!rsa_key) { ntfs_log_error("Failed to extract the private RSA key.\n"); ntfs_crypto_deinit(); return 1; } /* Mount the ntfs volume. */ vol = utils_mount_volume(opts.device, (opts.encrypt ? 0 : NTFS_MNT_RDONLY) | (opts.force ? NTFS_MNT_RECOVER : 0)); if (!vol) { ntfs_log_error("Failed to mount ntfs volume. Aborting.\n"); ntfs_rsa_private_key_release(rsa_key); ntfs_crypto_deinit(); return 1; } /* Open the encrypted ntfs file. */ if (opts.inode != -1) inode = ntfs_inode_open(vol, opts.inode); else inode = ntfs_pathname_to_inode(vol, NULL, opts.file); if (!inode) { ntfs_log_error("Failed to open encrypted file. Aborting.\n"); ntfs_umount(vol, FALSE); ntfs_rsa_private_key_release(rsa_key); ntfs_crypto_deinit(); return 1; } /* Obtain the file encryption key of the encrypted file. */ fek = ntfs_inode_fek_get(inode, rsa_key, thumbprint, sizeof(thumbprint), df_type); ntfs_rsa_private_key_release(rsa_key); if (fek) { if (opts.encrypt) res = ntfs_feed_encrypt(inode, fek); else res = ntfs_cat_decrypt(inode, fek); ntfs_fek_release(fek); } else { ntfs_log_error("Failed to obtain file encryption key. " "Aborting.\n"); res = 1; } ntfs_inode_close(inode); ntfs_umount(vol, FALSE); ntfs_crypto_deinit(); return res; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsdump_logfile.c000066400000000000000000000576321507404161300231300ustar00rootroot00000000000000/** * ntfsdump_logfile - Part of the Linux-NTFS project. * * Copyright (c) 2000-2005 Anton Altaparmakov * * This utility will interpret the contents of the journal ($LogFile) of an * NTFS partition and display the results on stdout. Errors will be output to * stderr. * * 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 (in the main directory of the Linux-NTFS source * in the file COPYING); if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* TODO: * - Remove the need for clipping at 64MiB. * - Add normal command line switchs (use getopt_long()). * - For a volume: allow dumping only uncommitted records. * - For a file: get an optional command line parameter for the last SN. * - Sanity checks. */ #include "config.h" #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDARG_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #include "types.h" #include "endians.h" #include "volume.h" #include "inode.h" #include "attrib.h" #include "layout.h" #include "logfile.h" #include "mst.h" #include "utils.h" /* #include "version.h" */ #include "logging.h" typedef struct { BOOL is_volume; const char *filename; s64 data_size; union { struct { ntfs_volume *vol; ntfs_inode *ni; ntfs_attr *na; }; struct { int fd; }; }; } logfile_file; /** * logfile_close */ static int logfile_close(logfile_file *logfile) { if (logfile->is_volume) { if (logfile->na) ntfs_attr_close(logfile->na); if (logfile->ni && ntfs_inode_close(logfile->ni)) ntfs_log_perror("Warning: Failed to close $LogFile " "(inode %i)", FILE_LogFile); if (ntfs_umount(logfile->vol, 0)) ntfs_log_perror("Warning: Failed to umount %s", logfile->filename); } else { if (close(logfile->fd)) ntfs_log_perror("Warning: Failed to close file %s", logfile->filename); } return 0; } /** * device_err_exit - put an error message, cleanup and exit. * @vol: volume to unmount. * @ni: Inode to free. * @na: Attribute to close. * * Use when you wish to exit and collate all the cleanups together. * if you don't have some parameter to pass, just pass NULL. */ __attribute__((noreturn)) __attribute__((format(printf, 4, 5))) static void device_err_exit(ntfs_volume *vol, ntfs_inode *ni, ntfs_attr *na, const char *fmt, ...) { va_list ap; if (na) ntfs_attr_close(na); if (ni && ntfs_inode_close(ni)) ntfs_log_perror("Warning: Failed to close $LogFile (inode %i)", FILE_LogFile); if (ntfs_umount(vol, 0)) ntfs_log_perror("Warning: Failed to umount"); fprintf(stderr, "ERROR: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); ntfs_log_error("Aborting...\n"); exit(1); } /** * log_err_exit - */ __attribute__((noreturn)) __attribute__((format(printf, 2, 3))) static void log_err_exit(u8 *buf, const char *fmt, ...) { va_list ap; free(buf); fprintf(stderr, "ERROR: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); ntfs_log_error("Aborting...\n"); exit(1); } /** * usage - */ __attribute__((noreturn)) static void usage(const char *exec_name) { ntfs_log_error("%s v%s (libntfs-3g) - Interpret and display information " "about the journal\n($LogFile) of an NTFS volume.\n" "Copyright (c) 2000-2005 Anton Altaparmakov.\n" "%s is free software, released under the GNU General " "Public License\nand you are welcome to redistribute " "it under certain conditions.\n%s comes with " "ABSOLUTELY NO WARRANTY; for details read the GNU\n" "General Public License to be found in the file " "COPYING in the main Linux-NTFS\ndistribution " "directory.\nUsage: %s device\n e.g. %s /dev/hda6\n" "Alternative usage: %s -f file\n e.g. %s -f " "MyCopyOfTheLogFile\n", exec_name, VERSION, exec_name, exec_name, exec_name, exec_name, exec_name, exec_name); exit(1); } /** * logfile_open */ static int logfile_open(BOOL is_volume, const char *filename, logfile_file *logfile) { if (is_volume) { ntfs_volume *vol; ntfs_inode *ni; ntfs_attr *na; /* Porting note: NTFS_MNT_FORENSIC is not needed when we mount * the volume in read-only mode. No changes will be made to the * logfile or anything else when we are in read only-mode. */ vol = ntfs_mount(filename, NTFS_MNT_RDONLY); if (!vol) log_err_exit(NULL, "Failed to mount %s: %s\n", filename, strerror(errno)); ntfs_log_info("Mounted NTFS volume %s (NTFS v%i.%i) on device %s.\n", vol->vol_name ? vol->vol_name : "", vol->major_ver, vol->minor_ver, filename); if (ntfs_version_is_supported(vol)) device_err_exit(vol, NULL, NULL, "Unsupported NTFS version.\n"); ni = ntfs_inode_open(vol, FILE_LogFile); if (!ni) device_err_exit(vol, NULL, NULL, "Failed to " "open $LogFile (inode %i): %s\n", FILE_LogFile, strerror(errno)); na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) device_err_exit(vol, ni, NULL, "Failed to open " "$LogFile/$DATA (attribute 0x%x):" " %s\n", (unsigned int) le32_to_cpu(AT_DATA), strerror(errno)); if (!na->data_size) device_err_exit(vol, ni, na, "$LogFile has zero " "length. Run chkdsk /f to correct " "this.\n"); logfile->data_size = na->data_size; logfile->vol = vol; logfile->ni = ni; logfile->na = na; } else { struct stat sbuf; int fd; if (stat(filename, &sbuf) == -1) { if (errno == ENOENT) log_err_exit(NULL, "The file %s does not " "exist. Did you specify it " "correctly?\n", filename); log_err_exit(NULL, "Error getting information about " "%s: %s\n", filename, strerror(errno)); } fd = open(filename, O_RDONLY); if (fd == -1) log_err_exit(NULL, "Failed to open file %s: %s\n", filename, strerror(errno)); logfile->data_size = sbuf.st_size; logfile->fd = fd; } logfile->is_volume = is_volume; logfile->filename = filename; return 0; } /** * logfile_read */ static int logfile_pread(logfile_file *logfile, int ofs, int count, u8 *buf) { int br; if (logfile->is_volume) { br = (int)ntfs_attr_pread(logfile->na, ofs, count, buf); } else { if (lseek(logfile->fd, ofs, SEEK_SET)==-1) { ntfs_log_error("Could not seek to offset %u\n", ofs); return 0; } br = read(logfile->fd, buf, count); } if (br != count) { ntfs_log_error("Only %d out of %d bytes read starting at %d\n", br, count, ofs); } return br; } /** * restart_header_sanity() */ static void restart_header_sanity(RESTART_PAGE_HEADER *rstr, u8 *buf) { unsigned int usa_end_ofs, page_size; /* Only CHKD records are allowed to have chkdsk_lsn set. */ if (!ntfs_is_chkd_record(rstr->magic) && sle64_to_cpu(rstr->chkdsk_lsn)) log_err_exit(buf, "$LogFile is corrupt: Restart page header " "magic is not CHKD but a chkdsk LSN is " "specified. Cannot handle this yet.\n"); /* Both system and log page size must be >= 512 and a power of 2. */ page_size = le32_to_cpu(rstr->log_page_size); if (page_size < 512 || page_size & (page_size - 1)) log_err_exit(buf, "$LogFile is corrupt: Restart page header " "specifies invalid log page size. Cannot " "handle this yet.\n"); if (page_size != le32_to_cpu(rstr->system_page_size)) { page_size = le32_to_cpu(rstr->system_page_size); if (page_size < 512 || page_size & (page_size - 1)) log_err_exit(buf, "$LogFile is corrupt: Restart page " "header specifies invalid system page " "size. Cannot handle this yet.\n"); } /* Abort if the version number is not 1.1. */ if (sle16_to_cpu(rstr->major_ver) != 1 || sle16_to_cpu(rstr->minor_ver) != 1) log_err_exit(buf, "Unknown $LogFile version %i.%i. Only know " "how to handle version 1.1.\n", sle16_to_cpu(rstr->major_ver), sle16_to_cpu(rstr->minor_ver)); /* Verify the location and size of the update sequence array. */ usa_end_ofs = le16_to_cpu(rstr->usa_ofs) + le16_to_cpu(rstr->usa_count) * sizeof(u16); if (page_size / NTFS_BLOCK_SIZE + 1 != le16_to_cpu(rstr->usa_count)) log_err_exit(buf, "Restart page header in $LogFile is " "corrupt: Update sequence array size is " "wrong. Cannot handle this yet.\n"); if (le16_to_cpu(rstr->usa_ofs) < offsetof(RESTART_PAGE_HEADER, usn)) log_err_exit(buf, "Restart page header in $LogFile is " "corrupt: Update sequence array overlaps " "restart page header. Cannot handle this " "yet.\n"); if (usa_end_ofs > NTFS_BLOCK_SIZE - sizeof(u16)) log_err_exit(buf, "Restart page header in $LogFile is " "corrupt: Update sequence array overlaps or " "is behind first protected sequence number. " "Cannot handle this yet.\n"); if (usa_end_ofs > le16_to_cpu(rstr->restart_area_offset)) log_err_exit(buf, "Restart page header in $LogFile is " "corrupt: Update sequence array overlaps or " "is behind restart area. Cannot handle this " "yet.\n"); /* Finally, verify the offset of the restart area. */ if (le16_to_cpu(rstr->restart_area_offset) & 7) log_err_exit(buf, "Restart page header in $LogFile is " "corrupt: Restart area offset is not aligned " "to 8-byte boundary. Cannot handle this " "yet.\n"); } /** * dump_restart_areas_header */ static void dump_restart_areas_header(RESTART_PAGE_HEADER *rstr) { ntfs_log_info("\nRestart page header:\n"); ntfs_log_info("magic = %s\n", ntfs_is_rstr_record(rstr->magic) ? "RSTR" : "CHKD"); ntfs_log_info("usa_ofs = %u (0x%x)\n", le16_to_cpu(rstr->usa_ofs), le16_to_cpu(rstr->usa_ofs)); ntfs_log_info("usa_count = %u (0x%x)\n", le16_to_cpu(rstr->usa_count), le16_to_cpu(rstr->usa_count)); ntfs_log_info("chkdsk_lsn = %lli (0x%llx)\n", (long long)sle64_to_cpu(rstr->chkdsk_lsn), (unsigned long long)sle64_to_cpu(rstr->chkdsk_lsn)); ntfs_log_info("system_page_size = %u (0x%x)\n", (unsigned int)le32_to_cpu(rstr->system_page_size), (unsigned int)le32_to_cpu(rstr->system_page_size)); ntfs_log_info("log_page_size = %u (0x%x)\n", (unsigned int)le32_to_cpu(rstr->log_page_size), (unsigned int)le32_to_cpu(rstr->log_page_size)); ntfs_log_info("restart_offset = %u (0x%x)\n", le16_to_cpu(rstr->restart_area_offset), le16_to_cpu(rstr->restart_area_offset)); } /** * dump_restart_areas_area */ static void dump_restart_areas_area(RESTART_PAGE_HEADER *rstr) { LOG_CLIENT_RECORD *lcr; RESTART_AREA *ra; int client; ra = (RESTART_AREA*)((u8*)rstr + le16_to_cpu(rstr->restart_area_offset)); ntfs_log_info("current_lsn = %lli (0x%llx)\n", (long long)sle64_to_cpu(ra->current_lsn), (unsigned long long)sle64_to_cpu(ra->current_lsn)); ntfs_log_info("log_clients = %u (0x%x)\n", le16_to_cpu(ra->log_clients), le16_to_cpu(ra->log_clients)); ntfs_log_info("client_free_list = %i (0x%x)\n", (s16)le16_to_cpu(ra->client_free_list), le16_to_cpu(ra->client_free_list)); ntfs_log_info("client_in_use_list = %i (0x%x)\n", (s16)le16_to_cpu(ra->client_in_use_list), le16_to_cpu(ra->client_in_use_list)); ntfs_log_info("flags = 0x%.4x\n", le16_to_cpu(ra->flags)); ntfs_log_info("seq_number_bits = %u (0x%x)\n", (unsigned int)le32_to_cpu(ra->seq_number_bits), (unsigned int)le32_to_cpu(ra->seq_number_bits)); ntfs_log_info("restart_area_length = %u (0x%x)\n", le16_to_cpu(ra->restart_area_length), le16_to_cpu(ra->restart_area_length)); ntfs_log_info("client_array_offset = %u (0x%x)\n", le16_to_cpu(ra->client_array_offset), le16_to_cpu(ra->client_array_offset)); ntfs_log_info("file_size = %lli (0x%llx)\n", (long long)sle64_to_cpu(ra->file_size), (unsigned long long)sle64_to_cpu(ra->file_size)); ntfs_log_info("last_lsn_data_length = %u (0x%x)\n", (unsigned int)le32_to_cpu(ra->last_lsn_data_length), (unsigned int)le32_to_cpu(ra->last_lsn_data_length)); ntfs_log_info("log_record_header_length = %u (0x%x)\n", le16_to_cpu(ra->log_record_header_length), le16_to_cpu(ra->log_record_header_length)); ntfs_log_info("log_page_data_offset = %u (0x%x)\n", le16_to_cpu(ra->log_page_data_offset), le16_to_cpu(ra->log_page_data_offset)); ntfs_log_info("restart_log_open_count = %u (0x%x)\n", (unsigned)le32_to_cpu(ra->restart_log_open_count), (unsigned)le32_to_cpu(ra->restart_log_open_count)); lcr = (LOG_CLIENT_RECORD*)((u8*)ra + le16_to_cpu(ra->client_array_offset)); for (client = 0; client < le16_to_cpu(ra->log_clients); client++) { char *client_name; ntfs_log_info("\nLog client record number %i:\n", client + 1); ntfs_log_info("oldest_lsn = %lli (0x%llx)\n", (long long)sle64_to_cpu(lcr->oldest_lsn), (unsigned long long) sle64_to_cpu(lcr->oldest_lsn)); ntfs_log_info("client_restart_lsn = %lli (0x%llx)\n", (long long) sle64_to_cpu(lcr->client_restart_lsn), (unsigned long long) sle64_to_cpu(lcr->client_restart_lsn)); ntfs_log_info("prev_client = %i (0x%x)\n", (s16)le16_to_cpu(lcr->prev_client), le16_to_cpu(lcr->prev_client)); ntfs_log_info("next_client = %i (0x%x)\n", (s16)le16_to_cpu(lcr->next_client), le16_to_cpu(lcr->next_client)); ntfs_log_info("seq_number = %u (0x%x)\n", le16_to_cpu(lcr->seq_number), le16_to_cpu(lcr->seq_number)); ntfs_log_info("client_name_length = %u (0x%x)\n", (unsigned int)le32_to_cpu(lcr->client_name_length) / 2, (unsigned int)le32_to_cpu(lcr->client_name_length) / 2); if (le32_to_cpu(lcr->client_name_length)) { client_name = NULL; if (ntfs_ucstombs(lcr->client_name, le32_to_cpu(lcr->client_name_length) / 2, &client_name, 0) < 0) { ntfs_log_perror("Failed to convert log client name"); client_name = strdup(""); } } else client_name = strdup(""); ntfs_log_info("client_name = %s\n", client_name); free(client_name); /* * Log client records are fixed size so we can simply use the * C increment operator to get to the next one. */ lcr++; } } /** * dump_restart_areas() */ static void *dump_restart_areas(RESTART_PAGE_HEADER *rstr, u8 *buf, unsigned int page_size) { int pass = 1; rstr_pass_loc: if (ntfs_is_chkd_record(rstr->magic)) log_err_exit(buf, "The %s restart page header in $LogFile has " "been modified by chkdsk. Do not know how to " "handle this yet. Reboot into Windows to fix " "this.\n", (u8*)rstr == buf ? "first" : "second"); if (ntfs_mst_post_read_fixup((NTFS_RECORD*)rstr, page_size) || ntfs_is_baad_record(rstr->magic)) log_err_exit(buf, "$LogFile incomplete multi sector transfer " "detected in restart page header. Cannot " "handle this yet.\n"); if (pass == 1) ntfs_log_info("$LogFile version %i.%i.\n", sle16_to_cpu(rstr->major_ver), sle16_to_cpu(rstr->minor_ver)); else /* if (pass == 2) */ { RESTART_AREA *ra; /* * rstr is now the second restart page so we declare rstr1 * as the first restart page as this one has been verified in * the first pass so we can use all its members safely. */ RESTART_PAGE_HEADER *rstr1 = (RESTART_PAGE_HEADER*)buf; /* Exclude the usa from the comparison. */ ra = (RESTART_AREA*)((u8*)rstr1 + le16_to_cpu(rstr1->restart_area_offset)); if (!memcmp(rstr1, rstr, le16_to_cpu(rstr1->usa_ofs)) && !memcmp((u8*)rstr1 + le16_to_cpu( rstr1->restart_area_offset), (u8*)rstr + le16_to_cpu(rstr->restart_area_offset), le16_to_cpu(ra->restart_area_length))) { puts("\nSkipping analysis of second restart page " "because it fully matches the first " "one."); goto skip_rstr_pass; } /* * The $LogFile versions specified in each of the two restart * page headers must match. */ if (rstr1->major_ver != rstr->major_ver || rstr1->minor_ver != rstr->minor_ver) log_err_exit(buf, "Second restart area specifies " "different $LogFile version to first " "restart area. Cannot handle this " "yet.\n"); } /* The restart page header is in rstr and it is mst deprotected. */ ntfs_log_info("\n%s restart page:\n", pass == 1 ? "1st" : "2nd"); dump_restart_areas_header(rstr); ntfs_log_info("\nRestart area:\n"); dump_restart_areas_area(rstr); skip_rstr_pass: if (pass == 1) { rstr = (RESTART_PAGE_HEADER*)((u8*)rstr + page_size); ++pass; goto rstr_pass_loc; } return rstr; } /** * dump_log_records() */ static void dump_log_record(LOG_RECORD *lr) { unsigned int i; ntfs_log_info("this lsn = 0x%llx\n", (unsigned long long)sle64_to_cpu(lr->this_lsn)); ntfs_log_info("client previous lsn = 0x%llx\n", (unsigned long long) sle64_to_cpu(lr->client_previous_lsn)); ntfs_log_info("client undo next lsn = 0x%llx\n", (unsigned long long) sle64_to_cpu(lr->client_undo_next_lsn)); ntfs_log_info("client data length = 0x%x\n", (unsigned int)le32_to_cpu(lr->client_data_length)); ntfs_log_info("client_id.seq_number = 0x%x\n", le16_to_cpu(lr->client_id.seq_number)); ntfs_log_info("client_id.client_index = 0x%x\n", le16_to_cpu(lr->client_id.client_index)); ntfs_log_info("record type = 0x%x\n", (unsigned int)le32_to_cpu(lr->record_type)); ntfs_log_info("transaction_id = 0x%x\n", (unsigned int)le32_to_cpu(lr->transaction_id)); ntfs_log_info("flags = 0x%x:", le16_to_cpu(lr->log_record_flags)); if (!lr->log_record_flags) ntfs_log_info(" NONE\n"); else { int _b = 0; if (lr->log_record_flags & LOG_RECORD_MULTI_PAGE) { ntfs_log_info(" LOG_RECORD_MULTI_PAGE"); _b = 1; } if (lr->log_record_flags & ~LOG_RECORD_MULTI_PAGE) { if (_b) ntfs_log_info(" |"); ntfs_log_info(" Unknown flags"); } ntfs_log_info("\n"); } ntfs_log_info("redo_operation = 0x%x\n", le16_to_cpu(lr->redo_operation)); ntfs_log_info("undo_operation = 0x%x\n", le16_to_cpu(lr->undo_operation)); ntfs_log_info("redo_offset = 0x%x\n", le16_to_cpu(lr->redo_offset)); ntfs_log_info("redo_length = 0x%x\n", le16_to_cpu(lr->redo_length)); ntfs_log_info("undo_offset = 0x%x\n", le16_to_cpu(lr->undo_offset)); ntfs_log_info("undo_length = 0x%x\n", le16_to_cpu(lr->undo_length)); ntfs_log_info("target_attribute = 0x%x\n", le16_to_cpu(lr->target_attribute)); ntfs_log_info("lcns_to_follow = 0x%x\n", le16_to_cpu(lr->lcns_to_follow)); ntfs_log_info("record_offset = 0x%x\n", le16_to_cpu(lr->record_offset)); ntfs_log_info("attribute_offset = 0x%x\n", le16_to_cpu(lr->attribute_offset)); ntfs_log_info("target_vcn = 0x%llx\n", (unsigned long long)sle64_to_cpu(lr->target_vcn)); if (le16_to_cpu(lr->lcns_to_follow) > 0) ntfs_log_info("Array of lcns:\n"); for (i = 0; i < le16_to_cpu(lr->lcns_to_follow); i++) ntfs_log_info("lcn_list[%u].lcn = 0x%llx\n", i, (unsigned long long)sle64_to_cpu(lr->lcn_list[i])); } /** * dump_log_records() */ static void dump_log_records(RECORD_PAGE_HEADER *rcrd, u8 *buf, int buf_size, unsigned int page_size) { LOG_RECORD *lr; int pass = 0; int client; /* Reuse pass for log area. */ rcrd_pass_loc: rcrd = (RECORD_PAGE_HEADER*)((u8*)rcrd + page_size); if ((u8*)rcrd + page_size > buf + buf_size) return; ntfs_log_info("\nLog record page number %i", pass); if (!ntfs_is_rcrd_record(rcrd->magic) && !ntfs_is_chkd_record(rcrd->magic)) { unsigned int i; for (i = 0; i < page_size; i++) if (((u8*)rcrd)[i] != (u8)-1) break; if (i < page_size) puts(" is corrupt (magic is not RCRD or CHKD)."); else puts(" is empty."); pass++; goto rcrd_pass_loc; } else puts(":"); /* Dump log record page */ ntfs_log_info("magic = %s\n", ntfs_is_rcrd_record(rcrd->magic) ? "RCRD" : "CHKD"); // TODO: I am here... (AIA) ntfs_log_info("copy.last_lsn/file_offset = 0x%llx\n", (unsigned long long) sle64_to_cpu(rcrd->copy.last_lsn)); ntfs_log_info("flags = 0x%x\n", (unsigned int)le32_to_cpu(rcrd->flags)); ntfs_log_info("page count = %i\n", le16_to_cpu(rcrd->page_count)); ntfs_log_info("page position = %i\n", le16_to_cpu(rcrd->page_position)); ntfs_log_info("header.next_record_offset = 0x%llx\n", (unsigned long long) le16_to_cpu(rcrd->next_record_offset)); ntfs_log_info("header.last_end_lsn = 0x%llx\n", (unsigned long long) sle64_to_cpu(rcrd->last_end_lsn)); /* * Where does the 0x40 come from? Is it just usa_offset + * usa_client * 2 + 7 & ~7 or is it derived from somewhere? */ lr = (LOG_RECORD*)((u8*)rcrd + 0x40); client = 0; do { ntfs_log_info("\nLog record %i:\n", client); dump_log_record(lr); client++; lr = (LOG_RECORD*)((u8*)lr + 0x70); } while (((u8*)lr + 0x70 <= (u8*)rcrd + le16_to_cpu(rcrd->next_record_offset))); pass++; goto rcrd_pass_loc; } /** * main - */ int main(int argc, char **argv) { RESTART_PAGE_HEADER *rstr; RECORD_PAGE_HEADER *rcrd; unsigned int page_size; int buf_size, br, err; logfile_file logfile; u8 *buf; ntfs_log_set_handler(ntfs_log_handler_outerr); ntfs_log_info("\n"); if (argc < 2 || argc > 3) /* print usage and exit */ usage(argv[0]); /* * If one argument, it is a device containing an NTFS volume which we * need to mount and read the $LogFile from so we can dump its * contents. * * If two arguments the first one must be "-f" and the second one is * the path and name of the $LogFile (or copy thereof) which we need to * read and dump the contents of. */ if (argc == 2) { logfile_open(TRUE, argv[1], &logfile); } else /* if (argc == 3) */ { if (strncmp(argv[1], "-f", strlen("-f"))) usage(argv[0]); logfile_open(FALSE, argv[2], &logfile); } buf_size = 64 * 1024 * 1024; if (logfile.data_size <= buf_size) buf_size = logfile.data_size; else ntfs_log_error("Warning: $LogFile is too big. " "Only analysing the first 64MiB.\n"); /* For simplicity we read all of $LogFile/$DATA into memory. */ buf = malloc(buf_size); if (!buf) { ntfs_log_perror("Failed to allocate buffer for file data"); logfile_close(&logfile); exit(1); } br = logfile_pread(&logfile, 0, buf_size, buf); err = errno; logfile_close(&logfile); if (br != buf_size) { log_err_exit(buf, "Failed to read $LogFile/$DATA: %s\n", br < 0 ? strerror(err) : "Partial read."); } /* * We now have the entirety of the journal ($LogFile/$DATA or argv[2]) * in the memory buffer buf and this has a size of buf_size. Note we * apply a size capping at 64MiB, so if the journal is any bigger we * only have the first 64MiB. This should not be a problem as I have * never seen such a large $LogFile. Usually it is only a few MiB in * size. */ rstr = (RESTART_PAGE_HEADER*)buf; /* Check for presence of restart area signature. */ if (!ntfs_is_rstr_record(rstr->magic) && !ntfs_is_chkd_record(rstr->magic)) { s8 *pos = (s8*)buf; s8 *end = pos + buf_size; while (pos < end && *pos == -1) pos++; if (pos != end) log_err_exit(buf, "$LogFile contents are corrupt " "(magic RSTR is missing). Cannot " "handle this yet.\n"); /* All bytes are -1. */ free(buf); puts("$LogFile is not initialized."); return 0; } /* * First, verify the restart page header for consistency. */ restart_header_sanity(rstr, buf); page_size = le32_to_cpu(rstr->log_page_size); /* * Second, verify the restart area itself. */ // TODO: Implement this. ntfs_log_error("Warning: Sanity checking of restart area not implemented " "yet.\n"); /* * Third and last, verify the array of log client records. */ // TODO: Implement this. ntfs_log_error("Warning: Sanity checking of array of log client records not " "implemented yet.\n"); /* * Dump the restart headers & areas. */ rcrd = (RECORD_PAGE_HEADER*)dump_restart_areas(rstr, buf, page_size); ntfs_log_info("\n\nFinished with restart pages. " "Beginning with log pages.\n"); /* * Dump the log areas. */ dump_log_records(rcrd, buf, buf_size, page_size); free(buf); return 0; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsfallocate.8.in000066400000000000000000000103301507404161300227260ustar00rootroot00000000000000.\" Copyright (c) 2014 Jean-Pierre Andre .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSFALLOCATE 8 "June 2014" "ntfs-3g @VERSION@" .SH NAME ntfsfallocate \- preallocate space to a file on an NTFS volume .SH SYNOPSIS \fBntfsfallocate\fR [\fIoptions\fR] -l \fIlength\fR \fIdevice\fR \fIfile\fR \fI[attr-type\fR [\fIattr-name\fR]] .SH DESCRIPTION .B ntfsfallocate preallocates space for any attribute of a file or directory, thus reserving space before actual contents is written. This is similar to fallocate(1). .SH OPTIONS Below is a summary of all the options that .B ntfsfallocate accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-f\fR, \fB\-\-force\fR This will override some sensible defaults, such as not using a mounted volume. Use this option with caution. .TP \fB\-h\fR, \fB\-\-help\fR Show a list of options with a brief description of each one. .TP \fB\-l\fR, \fB\-\-length\fR LENGTH This is a mandatory option to specify the number of bytes to preallocate. It will be rounded up to a multiple of the cluster size. A suffix of K, M, G, T, P or E may be appended to mean a multiplicative factor of a power of 1000. Similarly a suffix of Ki, Mi, Gi, Ti, Pi or Ei may be appended to mean a multiplicative factor of a power of 1024. .TP \fB\-n\fR, \fB\-\-no-size-change\fR Do not change the apparent size of the file. The space allocated beyond the apparent size is not zeroed, but subsequent writing beyond the apparent end of file will force zeroing the inner allocated space as it cannot be considered as a hole any more, and this may take significant time. .TP \fB\-N\fR, \fB\-\-no-action\fR Simulate the allocation without actually write to device. .TP \fB\-o\fR, \fB\-\-offset\fR OFFSET Specify the offset in the file where preallocation starts. By default, the preallocation is counted from the beginning of the file. Space already allocated in the area defined by offset and length is preserved. .TP \fB\-q\fR, \fB\-\-quiet\fR Suppress some debug/warning/error messages. .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license of .BR ntfsfallocate . .TP \fBattr-type\fR Define a particular attribute type to be preallocated (advanced use only). By default, the unnamed $DATA attribute (the contents of a plain file) will be preallocated. The attribute has to be specified by a number in decimal or hexadecimal : .TS box; lB lB lB l l l. Hex Decimal Name 0x10 16 "$STANDARD_INFORMATION" 0x20 32 "$ATTRIBUTE_LIST" 0x30 48 "$FILE_NAME" 0x40 64 "$OBJECT_ID" 0x50 80 "$SECURITY_DESCRIPTOR" 0x60 96 "$VOLUME_NAME" 0x70 112 "$VOLUME_INFORMATION" 0x80 128 "$DATA" 0x90 144 "$INDEX_ROOT" 0xA0 160 "$INDEX_ALLOCATION" 0xB0 176 "$BITMAP" 0xC0 192 "$REPARSE_POINT" 0xD0 208 "$EA_INFORMATION" 0xE0 224 "$EA" 0xF0 240 "$PROPERTY_SET" 0x100 256 "$LOGGED_UTILITY_STREAM" .TE .sp .TP \fBattr-name\fR Define the name of the particular attribute type to be preallocated (advanced use only). .SH EXAMPLES Preallocate 100MB to the file database.db located in the Data directory which is at the root of an NTFS file system. .RS .sp .B ntfsfallocate -l 100M /dev/sda1 Data/database.db .sp .RE .SH BUGS There are no known problems with .BR ntfsfallocate , however it can lead to configurations not supported by Windows and Windows may crash (BSOD) when writing to preallocated clusters which were not written to earlier. Files with preallocated space should be fully be written to before they are updated by Windows. .P If you find a bug in \fBntfsfallocate\fR proper, please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS .B ntfsfallocate was written by Jean-Pierre Andre. .SH AVAILABILITY .B ntfsfallocate is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO .BR ntfs-3g (8), .BR ntfstruncate (8), .BR ntfsprogs (8), .BR fallocate (1) ntfsprogs-plus-1.0.0/src/deprecated/ntfsfallocate.c000066400000000000000000000526521507404161300224110ustar00rootroot00000000000000/** * ntfsfallocate * * Copyright (c) 2013-2020 Jean-Pierre Andre * * This utility will allocate clusters to a specified attribute belonging * to a specified file or directory, to a specified length. * * WARNING : this can lead to configurations not supported by Windows * and Windows may crash (BSOD) when writing to preallocated clusters * which were not written to. * * 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 (in the main directory of the Linux-NTFS source * in the file COPYING); if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDARG_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_TIME_H #include #endif #ifdef HAVE_GETOPT_H #include #else extern char *optarg; extern int optind; #endif #ifdef HAVE_LIMITS_H #include #endif #ifndef LLONG_MAX #define LLONG_MAX 9223372036854775807LL #endif #include "types.h" #include "attrib.h" #include "inode.h" #include "layout.h" #include "volume.h" #include "logging.h" #include "runlist.h" #include "dir.h" #include "bitmap.h" #include "lcnalloc.h" #include "utils.h" #include "misc.h" const char *EXEC_NAME = "ntfsfallocate"; char *dev_name; const char *file_name; le32 attr_type; ntfschar *attr_name = NULL; u32 attr_name_len; s64 opt_alloc_offs; s64 opt_alloc_len; ATTR_DEF *attr_defs; static struct { /* -h, print usage and exit. */ int no_action; /* do not write to device, only display what would be done. */ int no_size_change; /* -n, do not change the apparent size */ int quiet; /* -q, quiet execution. */ int verbose; /* -v, verbose execution, given twice, really verbose execution (debug mode). */ int force; /* -f, force allocation. */ /* -V, print version and exit. */ } opts; static const struct option lopt[] = { { "offset", required_argument, NULL, 'o' }, { "length", required_argument, NULL, 'l' }, { "force", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "no-action", no_argument, NULL, 'N' }, { "no-size-change", no_argument, NULL, 'n' }, { "quiet", no_argument, NULL, 'q' }, { "version", no_argument, NULL, 'V' }, { "verbose", no_argument, NULL, 'v' }, { NULL, 0, NULL, 0 } }; /** * err_exit - error output and terminate; ignores quiet (-q) * * DO NOT USE when allocations are not in initial state */ __attribute__((noreturn)) __attribute__((format(printf, 2, 3))) static void err_exit(ntfs_volume *vol, const char *fmt, ...) { va_list ap; fprintf(stderr, "ERROR: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); fprintf(stderr, "Aborting...\n"); if (vol && ntfs_umount(vol, 0)) fprintf(stderr, "Warning: Could not umount %s\n", dev_name); exit(1); } /** * copyright - print copyright statements */ static void copyright(void) { fprintf(stderr, "Copyright (c) 2013-2014 Jean-Pierre Andre\n" "Allocate clusters to a specified attribute of " "a specified file.\n"); } /** * license - print license statement */ static void license(void) { fprintf(stderr, "%s", ntfs_gpl); } /** * usage - print a list of the parameters to the program */ __attribute__((noreturn)) static void usage(int ret) { copyright(); fprintf(stderr, "Usage: %s [options] -l length device file [attr-type " "[attr-name]]\n" " If attr-type is not specified, 0x80 (i.e. $DATA) " "is assumed.\n" " If attr-name is not specified, an unnamed " "attribute is assumed.\n" " -f Force execution despite errors\n" " -n Do not change the apparent size of file\n" " -l length Allocate length bytes\n" " -o offset Start allocating at offset\n" " -v Verbose execution\n" " -vv Very verbose execution\n" " -V Display version information\n" " -h Display this help\n", EXEC_NAME); fprintf(stderr, "%s%s", ntfs_bugs, ntfs_home); exit(ret); } /** * err_exit - error output, display usage and exit */ __attribute__((noreturn)) __attribute__((format(printf, 1, 2))) static void err_usage(const char *fmt, ...) { va_list ap; fprintf(stderr, "ERROR: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); fprintf(stderr, "\n"); usage(1); } /* * Get a value option with a possible multiple suffix */ static s64 option_value(const char *arg) { s64 ll; char *s; s64 fact; int count; BOOL err; err = FALSE; ll = strtoll(arg, &s, 0); if ((ll >= LLONG_MAX) && (errno == ERANGE)) err_exit((ntfs_volume*)NULL, "Too big value : %s\n",arg); if (*s) { count = 0; switch (*s++) { case 'E' : count++; /* FALLTHRU */ case 'P' : count++; /* FALLTHRU */ case 'T' : count++; /* FALLTHRU */ case 'G' : count++; /* FALLTHRU */ case 'M' : count++; /* FALLTHRU */ case 'K' : count++; switch (*s++) { case 'i' : fact = 1024; if (*s++ != 'B') err = TRUE; break; case 'B' : fact = 1000; break; case '\0' : fact = 1024; s--; break; default : err = TRUE; fact = 1; break; } if (*s) err = TRUE; break; default : err = TRUE; break; } if (err) err_exit((ntfs_volume*)NULL, "Invalid suffix in : %s\n",arg); else while (count-- > 0) { if (ll > LLONG_MAX/1024) err_exit((ntfs_volume*)NULL, "Too big value : %s\n",arg); ll *= fact; } } return (ll); } /** * parse_options */ static void parse_options(int argc, char *argv[]) { long long ll; char *s, *s2; int c; opt_alloc_len = 0; opt_alloc_offs = 0; if (argc && *argv) EXEC_NAME = *argv; fprintf(stderr, "%s v%s (libntfs-3g)\n", EXEC_NAME, VERSION); while ((c = getopt_long(argc, argv, "fh?no:qvVl:", lopt, NULL)) != EOF) { switch (c) { case 'f': opts.force = 1; break; case 'n': opts.no_size_change = 1; break; case 'N': /* Not proposed as a short option */ opts.no_action = 1; break; case 'q': opts.quiet = 1; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case 'V': /* Version number already printed */ license(); exit(0); case 'l': ll = option_value(argv[optind - 1]); if ((ll <= 0) || (ll >= LLONG_MAX && errno == ERANGE)) err_usage("Invalid length : %s\n", argv[optind - 1]); opt_alloc_len = ll; break; case 'o': ll = option_value(argv[optind - 1]); if ((ll < 0) || (ll >= LLONG_MAX && errno == ERANGE)) err_usage("Invalid offset : %s\n", argv[optind - 1]); opt_alloc_offs = ll; break; case 'h': usage(0); case '?': default: usage(1); } } if (!opt_alloc_len) { err_usage("Missing allocation length\n"); } ntfs_log_verbose("length = %lli = 0x%llx\n", (long long)opt_alloc_len, (long long)opt_alloc_len); ntfs_log_verbose("offset = %lli = 0x%llx\n", (long long)opt_alloc_offs, (long long)opt_alloc_offs); if (optind == argc) usage(1); if (opts.verbose > 1) ntfs_log_set_levels(NTFS_LOG_LEVEL_DEBUG | NTFS_LOG_LEVEL_TRACE | NTFS_LOG_LEVEL_VERBOSE | NTFS_LOG_LEVEL_QUIET); /* Get the device. */ dev_name = argv[optind++]; ntfs_log_verbose("device name = %s\n", dev_name); if (optind == argc) usage(1); /* Get the file name. */ file_name = argv[optind++]; ntfs_log_verbose("file name = \"%s\"\n", file_name); /* Get the attribute type, if specified. */ if (optind == argc) { attr_type = AT_DATA; attr_name = AT_UNNAMED; attr_name_len = 0; } else { unsigned long ul; s = argv[optind++]; ul = strtoul(s, &s2, 0); if (*s2 || !ul || (ul >= ULONG_MAX && errno == ERANGE)) err_usage("Invalid attribute type %s: %s\n", s, strerror(errno)); attr_type = cpu_to_le32(ul); /* Get the attribute name, if specified. */ if (optind != argc) { s = argv[optind++]; /* Convert the string to little endian Unicode. */ attr_name_len = ntfs_mbstoucs(s, &attr_name); if ((int)attr_name_len < 0) err_usage("Invalid attribute name " "\"%s\": %s\n", s, strerror(errno)); /* Keep hold of the original string. */ s2 = s; s = argv[optind++]; if (optind != argc) usage(1); } else { attr_name = AT_UNNAMED; attr_name_len = 0; } } ntfs_log_verbose("attribute type = 0x%lx\n", (unsigned long)le32_to_cpu(attr_type)); if (attr_name == AT_UNNAMED) ntfs_log_verbose("attribute name = \"\" (UNNAMED)\n"); else ntfs_log_verbose("attribute name = \"%s\" (length %u " "Unicode characters)\n", s2, (unsigned int)attr_name_len); } /* * Save the initial runlist, to be restored on error */ static runlist_element *ntfs_save_rl(runlist_element *rl) { runlist_element *save; int n; n = 0; save = (runlist_element*)NULL; if (rl) { while (rl[n].length) n++; save = (runlist_element*)malloc((n + 1)*sizeof(runlist_element)); if (save) { memcpy(save, rl, (n + 1)*sizeof(runlist_element)); } } return (save); } /* * Free the common part of two runs */ static void free_common(ntfs_volume *vol, runlist_element *brl, s64 blth, runlist_element *grl, s64 glth) { VCN begin_common; VCN end_common; begin_common = max(grl->vcn, brl->vcn); end_common = min(grl->vcn + glth, brl->vcn + blth); if (end_common > begin_common) { if (ntfs_bitmap_clear_run(vol->lcnbmp_na, brl->lcn + begin_common - brl->vcn, end_common - begin_common)) ntfs_log_error("Failed to free %lld clusters " "from 0x%llx\n", (long long)end_common - begin_common, (long long)(brl->lcn + begin_common - brl->vcn)); } } /* * Restore the cluster allocations to initial state * * If a new error occurs, only output a message */ static void ntfs_restore_rl(ntfs_attr *na, runlist_element *oldrl) { runlist_element *brl; /* Pointer to bad runlist */ runlist_element *grl; /* Pointer to good runlist */ ntfs_volume *vol; vol = na->ni->vol; /* Examine allocated entries from the bad runlist */ for (brl=na->rl; brl->length; brl++) { if (brl->lcn != LCN_HOLE) { // TODO improve by examining both list in parallel /* Find the holes in the good runlist which overlap */ for (grl=oldrl; grl->length && (grl->vcn<=(brl->vcn+brl->length)); grl++) { if (grl->lcn == LCN_HOLE) { free_common(vol, brl, brl->length, grl, grl->length); } } /* Free allocations beyond the end of good runlist */ if (grl && !grl->length && ((brl->vcn + brl->length) > grl->vcn)) { free_common(vol, brl, brl->length, grl, brl->vcn + brl->length - grl->vcn); } } } free(na->rl); na->rl = oldrl; if (ntfs_attr_update_mapping_pairs(na, 0)) { ntfs_log_error("Failed to restore the original runlist\n"); } } /* * Zero newly allocated runs up to initialized_size */ static int ntfs_inner_zero(ntfs_attr *na, runlist_element *rl) { ntfs_volume *vol; char *buf; runlist_element *zrl; s64 cofs; s64 pos; s64 zeroed; int err; err = 0; vol = na->ni->vol; buf = (char*)malloc(vol->cluster_size); if (buf) { memset(buf, 0, vol->cluster_size); zrl = rl; pos = zrl->vcn << vol->cluster_size_bits; while (zrl->length && !err && (pos < na->initialized_size)) { for (cofs=0; cofslength && !err; cofs++) { zeroed = ntfs_pwrite(vol->dev, (rl->lcn + cofs) << vol->cluster_size_bits, vol->cluster_size, buf); if (zeroed != vol->cluster_size) { ntfs_log_error("Failed to zero at " "offset %lld\n", (long long)pos); errno = EIO; err = -1; } pos += vol->cluster_size; } zrl++; pos = zrl->vcn << vol->cluster_size_bits; } free(buf); } else { ntfs_log_error("Failed to allocate memory\n"); errno = ENOSPC; err = -1; } return (err); } /* * Merge newly allocated runs into runlist */ static int ntfs_merge_allocation(ntfs_attr *na, runlist_element *rl, s64 size) { ntfs_volume *vol; int err; err = 0; vol = na->ni->vol; /* Newly allocated clusters before initialized size need be zeroed */ if ((rl->vcn << vol->cluster_size_bits) < na->initialized_size) { err = ntfs_inner_zero(na, rl); } if (!err) { if (na->data_flags & ATTR_IS_SPARSE) { na->compressed_size += size; if (na->compressed_size >= na->allocated_size) { na->data_flags &= ~ATTR_IS_SPARSE; if (na->compressed_size > na->allocated_size) { ntfs_log_error("File size error : " "apparent %lld, " "compressed %lld > " "allocated %lld", (long long)na->data_size, (long long)na->compressed_size, (long long)na->allocated_size); errno = EIO; err = -1; } } } } if (!err) { rl = ntfs_runlists_merge(na->rl, rl); if (!rl) { ntfs_log_error("Failed to merge the new allocation\n"); err = -1; } else { na->rl = rl; /* Update the runlist */ if (ntfs_attr_update_mapping_pairs(na, 0)) { ntfs_log_error( "Failed to update the runlist\n"); err = -1; } } } return (err); } static int ntfs_inner_allocation(ntfs_attr *na, s64 alloc_offs, s64 alloc_len) { ntfs_volume *vol; runlist_element *rl; runlist_element *prl; runlist_element *rlc; VCN from_vcn; VCN end_vcn; LCN lcn_seek_from; VCN from_hole; VCN end_hole; s64 need; int err; BOOL done; err = 0; vol = na->ni->vol; /* Find holes which overlap the requested allocation */ from_vcn = alloc_offs >> vol->cluster_size_bits; end_vcn = (alloc_offs + alloc_len + vol->cluster_size - 1) >> vol->cluster_size_bits; do { done = FALSE; rl = na->rl; while (rl->length && ((rl->lcn >= 0) || ((rl->vcn + rl->length) <= from_vcn) || (rl->vcn >= end_vcn))) rl++; if (!rl->length) done = TRUE; else { from_hole = max(from_vcn, rl->vcn); end_hole = min(end_vcn, rl->vcn + rl->length); need = end_hole - from_hole; lcn_seek_from = -1; if (rl->vcn) { /* Avoid fragmentation when possible */ prl = rl; if ((--prl)->lcn >= 0) { lcn_seek_from = prl->lcn + from_hole - prl->vcn; } } if (need <= 0) { ntfs_log_error("Wrong hole size %lld\n", (long long)need); errno = EIO; err = -1; } else { rlc = ntfs_cluster_alloc(vol, from_hole, need, lcn_seek_from, DATA_ZONE); if (!rlc) err = -1; else err = ntfs_merge_allocation(na, rlc, need << vol->cluster_size_bits); } } } while (!err && !done); return (err); } static int ntfs_full_allocation(ntfs_attr *na, ntfs_attr_search_ctx *ctx, s64 alloc_offs, s64 alloc_len) { ATTR_RECORD *attr; ntfs_inode *ni; s64 initialized_size; s64 data_size; int err; err = 0; initialized_size = na->initialized_size; data_size = na->data_size; if (na->allocated_size <= alloc_offs) { /* * Request is fully beyond what was already allocated : * only need to expand the attribute */ err = ntfs_attr_truncate(na, alloc_offs); if (!err) err = ntfs_attr_truncate_solid(na, alloc_offs + alloc_len); } else { /* * Request overlaps what was already allocated : * We may have to fill existing holes, and force zeroes * into clusters which are visible. */ if ((alloc_offs + alloc_len) > na->allocated_size) err = ntfs_attr_truncate(na, alloc_offs + alloc_len); if (!err) err = ntfs_inner_allocation(na, alloc_offs, alloc_len); } /* Set the sizes, even after an error, to keep consistency */ na->initialized_size = initialized_size; /* Restore the original apparent size if requested or error */ if (err || opts.no_size_change || ((alloc_offs + alloc_len) < data_size)) na->data_size = data_size; else { /* * "man 1 fallocate" does not define the new apparent size * when size change is allowed (no --keep-size). * Assuming the same as no FALLOC_FL_KEEP_SIZE in fallocate(2) : * "the file size will be changed if offset + len is greater * than the file size" // TODO check the behavior of another file system */ na->data_size = alloc_offs + alloc_len; } if (!err) { /* Find the attribute, which may have been relocated for allocations */ if (ntfs_attr_lookup(attr_type, attr_name, attr_name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { err = -1; ntfs_log_error("Failed to locate the attribute\n"); } else { /* Feed the sizes into the attribute */ attr = ctx->attr; attr->data_size = cpu_to_sle64(na->data_size); attr->initialized_size = cpu_to_sle64(na->initialized_size); attr->allocated_size = cpu_to_sle64(na->allocated_size); if (na->data_flags & ATTR_IS_SPARSE) attr->compressed_size = cpu_to_sle64(na->compressed_size); /* Copy the unnamed data attribute sizes to inode */ if ((attr_type == AT_DATA) && !attr_name_len) { ni = na->ni; ni->data_size = na->data_size; if (na->data_flags & ATTR_IS_SPARSE) { ni->allocated_size = na->compressed_size; ni->flags |= FILE_ATTR_SPARSE_FILE; } else ni->allocated_size = na->allocated_size; } } } return (err); } /* * Do the actual allocations */ static int ntfs_fallocate(ntfs_inode *ni, s64 alloc_offs, s64 alloc_len) { s64 allocated_size; s64 data_size; ntfs_attr_search_ctx *ctx; ntfs_attr *na; runlist_element *oldrl; const char *errmess; int save_errno; int err; err = 0; /* Open the specified attribute. */ na = ntfs_attr_open(ni, attr_type, attr_name, attr_name_len); if (!na) { ntfs_log_perror("Failed to open attribute 0x%lx: ", (unsigned long)le32_to_cpu(attr_type)); err = -1; } else { errmess = (const char*)NULL; if (na->data_flags & ATTR_IS_COMPRESSED) { errmess= "Cannot fallocate a compressed file"; } /* Locate the attribute record, needed for updating sizes */ ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) { errmess = "Failed to allocate a search context"; } if (errmess) { ntfs_log_error("%s\n",errmess); err = -1; } else { /* Get and save the initial allocations */ allocated_size = na->allocated_size; data_size = ni->data_size; if (na->rl) err = ntfs_attr_map_whole_runlist(na); if (!err) { if (na->rl) oldrl = ntfs_save_rl(na->rl); else oldrl = (runlist_element*)NULL; if (!na->rl || oldrl) { err = ntfs_full_allocation(na, ctx, alloc_offs, alloc_len); if (err) { save_errno = errno; ni->allocated_size = allocated_size; ni->data_size = data_size; ntfs_restore_rl(na, oldrl); errno = save_errno; } else { free(oldrl); /* Mark file name dirty, to update the sizes in directories */ NInoFileNameSetDirty(ni); NInoSetDirty(ni); } } else err = -1; } ntfs_attr_put_search_ctx(ctx); } /* Close the attribute. */ ntfs_attr_close(na); } return (err); } /** * main */ int main(int argc, char **argv) { unsigned long mnt_flags, ul; int err; ntfs_inode *ni; ntfs_volume *vol; #ifdef HAVE_WINDOWS_H char *unix_name; #endif vol = (ntfs_volume*)NULL; ntfs_log_set_handler(ntfs_log_handler_outerr); /* Initialize opts to zero / required values. */ memset(&opts, 0, sizeof(opts)); /* Parse command line options. */ parse_options(argc, argv); utils_set_locale(); /* Make sure the file system is not mounted. */ if (ntfs_check_if_mounted(dev_name, &mnt_flags)) ntfs_log_perror("Failed to determine whether %s is mounted", dev_name); else if (mnt_flags & NTFS_MF_MOUNTED) { ntfs_log_error("%s is mounted.\n", dev_name); if (!opts.force) err_exit((ntfs_volume*)NULL, "Refusing to run!\n"); fprintf(stderr, "ntfsfallocate forced anyway. Hope /etc/mtab " "is incorrect.\n"); } /* Mount the device. */ if (opts.no_action) { ntfs_log_quiet("Running in READ-ONLY mode!\n"); ul = NTFS_MNT_RDONLY; } else if (opts.force) ul = NTFS_MNT_RECOVER; else ul = 0; vol = ntfs_mount(dev_name, ul); if (!vol) err_exit(vol, "Failed to mount %s: %s\n", dev_name, strerror(errno)); if ((vol->flags & VOLUME_IS_DIRTY) && !opts.force) err_exit(vol, "Volume is dirty, please run chkdsk.\n"); if (ntfs_volume_get_free_space(vol)) err_exit(vol, "Failed to get free clusters %s: %s\n", dev_name, strerror(errno)); /* Open the specified inode. */ #ifdef HAVE_WINDOWS_H unix_name = ntfs_utils_unix_path(file_name); if (unix_name) { ni = ntfs_pathname_to_inode(vol, NULL, unix_name); free(unix_name); } else ni = (ntfs_inode*)NULL; #else ni = ntfs_pathname_to_inode(vol, NULL, file_name); #endif if (!ni) err_exit(vol, "Failed to open file \"%s\": %s\n", file_name, strerror(errno)); if (!opts.no_action) err = ntfs_fallocate(ni, opt_alloc_offs, opt_alloc_len); /* Close the inode. */ if (ntfs_inode_close(ni)) { err = -1; err_exit(vol, "Failed to close inode \"%s\" : %s\n", file_name, strerror(errno)); } /* Unmount the volume. */ err = ntfs_umount(vol, 0); vol = (ntfs_volume*)NULL; if (err) ntfs_log_perror("Warning: Failed to umount %s", dev_name); /* Free the attribute name if it exists. */ if (attr_name_len) ntfs_ucsfree(attr_name); ntfs_log_quiet("ntfsfallocate completed successfully. Have a nice day.\n"); return 0; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsfix.8.in000066400000000000000000000045421507404161300215720ustar00rootroot00000000000000.\" Copyright (c) 2005-2006 Szabolcs Szakacsits. .\" Copyright (c) 2005 Richard Russon. .\" Copyright (c) 2011-2013 Jean-Pierre Andre .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSFIX 8 "January 2013" "ntfs-3g @VERSION@" .SH NAME ntfsfix \- fix common errors and force Windows to check NTFS .SH SYNOPSIS .B ntfsfix [\fIoptions\fR] \fIdevice\fR .SH DESCRIPTION .B ntfsfix is a utility that fixes some common NTFS problems. .B ntfsfix is .B NOT a Linux version of chkdsk. It only repairs some fundamental NTFS inconsistencies, resets the NTFS journal file and schedules an NTFS consistency check for the first boot into Windows. .sp You may run .B ntfsfix on an NTFS volume if you think it was damaged by Windows or some other way and it cannot be mounted. .SH OPTIONS Below is a summary of all the options that .B ntfsfix accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-b\fR, \fB\-\-clear\-bad\-sectors\fR Clear the list of bad sectors. This is useful after cloning an old disk with bad sectors to a new disk. .TP \fB\-d\fR, \fB\-\-clear\-dirty\fR Clear the volume dirty flag if the volume can be fixed and mounted. If the option is not present or the volume cannot be fixed, the dirty volume flag is set to request a volume checking at next mount. .TP \fB\-h\fR, \fB\-\-help\fR Show a list of options with a brief description of each one. .TP \fB\-n\fR, \fB\-\-no\-action\fR Do not write anything, just show what would have been done. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license .SH BUGS There are no known problems with .BR ntfsfix . If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS .B ntfsfix was written by Anton Altaparmakov, with contributions from Szabolcs Szakacsits. It was ported to ntfs-3g by Erik Larsson and Jean-Pierre Andre. .SH AVAILABILITY .B ntfsfix is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO .BR mkntfs (8), .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfsfix.c000066400000000000000000001332301507404161300212350ustar00rootroot00000000000000/** * ntfsfix - Part of the Linux-NTFS project. * * Copyright (c) 2000-2006 Anton Altaparmakov * Copyright (c) 2002-2006 Szabolcs Szakacsits * Copyright (c) 2007 Yura Pakhuchiy * Copyright (c) 2011-2015 Jean-Pierre Andre * * This utility fixes some common NTFS problems, resets the NTFS journal file * and schedules an NTFS consistency check for the first boot into Windows. * * Anton Altaparmakov * * 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 (in the main directory of the Linux-NTFS source * in the file COPYING); if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* * WARNING: This program might not work on architectures which do not allow * unaligned access. For those, the program would need to start using * get/put_unaligned macros (#include ), but not doing it yet, * since NTFS really mostly applies to ia32 only, which does allow unaligned * accesses. We might not actually have a problem though, since the structs are * defined as being packed so that might be enough for gcc to insert the * correct code. * * If anyone using a non-little endian and/or an aligned access only CPU tries * this program please let me know whether it works or not! * * Anton Altaparmakov */ #include "config.h" #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #include "types.h" #include "attrib.h" #include "volume.h" #include "bootsect.h" #include "mft.h" #include "device.h" #include "logfile.h" #include "runlist.h" #include "mst.h" #include "utils.h" /* #include "version.h" */ #include "logging.h" #include "misc.h" #ifdef NO_NTFS_DEVICE_DEFAULT_IO_OPS # error "No default device io operations! Cannot build ntfsfix. \ You need to run ./configure without the --disable-default-device-io-ops \ switch if you want to be able to build the NTFS utilities." #endif static const char *EXEC_NAME = "ntfsfix"; static const char OK[] = "OK\n"; static const char FAILED[] = "FAILED\n"; static const char FOUND[] = "FOUND\n"; #define DEFAULT_SECTOR_SIZE 512 static struct { char *volume; BOOL no_action; BOOL clear_bad_sectors; BOOL clear_dirty; } opt; /* * Definitions for fixing the self-located MFT bug */ #define SELFLOC_LIMIT 16 struct MFT_SELF_LOCATED { ntfs_volume *vol; MFT_RECORD *mft0; MFT_RECORD *mft1; MFT_RECORD *mft2; ATTR_LIST_ENTRY *attrlist; ATTR_LIST_ENTRY *attrlist_to_ref1; MFT_REF mft_ref0; MFT_REF mft_ref1; LCN attrlist_lcn; BOOL attrlist_resident; } ; /** * usage */ __attribute__((noreturn)) static void usage(int ret) { ntfs_log_info("%s v%s (libntfs-3g)\n" "\n" "Usage: %s [options] device\n" " Attempt to fix an NTFS partition.\n" "\n" " -b, --clear-bad-sectors Clear the bad sector list\n" " -d, --clear-dirty Clear the volume dirty flag\n" " -h, --help Display this help\n" " -n, --no-action Do not write anything\n" " -V, --version Display version information\n" "\n" "For example: %s /dev/hda6\n\n", EXEC_NAME, VERSION, EXEC_NAME, EXEC_NAME); ntfs_log_info("%s%s", ntfs_bugs, ntfs_home); exit(ret); } /** * version */ __attribute__((noreturn)) static void version(void) { ntfs_log_info("%s v%s\n\n" "Attempt to fix an NTFS partition.\n\n" "Copyright (c) 2000-2006 Anton Altaparmakov\n" "Copyright (c) 2002-2006 Szabolcs Szakacsits\n" "Copyright (c) 2007 Yura Pakhuchiy\n" "Copyright (c) 2011-2015 Jean-Pierre Andre\n\n", EXEC_NAME, VERSION); ntfs_log_info("%s\n%s%s", ntfs_gpl, ntfs_bugs, ntfs_home); exit(0); } /** * parse_options */ static void parse_options(int argc, char **argv) { int c; static const char *sopt = "-bdhnV"; static const struct option lopt[] = { { "help", no_argument, NULL, 'h' }, { "no-action", no_argument, NULL, 'n' }, { "clear-bad-sectors", no_argument, NULL, 'b' }, { "clear-dirty", no_argument, NULL, 'd' }, { "version", no_argument, NULL, 'V' }, { NULL, 0, NULL, 0 } }; memset(&opt, 0, sizeof(opt)); while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opt.volume) opt.volume = argv[optind - 1]; else { ntfs_log_info("ERROR: Too many arguments.\n"); usage(1); } break; case 'b': opt.clear_bad_sectors = TRUE; break; case 'd': opt.clear_dirty = TRUE; break; case 'n': opt.no_action = TRUE; break; case 'h': usage(0); case '?': usage(1); /* fall through */ case 'V': version(); default: ntfs_log_info("ERROR: Unknown option '%s'.\n", argv[optind - 1]); usage(1); } } if (opt.volume == NULL) { ntfs_log_info("ERROR: You must specify a device.\n"); usage(1); } } /** * OLD_ntfs_volume_set_flags */ static int OLD_ntfs_volume_set_flags(ntfs_volume *vol, const le16 flags) { MFT_RECORD *m = NULL; ATTR_RECORD *a; VOLUME_INFORMATION *c; ntfs_attr_search_ctx *ctx; int ret = -1; /* failure */ if (!vol) { errno = EINVAL; return -1; } if (ntfs_file_record_read(vol, FILE_Volume, &m, NULL)) { ntfs_log_perror("Failed to read $Volume"); return -1; } /* Sanity check */ if (!(m->flags & MFT_RECORD_IN_USE)) { ntfs_log_error("$Volume has been deleted. Cannot handle this " "yet. Run chkdsk to fix this.\n"); errno = EIO; goto err_exit; } /* Get a pointer to the volume information attribute. */ ctx = ntfs_attr_get_search_ctx(NULL, m); if (!ctx) { ntfs_log_debug("Failed to allocate attribute search " "context.\n"); goto err_exit; } if (ntfs_attr_lookup(AT_VOLUME_INFORMATION, AT_UNNAMED, 0, CASE_SENSITIVE, 0, NULL, 0, ctx)) { ntfs_log_error("Attribute $VOLUME_INFORMATION was not found in " "$Volume!\n"); goto err_out; } a = ctx->attr; /* Sanity check. */ if (a->non_resident) { ntfs_log_error("Attribute $VOLUME_INFORMATION must be resident " "(and it isn't)!\n"); errno = EIO; goto err_out; } /* Get a pointer to the value of the attribute. */ c = (VOLUME_INFORMATION*)(le16_to_cpu(a->value_offset) + (char*)a); /* Sanity checks. */ if ((char*)c + le32_to_cpu(a->value_length) > (char*)m + le32_to_cpu(m->bytes_in_use) || le16_to_cpu(a->value_offset) + le32_to_cpu(a->value_length) > le32_to_cpu(a->length)) { ntfs_log_error("Attribute $VOLUME_INFORMATION in $Volume is " "corrupt!\n"); errno = EIO; goto err_out; } /* Set the volume flags. */ vol->flags = c->flags = flags; if (ntfs_mft_record_write(vol, FILE_Volume, m)) { ntfs_log_perror("Error writing $Volume"); goto err_out; } ret = 0; /* success */ err_out: ntfs_attr_put_search_ctx(ctx); err_exit: free(m); return ret; } /** * set_dirty_flag */ static int set_dirty_flag(ntfs_volume *vol) { le16 flags; /* Porting note: We test for the current state of VOLUME_IS_DIRTY. This * should actually be more appropriate than testing for NVolWasDirty. */ if (vol->flags & VOLUME_IS_DIRTY) return 0; ntfs_log_info("Setting required flags on partition... "); /* * Set chkdsk flag, i.e. mark the partition dirty so chkdsk will run * and fix it for us. */ flags = vol->flags | VOLUME_IS_DIRTY; if (!opt.no_action && OLD_ntfs_volume_set_flags(vol, flags)) { ntfs_log_info(FAILED); ntfs_log_error("Error setting volume flags.\n"); return -1; } vol->flags = flags; /* Porting note: libntfs-3g does not have the 'WasDirty' flag/property, * and never touches the 'dirty' bit except when explicitly told to do * so. Since we just wrote the VOLUME_IS_DIRTY bit to disk, and * vol->flags is up-to-date, we can just ignore the NVolSetWasDirty * statement. */ /* NVolSetWasDirty(vol); */ ntfs_log_info(OK); return 0; } /** * empty_journal */ static int empty_journal(ntfs_volume *vol) { if (NVolLogFileEmpty(vol)) return 0; ntfs_log_info("Going to empty the journal ($LogFile)... "); if (ntfs_logfile_reset(vol)) { ntfs_log_info(FAILED); ntfs_log_perror("Failed to reset $LogFile"); return -1; } ntfs_log_info(OK); return 0; } /* * Clear the sparse flag of an attribute */ static int clear_sparse(ntfs_attr *na, const char *name) { ntfs_attr_search_ctx *ctx; int res; res = -1; ctx = ntfs_attr_get_search_ctx(na->ni, NULL); if (ctx) { if (!ntfs_attr_lookup(na->type, na->name, na->name_len, CASE_SENSITIVE, 0, NULL, 0, ctx)) { na->data_flags &= ~ATTR_IS_SPARSE; ctx->attr->data_size = cpu_to_sle64(na->data_size); ctx->attr->initialized_size = cpu_to_sle64(na->initialized_size); ctx->attr->flags = na->data_flags; ctx->attr->compression_unit = 0; ntfs_inode_mark_dirty(ctx->ntfs_ino); NInoFileNameSetDirty(na->ni); res = 0; } else ntfs_log_perror("Could not locate attribute for %s", name); ntfs_attr_put_search_ctx(ctx); } else ntfs_log_perror("Could not get a search context for %s", name); return (res); } /** * Clear the bad cluster marks (option) */ static int clear_badclus(ntfs_volume *vol) { static ntfschar badstream[] = { const_cpu_to_le16('$'), const_cpu_to_le16('B'), const_cpu_to_le16('a'), const_cpu_to_le16('d') } ; ntfs_inode *ni; ntfs_attr *na; BOOL ok; ok = FALSE; ntfs_log_info("Going to un-mark the bad clusters ($BadClus)... "); ni = ntfs_inode_open(vol, FILE_BadClus); if (ni) { na = ntfs_attr_open(ni, AT_DATA, badstream, 4); /* * chkdsk does not adjust the data size when * moving clusters to $BadClus, so we have to * check the runlist. */ if (na && !ntfs_attr_map_whole_runlist(na)) { if (na->rl && na->rl[0].length && na->rl[1].length) { /* * Truncate the stream to free all its clusters, * (which requires setting the data size according * to allocation), then reallocate a sparse stream * to full size of volume and reset the data size. * Note : the sparse flags should not be set. */ na->data_size = na->allocated_size; na->initialized_size = na->allocated_size; if (!ntfs_attr_truncate(na,0) && !ntfs_attr_truncate(na,vol->nr_clusters << vol->cluster_size_bits)) { na->initialized_size = 0; NInoFileNameSetDirty(ni); ok = TRUE; } else { ntfs_log_perror("Failed to un-mark the bad clusters"); } } else { ntfs_log_info("No bad clusters..."); ok = TRUE; } /* * The sparse flags are not set after an initial * formatting, so do the same. */ if (ok) { ni->flags &= ~FILE_ATTR_SPARSE_FILE; ok = !clear_sparse(na, "$BadClus::$Bad"); } ntfs_attr_close(na); } else { ntfs_log_perror("Failed to open $BadClus::$Bad"); } ntfs_inode_close(ni); } else { ntfs_log_perror("Failed to open inode FILE_BadClus"); } if (ok) ntfs_log_info(OK); return (ok ? 0 : -1); } /** * fix_mftmirr */ static int fix_mftmirr(ntfs_volume *vol) { s64 l, br; unsigned char *m, *m2; int i, ret = -1; /* failure */ BOOL done; ntfs_log_info("\nProcessing $MFT and $MFTMirr...\n"); /* Load data from $MFT and $MFTMirr and compare the contents. */ m = (u8*)malloc(vol->mftmirr_size << vol->mft_record_size_bits); if (!m) { ntfs_log_perror("Failed to allocate memory"); return -1; } m2 = (u8*)malloc(vol->mftmirr_size << vol->mft_record_size_bits); if (!m2) { ntfs_log_perror("Failed to allocate memory"); free(m); return -1; } ntfs_log_info("Reading $MFT... "); l = ntfs_attr_mst_pread(vol->mft_na, 0, vol->mftmirr_size, vol->mft_record_size, m); if (l != vol->mftmirr_size) { ntfs_log_info(FAILED); if (l != -1) errno = EIO; ntfs_log_perror("Failed to read $MFT"); goto error_exit; } ntfs_log_info(OK); ntfs_log_info("Reading $MFTMirr... "); l = ntfs_attr_mst_pread(vol->mftmirr_na, 0, vol->mftmirr_size, vol->mft_record_size, m2); if (l != vol->mftmirr_size) { ntfs_log_info(FAILED); if (l != -1) errno = EIO; ntfs_log_perror("Failed to read $MFTMirr"); goto error_exit; } ntfs_log_info(OK); /* * FIXME: Need to actually check the $MFTMirr for being real. Otherwise * we might corrupt the partition if someone is experimenting with * software RAID and the $MFTMirr is not actually in the position we * expect it to be... )-: * FIXME: We should emit a warning it $MFTMirr is damaged and ask * user whether to recreate it from $MFT or whether to abort. - The * warning needs to include the danger of software RAID arrays. * Maybe we should go as far as to detect whether we are running on a * MD disk and if yes then bomb out right at the start of the program? */ ntfs_log_info("Comparing $MFTMirr to $MFT... "); done = FALSE; /* * Since 2017, Windows 10 does not mirror to full $MFTMirr when * using big clusters, and some records may be found different. * Nevertheless chkdsk.exe mirrors it fully, so we do similarly. */ for (i = 0; i < vol->mftmirr_size; ++i) { MFT_RECORD *mrec, *mrec2; const char *ESTR[12] = { "$MFT", "$MFTMirr", "$LogFile", "$Volume", "$AttrDef", "root directory", "$Bitmap", "$Boot", "$BadClus", "$Secure", "$UpCase", "$Extend" }; const char *s; BOOL use_mirr; if (i < 12) s = ESTR[i]; else if (i < 16) s = "system file"; else s = "mft record"; use_mirr = FALSE; mrec = (MFT_RECORD*)(m + i * vol->mft_record_size); if (mrec->flags & MFT_RECORD_IN_USE) { if (ntfs_is_baad_record(mrec->magic)) { ntfs_log_info(FAILED); ntfs_log_error("$MFT error: Incomplete multi " "sector transfer detected in " "%s.\nCannot handle this yet. " ")-:\n", s); goto error_exit; } if (!ntfs_is_mft_record(mrec->magic)) { ntfs_log_info(FAILED); ntfs_log_error("$MFT error: Invalid mft " "record for %s.\nCannot " "handle this yet. )-:\n", s); goto error_exit; } } mrec2 = (MFT_RECORD*)(m2 + i * vol->mft_record_size); if (mrec2->flags & MFT_RECORD_IN_USE) { if (ntfs_is_baad_record(mrec2->magic)) { ntfs_log_info(FAILED); ntfs_log_error("$MFTMirr error: Incomplete " "multi sector transfer " "detected in %s.\n", s); goto error_exit; } if (!ntfs_is_mft_record(mrec2->magic)) { ntfs_log_info(FAILED); ntfs_log_error("$MFTMirr error: Invalid mft " "record for %s.\n", s); goto error_exit; } /* $MFT is corrupt but $MFTMirr is ok, use $MFTMirr. */ if (!(mrec->flags & MFT_RECORD_IN_USE) && !ntfs_is_mft_record(mrec->magic)) use_mirr = TRUE; } if (memcmp(mrec, mrec2, ntfs_mft_record_get_data_size(mrec))) { if (!done) { done = TRUE; ntfs_log_info(FAILED); } ntfs_log_info("Correcting differences in $MFT%s " "record %d...", use_mirr ? "" : "Mirr", i); br = ntfs_mft_record_write(vol, i, use_mirr ? mrec2 : mrec); if (br) { ntfs_log_info(FAILED); ntfs_log_perror("Error correcting $MFT%s", use_mirr ? "" : "Mirr"); goto error_exit; } ntfs_log_info(OK); } } if (!done) ntfs_log_info(OK); ntfs_log_info("Processing of $MFT and $MFTMirr completed " "successfully.\n"); ret = 0; error_exit: free(m); free(m2); return ret; } /* * Rewrite the $UpCase file as default * * Returns 0 if could be written */ static int rewrite_upcase(ntfs_volume *vol, ntfs_attr *na) { s64 l; int res; /* writing the $UpCase may require bitmap updates */ res = -1; vol->lcnbmp_ni = ntfs_inode_open(vol, FILE_Bitmap); if (!vol->lcnbmp_ni) { ntfs_log_perror("Failed to open bitmap inode"); } else { vol->lcnbmp_na = ntfs_attr_open(vol->lcnbmp_ni, AT_DATA, AT_UNNAMED, 0); if (!vol->lcnbmp_na) { ntfs_log_perror("Failed to open bitmap data attribute"); } else { /* minimal consistency check on the bitmap */ if (((vol->lcnbmp_na->data_size << 3) < vol->nr_clusters) || ((vol->lcnbmp_na->data_size << 3) >= (vol->nr_clusters << 1)) || (vol->lcnbmp_na->data_size > vol->lcnbmp_na->allocated_size)) { ntfs_log_error("Corrupt cluster map size %lld" " (allocated %lld minimum %lld)\n", (long long)vol->lcnbmp_na->data_size, (long long)vol->lcnbmp_na->allocated_size, (long long)(vol->nr_clusters + 7) >> 3); } else { ntfs_log_info("Rewriting $UpCase file\n"); l = ntfs_attr_pwrite(na, 0, vol->upcase_len*2, vol->upcase); if (l != vol->upcase_len*2) { ntfs_log_error("Failed to rewrite $UpCase\n"); } else { ntfs_log_info("$UpCase has been set to default\n"); res = 0; } } ntfs_attr_close(vol->lcnbmp_na); vol->lcnbmp_na = (ntfs_attr*)NULL; } ntfs_inode_close(vol->lcnbmp_ni); vol->lcnbmp_ni = (ntfs_inode*)NULL; } return (res); } /* * Fix the $UpCase file * * Returns 0 if the table is valid or has been fixed */ static int fix_upcase(ntfs_volume *vol) { ntfs_inode *ni; ntfs_attr *na; ntfschar *upcase; s64 l; u32 upcase_len; u32 k; int res; res = -1; ni = (ntfs_inode*)NULL; na = (ntfs_attr*)NULL; /* Now load the upcase table from $UpCase. */ ntfs_log_debug("Loading $UpCase...\n"); ni = ntfs_inode_open(vol, FILE_UpCase); if (!ni) { ntfs_log_perror("Failed to open inode FILE_UpCase"); goto error_exit; } /* Get an ntfs attribute for $UpCase/$DATA. */ na = ntfs_attr_open(ni, AT_DATA, AT_UNNAMED, 0); if (!na) { ntfs_log_perror("Failed to open ntfs attribute"); goto error_exit; } /* * Note: Normally, the upcase table has a length equal to 65536 * 2-byte Unicode characters but allow for different cases, so no * checks done. Just check we don't overflow 32-bits worth of Unicode * characters. */ if (na->data_size & ~0x1ffffffffULL) { ntfs_log_error("Error: Upcase table is too big (max 32-bit " "allowed).\n"); errno = EINVAL; goto error_exit; } upcase_len = na->data_size >> 1; upcase = (ntfschar*)ntfs_malloc(na->data_size); if (!upcase) goto error_exit; /* Read in the $DATA attribute value into the buffer. */ l = ntfs_attr_pread(na, 0, na->data_size, upcase); if (l != na->data_size) { ntfs_log_error("Failed to read $UpCase, unexpected length " "(%lld != %lld).\n", (long long)l, (long long)na->data_size); errno = EIO; goto error_exit; } /* Consistency check of $UpCase, restricted to plain ASCII chars */ k = 0x20; while ((k < upcase_len) && (k < 0x7f) && (le16_to_cpu(upcase[k]) == ((k < 'a') || (k > 'z') ? k : k + 'A' - 'a'))) k++; if (k < 0x7f) { ntfs_log_error("Corrupted file $UpCase\n"); if (!opt.no_action) { /* rewrite the $UpCase file from default */ res = rewrite_upcase(vol, na); /* free the bad upcase record */ if (!res) free(upcase); } else { /* keep the default upcase but return an error */ free(upcase); } } else { /* accept the upcase table read from $UpCase */ free(vol->upcase); vol->upcase = upcase; vol->upcase_len = upcase_len; res = 0; } error_exit : /* Done with the $UpCase mft record. */ if (na) ntfs_attr_close(na); if (ni && ntfs_inode_close(ni)) { ntfs_log_perror("Failed to close $UpCase"); } return (res); } /* * Rewrite the boot sector * * Returns 0 if successful */ static int rewrite_boot(struct ntfs_device *dev, char *full_bs, s32 sector_size) { s64 bw; int res; res = -1; ntfs_log_info("Rewriting the bootsector\n"); bw = ntfs_pwrite(dev, 0, sector_size, full_bs); if (bw == sector_size) res = 0; else { if (bw != -1) errno = EINVAL; if (!bw) ntfs_log_error("Failed to rewrite the bootsector (size=0)\n"); else ntfs_log_perror("Error rewriting the bootsector"); } return (res); } /* * Locate an unnamed attribute in an MFT record * * Returns NULL if not found (with no error message) */ static ATTR_RECORD *find_unnamed_attr(MFT_RECORD *mrec, ATTR_TYPES type) { ATTR_RECORD *a; u32 offset; s32 space; /* fetch the requested attribute */ offset = le16_to_cpu(mrec->attrs_offset); space = le32_to_cpu(mrec->bytes_in_use) - offset; a = (ATTR_RECORD*)((char*)mrec + offset); while ((space >= (s32)offsetof(ATTR_RECORD, resident_end)) && (a->type != AT_END) && (le32_to_cpu(a->length) <= (u32)space) && !(le32_to_cpu(a->length) & 7) && ((a->type != type) || a->name_length)) { offset += le32_to_cpu(a->length); space -= le32_to_cpu(a->length); a = (ATTR_RECORD*)((char*)mrec + offset); } if ((offset >= le32_to_cpu(mrec->bytes_in_use)) || (a->type != type) || a->name_length) a = (ATTR_RECORD*)NULL; return (a); } /* * First condition for having a self-located MFT : * only 16 MFT records are defined in MFT record 0 * * Only low-level library functions can be used. * * Returns TRUE if the condition is met. */ static BOOL short_mft_selfloc_condition(struct MFT_SELF_LOCATED *selfloc) { BOOL ok; ntfs_volume *vol; MFT_RECORD *mft0; ATTR_RECORD *a; runlist_element *rl; u16 seqn; ok = FALSE; vol = selfloc->vol; mft0 = selfloc->mft0; if ((ntfs_pread(vol->dev, vol->mft_lcn << vol->cluster_size_bits, vol->mft_record_size, mft0) == vol->mft_record_size) && !ntfs_mst_post_read_fixup((NTFS_RECORD*)mft0, vol->mft_record_size) && !ntfs_mft_record_check(vol, 0, mft0)) { a = find_unnamed_attr(mft0,AT_DATA); if (a && a->non_resident && (((sle64_to_cpu(a->highest_vcn) + 1) << vol->cluster_size_bits) == (SELFLOC_LIMIT*vol->mft_record_size))) { rl = ntfs_mapping_pairs_decompress(vol, a, NULL); if (rl) { /* * The first error condition is having only * 16 entries mapped in the first MFT record. */ if ((rl[0].lcn >= 0) && ((rl[0].length << vol->cluster_size_bits) == SELFLOC_LIMIT*vol->mft_record_size) && (rl[1].vcn == rl[0].length) && (rl[1].lcn == LCN_RL_NOT_MAPPED)) { ok = TRUE; seqn = le16_to_cpu( mft0->sequence_number); selfloc->mft_ref0 = ((MFT_REF)seqn) << 48; } free(rl); } } } return (ok); } /* * Second condition for having a self-located MFT : * The 16th MFT record is defined in MFT record >= 16 * * Only low-level library functions can be used. * * Returns TRUE if the condition is met. */ static BOOL attrlist_selfloc_condition(struct MFT_SELF_LOCATED *selfloc) { ntfs_volume *vol; ATTR_RECORD *a; ATTR_LIST_ENTRY *attrlist; ATTR_LIST_ENTRY *al; runlist_element *rl; VCN vcn; leVCN levcn; u32 length; int ok; ok = FALSE; length = 0; vol = selfloc->vol; a = find_unnamed_attr(selfloc->mft0,AT_ATTRIBUTE_LIST); if (a) { selfloc->attrlist_resident = !a->non_resident; selfloc->attrlist_lcn = 0; if (a->non_resident) { attrlist = selfloc->attrlist; rl = ntfs_mapping_pairs_decompress(vol, a, NULL); if (rl && (rl->lcn >= 0) && (sle64_to_cpu(a->data_size) < vol->cluster_size) && (ntfs_pread(vol->dev, rl->lcn << vol->cluster_size_bits, vol->cluster_size, attrlist) == vol->cluster_size)) { selfloc->attrlist_lcn = rl->lcn; al = attrlist; length = sle64_to_cpu(a->data_size); } } else { al = (ATTR_LIST_ENTRY*) ((char*)a + le16_to_cpu(a->value_offset)); length = le32_to_cpu(a->value_length); } if (length) { /* search for a data attribute defining entry 16 */ vcn = (SELFLOC_LIMIT*vol->mft_record_size) >> vol->cluster_size_bits; levcn = cpu_to_sle64(vcn); while ((length > 0) && al->length && ((al->type != AT_DATA) || ((leVCN)al->lowest_vcn != levcn))) { length -= le16_to_cpu(al->length); al = (ATTR_LIST_ENTRY*) ((char*)al + le16_to_cpu(al->length)); } if ((length > 0) && al->length && (al->type == AT_DATA) && !al->name_length && ((leVCN)al->lowest_vcn == levcn) && (MREF_LE(al->mft_reference) >= SELFLOC_LIMIT)) { selfloc->mft_ref1 = le64_to_cpu(al->mft_reference); selfloc->attrlist_to_ref1 = al; ok = TRUE; } } } return (ok); } /* * Third condition for having a self-located MFT : * The location of the second part of the MFT is defined in itself * * To locate the second part, we have to assume the first and the * second part of the MFT data are contiguous. * * Only low-level library functions can be used. * * Returns TRUE if the condition is met. */ static BOOL self_mapped_selfloc_condition(struct MFT_SELF_LOCATED *selfloc) { BOOL ok; s64 inum; u64 offs; VCN lowest_vcn; MFT_RECORD *mft1; ATTR_RECORD *a; ntfs_volume *vol; runlist_element *rl; ok = FALSE; vol = selfloc->vol; mft1 = selfloc->mft1; inum = MREF(selfloc->mft_ref1); offs = (vol->mft_lcn << vol->cluster_size_bits) + (inum << vol->mft_record_size_bits); if ((ntfs_pread(vol->dev, offs, vol->mft_record_size, mft1) == vol->mft_record_size) && !ntfs_mst_post_read_fixup((NTFS_RECORD*)mft1, vol->mft_record_size) && !ntfs_mft_record_check(vol, inum, mft1)) { lowest_vcn = (SELFLOC_LIMIT*vol->mft_record_size) >> vol->cluster_size_bits; a = find_unnamed_attr(mft1,AT_DATA); if (a && (mft1->flags & MFT_RECORD_IN_USE) && ((VCN)sle64_to_cpu(a->lowest_vcn) == lowest_vcn) && (le64_to_cpu(mft1->base_mft_record) == selfloc->mft_ref0) && ((u16)MSEQNO(selfloc->mft_ref1) == le16_to_cpu(mft1->sequence_number))) { rl = ntfs_mapping_pairs_decompress(vol, a, NULL); if ((rl[0].lcn == LCN_RL_NOT_MAPPED) && !rl[0].vcn && (rl[0].length == lowest_vcn) && (rl[1].vcn == lowest_vcn) && ((u64)(rl[1].lcn << vol->cluster_size_bits) <= offs) && ((u64)((rl[1].lcn + rl[1].length) << vol->cluster_size_bits) > offs)) { ok = TRUE; } } } return (ok); } /* * Fourth condition, to be able to fix a self-located MFT : * The MFT record 15 must be available. * * The MFT record 15 is expected to be marked in use, we assume * it is available if it has no parent, no name and no attr list. * * Only low-level library functions can be used. * * Returns TRUE if the condition is met. */ static BOOL spare_record_selfloc_condition(struct MFT_SELF_LOCATED *selfloc) { BOOL ok; s64 inum; u64 offs; MFT_RECORD *mft2; ntfs_volume *vol; ok = FALSE; vol = selfloc->vol; mft2 = selfloc->mft2; inum = SELFLOC_LIMIT - 1; offs = (vol->mft_lcn << vol->cluster_size_bits) + (inum << vol->mft_record_size_bits); if ((ntfs_pread(vol->dev, offs, vol->mft_record_size, mft2) == vol->mft_record_size) && !ntfs_mst_post_read_fixup((NTFS_RECORD*)mft2, vol->mft_record_size) && !ntfs_mft_record_check(vol, inum, mft2)) { if (!mft2->base_mft_record && (mft2->flags & MFT_RECORD_IN_USE) && !find_unnamed_attr(mft2,AT_ATTRIBUTE_LIST) && !find_unnamed_attr(mft2,AT_FILE_NAME)) { ok = TRUE; } } return (ok); } /* * Fix a self-located MFT by swapping two MFT records * * Only low-level library functions can be used. * * Returns 0 if the MFT corruption could be fixed. */ static int fix_selfloc_conditions(struct MFT_SELF_LOCATED *selfloc) { MFT_RECORD *mft1; MFT_RECORD *mft2; ATTR_RECORD *a; ATTR_LIST_ENTRY *al; ntfs_volume *vol; s64 offs; s64 offsm; s64 offs1; s64 offs2; s64 inum; u16 usa_ofs; int res; res = 0; /* * In MFT1, we must fix : * - the self-reference, if present, * - its own sequence number, must be 15 * - the sizes of the data attribute. */ vol = selfloc->vol; mft1 = selfloc->mft1; mft2 = selfloc->mft2; usa_ofs = le16_to_cpu(mft1->usa_ofs); if (usa_ofs >= 48) mft1->mft_record_number = const_cpu_to_le32(SELFLOC_LIMIT - 1); mft1->sequence_number = const_cpu_to_le16(SELFLOC_LIMIT - 1); a = find_unnamed_attr(mft1,AT_DATA); if (a) { a->allocated_size = const_cpu_to_sle64(0); a->data_size = const_cpu_to_sle64(0); a->initialized_size = const_cpu_to_sle64(0); } else res = -1; /* bug : it has been found earlier */ /* * In MFT2, we must fix : * - the self-reference, if present */ usa_ofs = le16_to_cpu(mft2->usa_ofs); if (usa_ofs >= 48) mft2->mft_record_number = cpu_to_le32(MREF(selfloc->mft_ref1)); /* * In the attribute list, we must fix : * - the reference to MFT1 */ al = selfloc->attrlist_to_ref1; al->mft_reference = MK_LE_MREF(SELFLOC_LIMIT - 1, SELFLOC_LIMIT - 1); /* * All fixes done, we can write all if allowed */ if (!res && !opt.no_action) { inum = SELFLOC_LIMIT - 1; offs2 = (vol->mft_lcn << vol->cluster_size_bits) + (inum << vol->mft_record_size_bits); inum = MREF(selfloc->mft_ref1); offs1 = (vol->mft_lcn << vol->cluster_size_bits) + (inum << vol->mft_record_size_bits); /* rewrite the attribute list */ if (selfloc->attrlist_resident) { /* write mft0 and mftmirr if it is resident */ offs = vol->mft_lcn << vol->cluster_size_bits; offsm = vol->mftmirr_lcn << vol->cluster_size_bits; if (ntfs_mst_pre_write_fixup( (NTFS_RECORD*)selfloc->mft0, vol->mft_record_size) || (ntfs_pwrite(vol->dev, offs, vol->mft_record_size, selfloc->mft0) != vol->mft_record_size) || (ntfs_pwrite(vol->dev, offsm, vol->mft_record_size, selfloc->mft0) != vol->mft_record_size)) res = -1; } else { /* write a full cluster if non resident */ offs = selfloc->attrlist_lcn << vol->cluster_size_bits; if (ntfs_pwrite(vol->dev, offs, vol->cluster_size, selfloc->attrlist) != vol->cluster_size) res = -1; } /* replace MFT2 by MFT1 and replace MFT1 by MFT2 */ if (!res && (ntfs_mst_pre_write_fixup((NTFS_RECORD*)selfloc->mft1, vol->mft_record_size) || ntfs_mst_pre_write_fixup((NTFS_RECORD*)selfloc->mft2, vol->mft_record_size) || (ntfs_pwrite(vol->dev, offs2, vol->mft_record_size, mft1) != vol->mft_record_size) || (ntfs_pwrite(vol->dev, offs1, vol->mft_record_size, mft2) != vol->mft_record_size))) res = -1; } return (res); } /* * Detect and fix a Windows XP bug, leading to a corrupt MFT * * Windows cannot boot anymore, so chkdsk cannot be started, which * is a good point, because chkdsk would have deleted all the files. * Older ntfs-3g fell into an endless recursion (recent versions * refuse to mount). * * This situation is very rare, but it was fun to fix it. * * The corrupted condition is : * - MFT entry 0 has only the runlist for MFT entries 0-15 * - The attribute list for MFT shows the second part * in an MFT record beyond 15 * Of course, this record has to be read in order to know where it is. * * Sample case, met in 2011 (Windows XP) : * MFT record 0 has : stdinfo, nonres attrlist, the first * part of MFT data (entries 0-15), and bitmap * MFT record 16 has the name * MFT record 17 has the third part of MFT data (16-117731) * MFT record 18 has the second part of MFT data (117732-170908) * * Assuming the second part of the MFT is contiguous to the first * part, we can find it, and fix the condition by relocating it * and swapping it with MFT record 15. * This record number 15 appears to be hardcoded into Windows NTFS. * * Only low-level library functions can be used. * * Returns 0 if the conditions for the error was met and * this error could be fixed, * -1 if the condition was not met or some error * which could not be fixed was encountered. */ static int fix_self_located_mft(ntfs_volume *vol) { struct MFT_SELF_LOCATED selfloc; BOOL res; ntfs_log_info("Checking for self-located MFT segment... "); res = -1; selfloc.vol = vol; selfloc.mft0 = (MFT_RECORD*)malloc(vol->mft_record_size); selfloc.mft1 = (MFT_RECORD*)malloc(vol->mft_record_size); selfloc.mft2 = (MFT_RECORD*)malloc(vol->mft_record_size); selfloc.attrlist = (ATTR_LIST_ENTRY*)malloc(vol->cluster_size); if (selfloc.mft0 && selfloc.mft1 && selfloc.mft2 && selfloc.attrlist) { if (short_mft_selfloc_condition(&selfloc) && attrlist_selfloc_condition(&selfloc) && self_mapped_selfloc_condition(&selfloc) && spare_record_selfloc_condition(&selfloc)) { ntfs_log_info(FOUND); ntfs_log_info("Fixing the self-located MFT segment... "); res = fix_selfloc_conditions(&selfloc); ntfs_log_info(res ? FAILED : OK); } else { ntfs_log_info(OK); res = -1; } free(selfloc.mft0); free(selfloc.mft1); free(selfloc.mft2); free(selfloc.attrlist); } return (res); } /* * Try an alternate boot sector and fix the real one * * Only after successful checks is the boot sector rewritten. * * The alternate boot sector is not rewritten, either because it * was found correct, or because we truncated the file system * and the last actual sector might be part of some file. * * Returns 0 if successful */ static int try_fix_boot(ntfs_volume *vol, char *full_bs, s64 read_sector, s64 fix_sectors, s32 sector_size) { s64 br; int res; s64 got_sectors; le16 sector_size_le; NTFS_BOOT_SECTOR *bs; res = -1; br = ntfs_pread(vol->dev, read_sector*sector_size, sector_size, full_bs); if (br != sector_size) { if (br != -1) errno = EINVAL; if (!br) ntfs_log_error("Failed to read alternate bootsector (size=0)\n"); else ntfs_log_perror("Error reading alternate bootsector"); } else { bs = (NTFS_BOOT_SECTOR*)full_bs; got_sectors = sle64_to_cpu(bs->number_of_sectors); bs->number_of_sectors = cpu_to_sle64(fix_sectors); /* alignment problem on Sparc, even doing memcpy() */ sector_size_le = cpu_to_le16(sector_size); if (!memcmp(§or_size_le, &bs->bpb.bytes_per_sector,2) && ntfs_boot_sector_is_ntfs(bs) && !ntfs_boot_sector_parse(vol, bs)) { ntfs_log_info("The alternate bootsector is usable\n"); if (fix_sectors != got_sectors) ntfs_log_info("Set sector count to %lld instead of %lld\n", (long long)fix_sectors, (long long)got_sectors); /* fix the normal boot sector */ if (!opt.no_action) { res = rewrite_boot(vol->dev, full_bs, sector_size); } else res = 0; } if (!res && !opt.no_action) ntfs_log_info("The boot sector has been rewritten\n"); } return (res); } /* * Try the alternate boot sector if the normal one is bad * * Actually : * - first try the last sector of the partition (expected location) * - then try the last sector as shown in the main boot sector, * (could be meaningful for an undersized partition) * - finally try truncating the file system actual size of partition * (could be meaningful for an oversized partition) * * if successful, rewrite the normal boot sector accordingly * * Returns 0 if successful */ static int try_alternate_boot(ntfs_volume *vol, char *full_bs, s32 sector_size, s64 shown_sectors) { s64 actual_sectors; int res; res = -1; ntfs_log_info("Trying the alternate boot sector\n"); /* * We do not rely on the sector size defined in the * boot sector, supposed to be corrupt, so we try to get * the actual sector size and defaulting to 512 if failed * to get. This value is only used to guess the alternate * boot sector location and it is checked against the * value found in the sector itself. It should not damage * anything if wrong. * * Note : the real last sector is not accounted for here. */ actual_sectors = ntfs_device_size_get(vol->dev,sector_size) - 1; /* first try the actual last sector */ if ((actual_sectors > 0) && !try_fix_boot(vol, full_bs, actual_sectors, actual_sectors, sector_size)) res = 0; /* then try the shown last sector, if less than actual */ if (res && (shown_sectors > 0) && (shown_sectors < actual_sectors) && !try_fix_boot(vol, full_bs, shown_sectors, shown_sectors, sector_size)) res = 0; /* then try reducing the number of sectors to actual value */ if (res && (shown_sectors > actual_sectors) && !try_fix_boot(vol, full_bs, 0, actual_sectors, sector_size)) res = 0; return (res); } /* * Check and fix the alternate boot sector * * The alternate boot sector is usually in the last sector of a * partition, which should not be used by the file system * (the sector count in the boot sector should be less than * the total sector count in the partition). * * chkdsk never changes the count in the boot sector. * - If this is less than the total count, chkdsk place the * alternate boot sector into the sector, * - if the count is the same as the total count, chkdsk place * the alternate boot sector into the middle sector (half * the total count rounded upwards) * - if the count is greater than the total count, chkdsk * declares the file system as raw, and refuses to fix anything. * * Here, we check and fix the alternate boot sector, only in the * first situation where the file system does not overflow on the * last sector. * * Note : when shrinking a partition, ntfsresize cannot determine * the future size of the partition. As a consequence the number of * sectors in the boot sectors may be less than the possible size. * * Returns 0 if successful */ static int check_alternate_boot(ntfs_volume *vol) { s64 got_sectors; s64 actual_sectors; s64 last_sector_off; char *full_bs; char *alt_bs; NTFS_BOOT_SECTOR *bs; s64 br; s64 bw; int res; res = -1; full_bs = (char*)malloc(vol->sector_size); alt_bs = (char*)malloc(vol->sector_size); if (!full_bs || !alt_bs) { ntfs_log_info("Error : failed to allocate memory\n"); goto error_exit; } /* Now read both bootsectors. */ br = ntfs_pread(vol->dev, 0, vol->sector_size, full_bs); if (br == vol->sector_size) { bs = (NTFS_BOOT_SECTOR*)full_bs; got_sectors = sle64_to_cpu(bs->number_of_sectors); actual_sectors = ntfs_device_size_get(vol->dev, vol->sector_size); if (actual_sectors > got_sectors) { last_sector_off = (actual_sectors - 1) << vol->sector_size_bits; ntfs_log_info("Checking the alternate boot sector... "); br = ntfs_pread(vol->dev, last_sector_off, vol->sector_size, alt_bs); } else { ntfs_log_info("Checking file system overflow... "); br = -1; } /* accept getting no byte, needed for short image files */ if (br >= 0) { if ((br != vol->sector_size) || memcmp(full_bs, alt_bs, vol->sector_size)) { if (opt.no_action) { ntfs_log_info("BAD\n"); } else { bw = ntfs_pwrite(vol->dev, last_sector_off, vol->sector_size, full_bs); if (bw == vol->sector_size) { ntfs_log_info("FIXED\n"); res = 0; } else { ntfs_log_info(FAILED); } } } else { ntfs_log_info(OK); res = 0; } } else { ntfs_log_info(FAILED); } } else { ntfs_log_info("Error : could not read the boot sector again\n"); } free(full_bs); free(alt_bs); error_exit : return (res); } /* * Try to fix problems which may arise in the start up sequence * * This is a replay of the normal start up sequence with fixes when * some problem arise. * * Returns 0 if there was an error and a fix is available */ static int fix_startup(struct ntfs_device *dev, unsigned long flags) { s64 br; ntfs_volume *vol; BOOL dev_open; s64 shown_sectors; char *full_bs; NTFS_BOOT_SECTOR *bs; s32 sector_size; int res; int eo; errno = 0; res = -1; dev_open = FALSE; full_bs = (char*)NULL; if (!dev || !dev->d_ops || !dev->d_name) { errno = EINVAL; ntfs_log_perror("%s: dev = %p", __FUNCTION__, dev); vol = (ntfs_volume*)NULL; goto error_exit; } /* Allocate the volume structure. */ vol = ntfs_volume_alloc(); if (!vol) goto error_exit; /* Create the default upcase table. */ vol->upcase_len = ntfs_upcase_build_default(&vol->upcase); if (!vol->upcase_len || !vol->upcase) goto error_exit; /* Default with no locase table and case sensitive file names */ vol->locase = (ntfschar*)NULL; NVolSetCaseSensitive(vol); /* by default, all files are shown and not marked hidden */ NVolSetShowSysFiles(vol); NVolSetShowHidFiles(vol); NVolClearHideDotFiles(vol); if (flags & NTFS_MNT_RDONLY) NVolSetReadOnly(vol); /* ...->open needs bracketing to compile with glibc 2.7 */ if ((dev->d_ops->open)(dev, NVolReadOnly(vol) ? O_RDONLY: O_RDWR)) { ntfs_log_perror("Error opening '%s'", dev->d_name); goto error_exit; } dev_open = TRUE; /* Attach the device to the volume. */ vol->dev = dev; sector_size = ntfs_device_sector_size_get(dev); if (sector_size <= 0) sector_size = DEFAULT_SECTOR_SIZE; full_bs = (char*)malloc(sector_size); if (!full_bs) goto error_exit; /* Now read the bootsector. */ br = ntfs_pread(dev, 0, sector_size, full_bs); if (br != sector_size) { if (br != -1) errno = EINVAL; if (!br) ntfs_log_error("Failed to read bootsector (size=0)\n"); else ntfs_log_perror("Error reading bootsector"); goto error_exit; } bs = (NTFS_BOOT_SECTOR*)full_bs; if (!ntfs_boot_sector_is_ntfs(bs) /* get the bootsector data, only fails when inconsistent */ || (ntfs_boot_sector_parse(vol, bs) < 0)) { shown_sectors = sle64_to_cpu(bs->number_of_sectors); /* boot sector is wrong, try the alternate boot sector */ if (try_alternate_boot(vol, full_bs, sector_size, shown_sectors)) { errno = EINVAL; goto error_exit; } res = 0; } else { res = fix_self_located_mft(vol); } error_exit: if (res) { switch (errno) { case ENOMEM : ntfs_log_error("Failed to allocate memory\n"); break; case EINVAL : ntfs_log_error("Unrecoverable error\n"); break; default : break; } } eo = errno; free(full_bs); if (vol) { free(vol->upcase); free(vol); } if (dev_open) { (dev->d_ops->close)(dev); } errno = eo; return (res); } /** * fix_mount */ static int fix_mount(void) { int ret = 0; /* default success */ ntfs_volume *vol; struct ntfs_device *dev; unsigned long flags; ntfs_log_info("Attempting to correct errors... "); dev = ntfs_device_alloc(opt.volume, 0, &ntfs_device_default_io_ops, NULL); if (!dev) { ntfs_log_info(FAILED); ntfs_log_perror("Failed to allocate device"); return -1; } flags = (opt.no_action ? NTFS_MNT_RDONLY : 0); vol = ntfs_volume_startup(dev, flags); if (!vol) { ntfs_log_info(FAILED); ntfs_log_perror("Failed to startup volume"); /* Try fixing the bootsector and MFT, then redo the startup */ if (!fix_startup(dev, flags)) { if (opt.no_action) ntfs_log_info("The startup data can be fixed, " "but no change was requested\n"); else vol = ntfs_volume_startup(dev, flags); } if (!vol) { ntfs_log_error("Volume is corrupt. You should run chkdsk.\n"); ntfs_device_free(dev); return -1; } if (opt.no_action) ret = -1; /* error present and not fixed */ } /* if option -n proceed despite errors, to display them all */ if ((!ret || opt.no_action) && (fix_mftmirr(vol) < 0)) ret = -1; if ((!ret || opt.no_action) && (fix_upcase(vol) < 0)) ret = -1; if ((!ret || opt.no_action) && (set_dirty_flag(vol) < 0)) ret = -1; if ((!ret || opt.no_action) && (empty_journal(vol) < 0)) ret = -1; /* * ntfs_umount() will invoke ntfs_device_free() for us. * Ignore the returned error resulting from partial mounting. */ ntfs_umount(vol, 1); return ret; } /** * main */ int main(int argc, char **argv) { ntfs_volume *vol; unsigned long mnt_flags; unsigned long flags; int ret = 1; /* failure */ BOOL force = FALSE; ntfs_log_set_handler(ntfs_log_handler_outerr); parse_options(argc, argv); if (!ntfs_check_if_mounted(opt.volume, &mnt_flags)) { if ((mnt_flags & NTFS_MF_MOUNTED) && !(mnt_flags & NTFS_MF_READONLY) && !force) { ntfs_log_error("Refusing to operate on read-write " "mounted device %s.\n", opt.volume); exit(1); } } else ntfs_log_perror("Failed to determine whether %s is mounted", opt.volume); /* Attempt a full mount first. */ flags = (opt.no_action ? NTFS_MNT_RDONLY : 0); ntfs_log_info("Mounting volume... "); vol = ntfs_mount(opt.volume, flags); if (vol) { ntfs_log_info(OK); ntfs_log_info("Processing of $MFT and $MFTMirr completed " "successfully.\n"); } else { ntfs_log_info(FAILED); if (fix_mount() < 0) { if (opt.no_action) ntfs_log_info("No change made\n"); exit(1); } vol = ntfs_mount(opt.volume, 0); if (!vol) { ntfs_log_perror("Remount failed"); exit(1); } } if (check_alternate_boot(vol)) { ntfs_log_error("Error: Failed to fix the alternate boot sector\n"); exit(1); } /* So the unmount does not clear it again. */ /* Porting note: The WasDirty flag was set here to prevent ntfs_unmount * from clearing the dirty bit (which might have been set in * fix_mount()). So the intention is to leave the dirty bit set. * * libntfs-3g does not automatically set or clear dirty flags on * mount/unmount, this means that the assumption that the dirty flag is * now set does not hold. So we need to set it if not already set. * * However clear the flag if requested to do so, at this stage * mounting was successful. */ if (opt.clear_dirty) vol->flags &= ~VOLUME_IS_DIRTY; else vol->flags |= VOLUME_IS_DIRTY; if (!opt.no_action && ntfs_volume_write_flags(vol, vol->flags)) { ntfs_log_error("Error: Failed to set volume dirty flag (%d " "(%s))!\n", errno, strerror(errno)); } /* Check NTFS version is ok for us (in $Volume) */ ntfs_log_info("NTFS volume version is %i.%i.\n", vol->major_ver, vol->minor_ver); if (ntfs_version_is_supported(vol)) { ntfs_log_error("Error: Unknown NTFS version.\n"); goto error_exit; } if (opt.clear_bad_sectors && !opt.no_action) { if (clear_badclus(vol)) { ntfs_log_error("Error: Failed to un-mark bad sectors.\n"); goto error_exit; } } if (vol->major_ver >= 3) { /* * FIXME: If on NTFS 3.0+, check for presence of the usn * journal and stamp it if present. */ } /* FIXME: We should be marking the quota out of date, too. */ /* That's all for now! */ ntfs_log_info("NTFS partition %s was processed successfully.\n", vol->dev->d_name); /* Set return code to 0. */ ret = 0; error_exit: if (ntfs_umount(vol, 1)) { ntfs_log_info("Failed to unmount partition\n"); ret = 1; } if (ret) exit(ret); return ret; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsls.8.in000066400000000000000000000062621507404161300214230ustar00rootroot00000000000000.\" Copyright (c) 2003 Anton Altaparmakov. .\" Copyright (c) 2005 Richard Russon. .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSLS 8 "November 2005" "ntfs-3g @VERSION@" .SH NAME ntfsls \- list directory contents on an NTFS filesystem .SH SYNOPSIS .B ntfsls [\fIoptions\fR] \fIdevice\fR .sp .B ntfsls [ .B \-a | .B \-\-all ] [ .B \-F | .B \-\-classify ] [ .B \-f | .B \-\-force ] [ .B \-h | .B \-\-help ] [ .B \-i | .B \-\-inode ] [ .B \-l | .B \-\-long ] [ .B \-p | .B \-\-path .I PATH ] [ .B \-q | .B \-\-quiet ] [ .B \-s | .B \-\-system ] [ .B \-V | .B \-\-version ] [ .B \-v | .B \-\-verbose ] [ .B \-x | .B \-\-dos ] .I device .SH DESCRIPTION .B ntfsls is used to list information about the files specified by the .I PATH option (the root directory by default). .I DEVICE is the special file corresponding to the device (e.g .IR /dev/hdXX ) or an NTFS image file. .SH OPTIONS Below is a summary of all the options that .B ntfsls accepts. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-fv is equivalent to .BR "\-f \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-a\fR, \fB\-\-all\fR Display all files. If this option is not specified file names in the POSIX namespace will not be displayed. .TP \fB\-F\fR, \fB\-\-classify\fR Append indicator (one of */=@|) to entries. .TP \fB\-f\fR, \fB\-\-force\fR Force execution. For example necessary to run on an NTFS partition stored in a normal file. .TP \fB\-h\fR, \fB\-\-help\fR Print the usage information of .B ntfsls and exit. .TP \fB\-i\fR, \fB\-\-inode\fR Print inode number of each file. This is the MFT reference number in NTFS terminology. .TP \fB\-l\fR, \fB\-\-long\fR Use a long listing format. .TP \fB\-p\fR, \fB\-\-path\fR PATH The directory whose contents to list or the file (including the path) about which to display information. .TP \fB\-q\fR, \fB\-\-quiet\fR Suppress some debug/warning/error messages. .TP \fB\-R\fR, \fB\-\-recursive\fR Show the contents of all directories beneath the specified directory. .TP \fB\-s\fR, \fB\-\-system\fR Unless this options is specified, all files beginning with a dollar sign character will not be listed as these files are usually system files. .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .TP \fB\-V\fR, \fB\-\-version\fR Print the version number of .B ntfsls and exit. .TP \fB\-x\fR, \fB\-\-dos\fR Display short file names, i.e. files in the DOS namespace, instead of long file names, i.e. files in the WIN32 namespace. .SH BUGS There are no known problems with .BR ntfsls . If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS This version of .B ntfsls was written by Lode Leroy, Anton Altaparmakov, Richard Russon, Carmelo Kintana and Giang Nguyen. It was ported to ntfs-3g by Erik Larsson. .SH AVAILABILITY .B ntfsls is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfsls.c000066400000000000000000000412241507404161300210660ustar00rootroot00000000000000/** * ntfsls - Part of the Linux-NTFS project. * * Copyright (c) 2003 Lode Leroy * Copyright (c) 2003-2005 Anton Altaparmakov * Copyright (c) 2003 Richard Russon * Copyright (c) 2004 Carmelo Kintana * Copyright (c) 2004 Giang Nguyen * * This utility will list a directory's files. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_TIME_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_STRING_H #include #endif #include "types.h" #include "mft.h" #include "attrib.h" #include "layout.h" #include "inode.h" #include "utils.h" #include "dir.h" #include "list.h" #include "ntfstime.h" /* #include "version.h" */ #include "logging.h" static const char *EXEC_NAME = "ntfsls"; /** * To hold sub-directory information for recursive listing. * @depth: the level of this dir relative to opts.path */ struct dir { struct ntfs_list_head list; ntfs_inode *ni; char name[MAX_PATH]; int depth; }; /** * path_component - to store path component strings * * @name: string pointer * * NOTE: @name is not directly allocated memory. It simply points to the * character array name in struct dir. */ struct path_component { struct ntfs_list_head list; const char *name; }; /* The list of sub-dirs is like a "horizontal" tree. The root of * the tree is opts.path, but it is not part of the list because * that's not necessary. The rules of the list are (in order of * precedence): * 1. directories immediately follow their parent. * 2. siblings are next to one another. * * For example, if: * 1. opts.path is / * 2. / has 2 sub-dirs: dir1 and dir2 * 3. dir1 has 2 sub-dirs: dir11 and dir12 * 4. dir2 has 0 sub-dirs * then the list will be: * dummy head -> dir1 -> dir11 -> dir12 -> dir2 * * dir_list_insert_pos keeps track of where to insert a sub-dir * into the list. */ static struct ntfs_list_head *dir_list_insert_pos = NULL; /* The global depth relative to opts.path. * ie: opts.path has depth 0, a sub-dir of opts.path has depth 1 */ static int depth = 0; static struct options { char *device; /* Device/File to work with */ int quiet; /* Less output */ int verbose; /* Extra output */ int force; /* Override common sense */ int all; int system; int dos; int lng; int inode; int classify; int recursive; const char *path; } opts; typedef struct { ntfs_volume *vol; } ntfsls_dirent; static int list_dir_entry(ntfsls_dirent * dirent, const ntfschar * name, const int name_len, const int name_type, const s64 pos, const MFT_REF mref, const unsigned dt_type); /** * version - Print version information about the program * * Print a copyright statement and a brief description of the program. * * Return: none */ static void version(void) { printf("\n%s v%s (libntfs-3g) - Display information about an NTFS " "Volume.\n\n", EXEC_NAME, VERSION); printf("Copyright (c) 2003 Lode Leroy\n"); printf("Copyright (c) 2003-2005 Anton Altaparmakov\n"); printf("Copyright (c) 2003 Richard Russon\n"); printf("Copyright (c) 2004 Carmelo Kintana\n"); printf("Copyright (c) 2004 Giang Nguyen\n"); printf("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ static void usage(void) { printf("\nUsage: %s [options] device\n" "\n" " -a, --all Display all files\n" " -F, --classify Display classification\n" " -f, --force Use less caution\n" " -h, --help Display this help\n" " -i, --inode Display inode numbers\n" " -l, --long Display long info\n" " -p, --path PATH Directory whose contents to list\n" " -q, --quiet Less output\n" " -R, --recursive Recursively list subdirectories\n" " -s, --system Display system files\n" " -V, --version Display version information\n" " -v, --verbose More output\n" " -x, --dos Use short (DOS 8.3) names\n" "\n", EXEC_NAME); printf("NOTE: If neither -a nor -s is specified, the program defaults to -a.\n\n"); printf("%s%s\n", ntfs_bugs, ntfs_home); } /** * parse_options - Read and validate the programs command line * * Read the command line, verify the syntax and parse the options. * This function is very long, but quite simple. * * Return: 1 Success * 0 Error, one or more problems */ static int parse_options(int argc, char *argv[]) { static const char *sopt = "-aFfh?ilp:qRsVvx"; static const struct option lopt[] = { { "all", no_argument, NULL, 'a' }, { "classify", no_argument, NULL, 'F' }, { "force", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "inode", no_argument, NULL, 'i' }, { "long", no_argument, NULL, 'l' }, { "path", required_argument, NULL, 'p' }, { "recursive", no_argument, NULL, 'R' }, { "quiet", no_argument, NULL, 'q' }, { "system", no_argument, NULL, 's' }, { "version", no_argument, NULL, 'V' }, { "verbose", no_argument, NULL, 'v' }, { "dos", no_argument, NULL, 'x' }, { NULL, 0, NULL, 0 }, }; int c = -1; int err = 0; int ver = 0; int help = 0; int levels = 0; opterr = 0; /* We'll handle the errors, thank you. */ memset(&opts, 0, sizeof(opts)); opts.device = NULL; opts.path = "/"; while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: if (!opts.device) opts.device = optarg; else err++; break; case 'p': opts.path = optarg; break; case 'f': opts.force++; break; case 'h': case '?': if (strncmp (argv[optind-1], "--log-", 6) == 0) { if (!ntfs_log_parse_option (argv[optind-1])) err++; break; } help++; break; case 'q': opts.quiet++; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case 'V': ver++; break; case 'x': opts.dos = 1; break; case 'l': opts.lng++; break; case 'i': opts.inode++; break; case 'F': opts.classify++; break; case 'a': opts.all++; break; case 's': opts.system++; break; case 'R': opts.recursive++; break; default: ntfs_log_error("Unknown option '%s'.\n", argv[optind - 1]); err++; break; } } /* Make sure we're in sync with the log levels */ levels = ntfs_log_get_levels(); if (levels & NTFS_LOG_LEVEL_VERBOSE) opts.verbose++; if (!(levels & NTFS_LOG_LEVEL_QUIET)) opts.quiet++; /* defaults to -a if -s is not specified */ if (!opts.system) opts.all++; if (help || ver) opts.quiet = 0; else { if (opts.device == NULL) { if (argc > 1) ntfs_log_error("You must specify exactly one " "device.\n"); err++; } if (opts.quiet && opts.verbose) { ntfs_log_error("You may not use --quiet and --verbose at the " "same time.\n"); err++; } } if (ver) version(); if (help || err) usage(); return (!err && !help && !ver); } /** * free_dir - free one dir * @tofree: the dir to free * * Close the inode and then free the dir */ static void free_dir(struct dir *tofree) { if (tofree) { if (tofree->ni) { ntfs_inode_close(tofree->ni); tofree->ni = NULL; } free(tofree); } } /** * free_dirs - walk the list of dir's and free each of them * @dir_list: the ntfs_list_head of any entry in the list * * Iterate over @dir_list, calling free_dir on each entry */ static void free_dirs(struct ntfs_list_head *dir_list) { struct dir *tofree = NULL; struct ntfs_list_head *walker = NULL; if (dir_list) { ntfs_list_for_each(walker, dir_list) { free_dir(tofree); tofree = ntfs_list_entry(walker, struct dir, list); } free_dir(tofree); } } /** * readdir_recursive - list a directory and sub-directories encountered * @ni: ntfs inode of the directory to list * @pos: current position in directory * @dirent: context for filldir callback supplied by the caller * * For each directory, print its path relative to opts.path. List a directory, * then list each of its sub-directories. * * Returns 0 on success or -1 on error. * * NOTE: Assumes recursive option. Currently no limit on the depths of * recursion. */ static int readdir_recursive(ntfs_inode * ni, s64 * pos, ntfsls_dirent * dirent) { /* list of dirs to "ls" recursively */ static struct dir dirs = { .list = NTFS_LIST_HEAD_INIT(dirs.list), .ni = NULL, .name = {0}, .depth = 0 }; static struct path_component paths = { .list = NTFS_LIST_HEAD_INIT(paths.list), .name = NULL }; static struct path_component base_comp; struct dir *subdir = NULL; struct dir *tofree = NULL; struct path_component comp; struct path_component *tempcomp = NULL; struct ntfs_list_head *dir_walker = NULL; struct ntfs_list_head *comp_walker = NULL; s64 pos2 = 0; int ni_depth = depth; int result = 0; if (ntfs_list_empty(&dirs.list)) { base_comp.name = opts.path; ntfs_list_add(&base_comp.list, &paths.list); dir_list_insert_pos = &dirs.list; printf("%s:\n", opts.path); } depth++; result = ntfs_readdir(ni, pos, dirent, (ntfs_filldir_t) list_dir_entry); if (result == 0) { ntfs_list_add_tail(&comp.list, &paths.list); /* for each of ni's sub-dirs: list in this iteration, then free at the top of the next iteration or outside of loop */ ntfs_list_for_each(dir_walker, &dirs.list) { if (tofree) { free_dir(tofree); tofree = NULL; } subdir = ntfs_list_entry(dir_walker, struct dir, list); /* subdir is not a subdir of ni */ if (subdir->depth != ni_depth + 1) break; pos2 = 0; dir_list_insert_pos = &dirs.list; if (!subdir->ni) { subdir->ni = ntfs_pathname_to_inode(ni->vol, ni, subdir->name); if (!subdir->ni) { ntfs_log_error ("ntfsls::readdir_recursive(): cannot get inode from pathname.\n"); result = -1; break; } } puts(""); comp.name = subdir->name; /* print relative path header */ ntfs_list_for_each(comp_walker, &paths.list) { tempcomp = ntfs_list_entry(comp_walker, struct path_component, list); printf("%s", tempcomp->name); if (tempcomp != &comp && *tempcomp->name != PATH_SEP && (!opts.classify || tempcomp == &base_comp)) putchar(PATH_SEP); } puts(":"); result = readdir_recursive(subdir->ni, &pos2, dirent); if (result) break; tofree = subdir; ntfs_list_del(dir_walker); } ntfs_list_del(&comp.list); } if (tofree) free_dir(tofree); /* if at the outer-most readdir_recursive, then clean up */ if (ni_depth == 0) { free_dirs(&dirs.list); } depth--; return result; } /** * list_dir_entry * * FIXME: Should we print errors as we go along? (AIA) */ static int list_dir_entry(ntfsls_dirent * dirent, const ntfschar * name, const int name_len, const int name_type, const s64 pos __attribute__((unused)), const MFT_REF mref, const unsigned dt_type) { char *filename = NULL; int result = 0; struct dir *dir = NULL; filename = calloc(1, MAX_PATH); if (!filename) return -1; if (ntfs_ucstombs(name, name_len, &filename, MAX_PATH) < 0) { ntfs_log_error("Cannot represent filename in current locale.\n"); goto free; } result = 0; // These are successful if ((MREF(mref) < FILE_first_user) && (!opts.system)) goto free; if (name_type == FILE_NAME_POSIX && !opts.all) goto free; if (((name_type & FILE_NAME_WIN32_AND_DOS) == FILE_NAME_WIN32) && opts.dos) goto free; if (((name_type & FILE_NAME_WIN32_AND_DOS) == FILE_NAME_DOS) && !opts.dos) goto free; if (dt_type == NTFS_DT_DIR && opts.classify) sprintf(filename + strlen(filename), "/"); if (dt_type == NTFS_DT_DIR && opts.recursive && strcmp(filename, ".") && strcmp(filename, "./") && strcmp(filename, "..") && strcmp(filename, "../")) { dir = (struct dir *)calloc(1, sizeof(struct dir)); if (!dir) { ntfs_log_error("Failed to allocate for subdir.\n"); result = -1; goto free; } strcpy(dir->name, filename); dir->ni = NULL; dir->depth = depth; } if (!opts.lng) { if (!opts.inode) printf("%s\n", filename); else printf("%7llu %s\n", (unsigned long long)MREF(mref), filename); result = 0; } else { s64 filesize = 0; ntfs_inode *ni; ntfs_attr_search_ctx *ctx = NULL; FILE_NAME_ATTR *file_name_attr; ATTR_RECORD *attr; struct timespec change_time; char t_buf[26]; result = -1; // Everything else is bad ni = ntfs_inode_open(dirent->vol, mref); if (!ni) goto release; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) goto release; if (ntfs_attr_lookup(AT_FILE_NAME, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) goto release; attr = ctx->attr; file_name_attr = (FILE_NAME_ATTR *)((char *)attr + le16_to_cpu(attr->value_offset)); if (!file_name_attr) goto release; change_time = ntfs2timespec(file_name_attr->last_data_change_time); strcpy(t_buf, ctime(&change_time.tv_sec)); memmove(t_buf+16, t_buf+19, 5); t_buf[21] = '\0'; if (dt_type != NTFS_DT_DIR) { if (!ntfs_attr_lookup(AT_DATA, AT_UNNAMED, 0, 0, 0, NULL, 0, ctx)) filesize = ntfs_get_attribute_value_length( ctx->attr); } if (opts.inode) printf("%7llu %8lld %s %s\n", (unsigned long long)MREF(mref), (long long)filesize, t_buf + 4, filename); else printf("%8lld %s %s\n", (long long)filesize, t_buf + 4, filename); if (dir) { dir->ni = ni; ni = NULL; /* so release does not close inode */ } result = 0; release: /* Release attribute search context and close the inode. */ if (ctx) ntfs_attr_put_search_ctx(ctx); if (ni) ntfs_inode_close(ni); } if (dir) { if (result == 0) { ntfs_list_add(&dir->list, dir_list_insert_pos); dir_list_insert_pos = &dir->list; } else { free(dir); dir = NULL; } } free: free(filename); return result; } /** * main - Begin here * * Start from here. * * Return: 0 Success, the program worked * 1 Error, parsing mount options failed * 2 Error, mount attempt failed * 3 Error, failed to open root directory * 4 Error, failed to open directory in search path */ int main(int argc, char **argv) { s64 pos; ntfs_volume *vol; ntfs_inode *ni; ntfsls_dirent dirent; ntfs_log_set_handler(ntfs_log_handler_outerr); if (!parse_options(argc, argv)) { // FIXME: Print error... (AIA) return 1; } utils_set_locale(); vol = utils_mount_volume(opts.device, NTFS_MNT_RDONLY | (opts.force ? NTFS_MNT_RECOVER : 0)); if (!vol) { // FIXME: Print error... (AIA) return 2; } ni = ntfs_pathname_to_inode(vol, NULL, opts.path); if (!ni) { // FIXME: Print error... (AIA) ntfs_umount(vol, FALSE); return 3; } /* * We now are at the final path component. If it is a file just * list it. If it is a directory, list its contents. */ pos = 0; memset(&dirent, 0, sizeof(dirent)); dirent.vol = vol; if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) { if (opts.recursive) readdir_recursive(ni, &pos, &dirent); else ntfs_readdir(ni, &pos, &dirent, (ntfs_filldir_t) list_dir_entry); // FIXME: error checking... (AIA) } else { ATTR_RECORD *rec; FILE_NAME_ATTR *attr; ntfs_attr_search_ctx *ctx; int space = 4; ntfschar *name = NULL; int name_len = 0;; ctx = ntfs_attr_get_search_ctx(ni, NULL); if (!ctx) return -1; while ((rec = find_attribute(AT_FILE_NAME, ctx))) { /* We know this will always be resident. */ attr = (FILE_NAME_ATTR *) ((char *) rec + le16_to_cpu(rec->value_offset)); if (attr->file_name_type < space) { name = attr->file_name; name_len = attr->file_name_length; space = attr->file_name_type; } } list_dir_entry(&dirent, name, name_len, space, pos, ni->mft_no, NTFS_DT_REG); // FIXME: error checking... (AIA) ntfs_attr_put_search_ctx(ctx); } /* Finished with the inode; release it. */ ntfs_inode_close(ni); ntfs_umount(vol, FALSE); return 0; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsmftalloc.c000066400000000000000000000235531507404161300222560ustar00rootroot00000000000000/** * ntfsmftalloc - Part of the Linux-NTFS project. * * Copyright (c) 2002-2005 Anton Altaparmakov * * This utility will allocate and initialize an mft record. * * 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 (in the main directory of the Linux-NTFS source * in the file COPYING); if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_UNISTD_H # include #endif #ifdef HAVE_STDLIB_H # include #endif #ifdef HAVE_STDIO_H # include #endif #ifdef HAVE_STDARG_H # include #endif #ifdef HAVE_STRING_H # include #endif #ifdef HAVE_ERRNO_H # include #endif #ifdef HAVE_TIME_H #include #endif #ifdef HAVE_GETOPT_H # include #else extern int optind; #endif #ifdef HAVE_LIMITS_H #include #endif #ifndef LLONG_MAX # define LLONG_MAX 9223372036854775807LL #endif #include "types.h" #include "attrib.h" #include "inode.h" #include "layout.h" #include "volume.h" #include "mft.h" #include "utils.h" /* #include "version.h" */ #include "logging.h" static const char *EXEC_NAME = "ntfsmftalloc"; /* Need these global so ntfsmftalloc_exit can access them. */ static BOOL success = FALSE; static char *dev_name; static ntfs_volume *vol; static ntfs_inode *ni = NULL; static ntfs_inode *base_ni = NULL; static s64 base_mft_no = -1; static struct { /* -h, print usage and exit. */ int no_action; /* -n, do not write to device, only display what would be done. */ int quiet; /* -q, quiet execution. */ int verbose; /* -v, verbose execution, given twice, really verbose execution (debug mode). */ int force; /* -f, force allocation. */ /* -V, print version and exit. */ } opts; /** * err_exit - error output and terminate; ignores quiet (-q) */ __attribute__((noreturn)) __attribute__((format(printf, 1, 2))) static void err_exit(const char *fmt, ...) { va_list ap; fprintf(stderr, "ERROR: "); va_start(ap, fmt); vfprintf(stderr, fmt, ap); va_end(ap); fprintf(stderr, "Aborting...\n"); exit(1); } /** * copyright - print copyright statements */ static void copyright(void) { ntfs_log_info("Copyright (c) 2004-2005 Anton Altaparmakov\n" "Allocate and initialize a base or an extent mft " "record. If a base mft record\nis not specified, a " "base mft record is allocated and initialized. " "Otherwise,\nan extent mft record is allocated and " "initialized to point to the specified\nbase mft " "record.\n"); } /** * license - print license statement */ static void license(void) { ntfs_log_info("%s", ntfs_gpl); } /** * usage - print a list of the parameters to the program */ __attribute__((noreturn)) static void usage(void) { copyright(); ntfs_log_info("Usage: %s [options] device [base-mft-record]\n" " -n Do not write to disk\n" " -f Force execution despite errors\n" " -q Quiet execution\n" " -v Verbose execution\n" " -vv Very verbose execution\n" " -V Display version information\n" " -l Display licensing information\n" " -h Display this help\n", EXEC_NAME); ntfs_log_info("%s%s", ntfs_bugs, ntfs_home); exit(1); } /** * parse_options */ static void parse_options(int argc, char *argv[]) { long long ll; char *s; int c; if (argc && *argv) EXEC_NAME = *argv; ntfs_log_info("%s v%s (libntfs-3g)\n", EXEC_NAME, VERSION); while ((c = getopt(argc, argv, "fh?nqvVl")) != EOF) { switch (c) { case 'f': opts.force = 1; break; case 'n': opts.no_action = 1; break; case 'q': opts.quiet = 1; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; case 'V': /* Version number already printed, so just exit. */ exit(0); case 'l': copyright(); license(); exit(0); case 'h': case '?': default: usage(); } } if (opts.verbose > 1) ntfs_log_set_levels(NTFS_LOG_LEVEL_DEBUG | NTFS_LOG_LEVEL_TRACE | NTFS_LOG_LEVEL_VERBOSE | NTFS_LOG_LEVEL_QUIET); if (optind == argc) usage(); /* Get the device. */ dev_name = argv[optind++]; ntfs_log_verbose("device name = %s\n", dev_name); if (optind != argc) { /* Get the base mft record number. */ ll = strtoll(argv[optind++], &s, 0); if (*s || !ll || (ll >= LLONG_MAX && errno == ERANGE)) err_exit("Invalid base mft record number: %s\n", argv[optind - 1]); base_mft_no = ll; ntfs_log_verbose("base mft record number = 0x%llx\n", (long long)ll); } if (optind != argc) usage(); } /** * dump_mft_record */ static void dump_mft_record(MFT_RECORD *m) { ATTR_RECORD *a; unsigned int u; MFT_REF r; ntfs_log_info("-- Beginning dump of mft record. --\n"); u = le32_to_cpu(m->magic); ntfs_log_info("Mft record signature (magic) = %c%c%c%c\n", u & 0xff, u >> 8 & 0xff, u >> 16 & 0xff, u >> 24 & 0xff); u = le16_to_cpu(m->usa_ofs); ntfs_log_info("Update sequence array offset = %u (0x%x)\n", u, u); ntfs_log_info("Update sequence array size = %u\n", le16_to_cpu(m->usa_count)); ntfs_log_info("$LogFile sequence number (lsn) = %llu\n", (unsigned long long)sle64_to_cpu(m->lsn)); ntfs_log_info("Sequence number = %u\n", le16_to_cpu(m->sequence_number)); ntfs_log_info("Reference (hard link) count = %u\n", le16_to_cpu(m->link_count)); u = le16_to_cpu(m->attrs_offset); ntfs_log_info("First attribute offset = %u (0x%x)\n", u, u); ntfs_log_info("Flags = %u: ", le16_to_cpu(m->flags)); if (m->flags & MFT_RECORD_IN_USE) ntfs_log_info("MFT_RECORD_IN_USE"); else ntfs_log_info("MFT_RECORD_NOT_IN_USE"); if (m->flags & MFT_RECORD_IS_DIRECTORY) ntfs_log_info(" | MFT_RECORD_IS_DIRECTORY"); ntfs_log_info("\n"); u = le32_to_cpu(m->bytes_in_use); ntfs_log_info("Bytes in use = %u (0x%x)\n", u, u); u = le32_to_cpu(m->bytes_allocated); ntfs_log_info("Bytes allocated = %u (0x%x)\n", u, u); r = le64_to_cpu(m->base_mft_record); ntfs_log_info("Base mft record reference:\n\tMft record number = %llu\n\t" "Sequence number = %u\n", (unsigned long long)MREF(r), MSEQNO(r)); ntfs_log_info("Next attribute instance = %u\n", le16_to_cpu(m->next_attr_instance)); a = (ATTR_RECORD*)((char*)m + le16_to_cpu(m->attrs_offset)); ntfs_log_info("-- Beginning dump of attributes within mft record. --\n"); while ((char*)a < (char*)m + le32_to_cpu(m->bytes_in_use)) { if (a->type == AT_END) break; a = (ATTR_RECORD*)((char*)a + le32_to_cpu(a->length)); }; ntfs_log_info("-- End of attributes. --\n"); } /** * ntfsmftalloc_exit */ static void ntfsmftalloc_exit(void) { if (success) return; /* If there is a base inode, close that instead of the extent inode. */ if (base_ni) ni = base_ni; /* Close the inode. */ if (ni && ntfs_inode_close(ni)) { ntfs_log_perror("Warning: Failed to close inode 0x%llx", (long long)ni->mft_no); } /* Unmount the volume. */ if (ntfs_umount(vol, 0) == -1) ntfs_log_perror("Warning: Could not umount %s", dev_name); } /** * main */ int main(int argc, char **argv) { unsigned long mnt_flags, ul; int err; ntfs_log_set_handler(ntfs_log_handler_outerr); /* Initialize opts to zero / required values. */ memset(&opts, 0, sizeof(opts)); /* Parse command line options. */ parse_options(argc, argv); utils_set_locale(); /* Make sure the file system is not mounted. */ if (ntfs_check_if_mounted(dev_name, &mnt_flags)) ntfs_log_error("Failed to determine whether %s is mounted: %s\n", dev_name, strerror(errno)); else if (mnt_flags & NTFS_MF_MOUNTED) { ntfs_log_error("%s is mounted.\n", dev_name); if (!opts.force) err_exit("Refusing to run!\n"); ntfs_log_error("ntfsmftalloc forced anyway. Hope /etc/mtab " "is incorrect.\n"); } /* Mount the device. */ if (opts.no_action) { ntfs_log_quiet("Running in READ-ONLY mode!\n"); ul = NTFS_MNT_RDONLY; } else ul = 0; vol = ntfs_mount(dev_name, ul); if (!vol) err_exit("Failed to mount %s: %s\n", dev_name, strerror(errno)); /* Register our exit function which will unlock and close the device. */ err = atexit(&ntfsmftalloc_exit); if (err == -1) { ntfs_log_error("Could not set up exit() function because atexit() " "failed: %s Aborting...\n", strerror(errno)); ntfsmftalloc_exit(); exit(1); } if (base_mft_no != -1) { base_ni = ntfs_inode_open(vol, base_mft_no); if (!base_ni) err_exit("Failed to open base inode 0x%llx: %s\n", (long long)base_mft_no, strerror(errno)); } /* Open the specified inode. */ ni = ntfs_mft_record_alloc(vol, base_ni); if (!ni) err_exit("Failed to allocate mft record: %s\n", strerror(errno)); ntfs_log_info("Allocated %s mft record 0x%llx", base_ni ? "extent" : "base", (long long)ni->mft_no); if (base_ni) ntfs_log_info(" with base mft record 0x%llx", (long long)base_mft_no); ntfs_log_info(".\n"); if (!opts.quiet && opts.verbose > 1) { ntfs_log_verbose("Dumping allocated mft record 0x%llx:\n", (long long)ni->mft_no); dump_mft_record(ni->mrec); } /* Close the (base) inode. */ if (base_ni) ni = base_ni; err = ntfs_inode_close(ni); if (err) err_exit("Failed to close inode 0x%llx: %s\n", (long long)ni->mft_no, strerror(errno)); /* Unmount the volume. */ err = ntfs_umount(vol, 0); /* Disable our ntfsmftalloc_exit() handler. */ success = TRUE; if (err == -1) ntfs_log_perror("Warning: Failed to umount %s", dev_name); else ntfs_log_quiet("ntfsmftalloc completed successfully.\n"); return 0; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsmove.c000066400000000000000000000500331507404161300214140ustar00rootroot00000000000000/** * ntfsmove - Part of the Linux-NTFS project. * * Copyright (c) 2003 Richard Russon * Copyright (c) 2003-2005 Anton Altaparmakov * * This utility will move files on an NTFS volume. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_LIMITS_H #include #endif #include "types.h" #include "attrib.h" #include "utils.h" #include "volume.h" #include "debug.h" #include "dir.h" #include "bitmap.h" #include "ntfsmove.h" /* #include "version.h" */ #include "logging.h" static const char *EXEC_NAME = "ntfsmove"; static struct options opts; /** * version - Print version information about the program * * Print a copyright statement and a brief description of the program. * * Return: none */ static void version(void) { ntfs_log_info("\n%s v%s (libntfs-3g) - Move files and directories on an " "NTFS volume.\n\n", EXEC_NAME, VERSION); ntfs_log_info("Copyright (c) 2003 Richard Russon\n"); ntfs_log_info("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } /** * usage - Print a list of the parameters to the program * * Print a list of the parameters and options for the program. * * Return: none */ static void usage(void) { ntfs_log_info("\nUsage: %s [options] device file\n" "\n" " -S --start Move to the start of the volume\n" " -B --best Move to the best place on the volume\n" " -E --end Move to the end of the volume\n" " -C num --cluster num Move to this cluster offset\n" "\n" " -D --no-dirty Do not mark volume dirty (require chkdsk)\n" " -n --no-action Do not write to disk\n" " -f --force Use less caution\n" " -h --help Print this help\n" " -q --quiet Less output\n" " -V --version Version information\n" " -v --verbose More output\n\n", EXEC_NAME); ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home); } /** * parse_options - Read and validate the programs command line * * Read the command line, verify the syntax and parse the options. * This function is very long, but quite simple. * * Return: 1 Success * 0 Error, one or more problems */ static int parse_options(int argc, char **argv) { static const char *sopt = "-BC:DEfh?nqSVv"; static const struct option lopt[] = { { "best", no_argument, NULL, 'B' }, { "cluster", required_argument, NULL, 'C' }, { "end", no_argument, NULL, 'E' }, { "force", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "no-action", no_argument, NULL, 'n' }, { "no-dirty", no_argument, NULL, 'D' }, { "quiet", no_argument, NULL, 'q' }, { "start", no_argument, NULL, 'S' }, { "verbose", no_argument, NULL, 'v' }, { "version", no_argument, NULL, 'V' }, { NULL, 0, NULL, 0 } }; int c = -1; int err = 0; int ver = 0; int help = 0; int levels = 0; char *end = NULL; opterr = 0; /* We'll handle the errors, thank you. */ while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (!opts.device) { opts.device = argv[optind-1]; } else if (!opts.file) { opts.file = argv[optind-1]; } else { opts.device = NULL; opts.file = NULL; err++; } break; case 'B': if (opts.location == 0) opts.location = NTFS_MOVE_LOC_BEST; else opts.location = -1; break; case 'C': if (opts.location == 0) { opts.location = strtoll(optarg, &end, 0); if (end && *end) err++; } else { opts.location = -1; } break; case 'D': opts.nodirty++; break; case 'E': if (opts.location == 0) opts.location = NTFS_MOVE_LOC_END; else opts.location = -1; break; case 'f': opts.force++; break; case 'h': case '?': if (strncmp (argv[optind-1], "--log-", 6) == 0) { if (!ntfs_log_parse_option (argv[optind-1])) err++; break; } help++; break; case 'n': opts.noaction++; break; case 'q': opts.quiet++; ntfs_log_clear_levels(NTFS_LOG_LEVEL_QUIET); break; case 'S': if (opts.location == 0) opts.location = NTFS_MOVE_LOC_START; else opts.location = -1; break; case 'V': ver++; break; case 'v': opts.verbose++; ntfs_log_set_levels(NTFS_LOG_LEVEL_VERBOSE); break; default: ntfs_log_error("Unknown option '%s'.\n", argv[optind-1]); err++; break; } } /* Make sure we're in sync with the log levels */ levels = ntfs_log_get_levels(); if (levels & NTFS_LOG_LEVEL_VERBOSE) opts.verbose++; if (!(levels & NTFS_LOG_LEVEL_QUIET)) opts.quiet++; if (help || ver) { opts.quiet = 0; } else { if ((opts.device == NULL) || (opts.file == NULL)) { if (argc > 1) ntfs_log_error("You must specify one device and one file.\n"); err++; } if (opts.quiet && opts.verbose) { ntfs_log_error("You may not use --quiet and --verbose at the " "same time.\n"); err++; } if (opts.location == -1) { ntfs_log_error("You may only specify one location option: " "--start, --best, --end or --cluster\n"); err++; } else if (opts.location == 0) { opts.location = NTFS_MOVE_LOC_BEST; } } if (ver) version(); if (help || err) usage(); return (!err && !help && !ver); } #if 0 /** * ntfs_debug_runlist_dump2 - Dump a runlist. */ static int ntfs_debug_runlist_dump2(const runlist *rl, int abbr, char *prefix) { //int abbr = 3; /* abbreviate long lists */ int len = 0; int i; int res = 0; u64 total = 0; const char *lcn_str[5] = { "HOLE", "NOTMAP", "ENOENT", "EINVAL", "XXXX" }; if (!rl) { ntfs_log_info(" Run list not present.\n"); return 0; } if (!prefix) prefix = ""; if (abbr) for (len = 0; rl[len].length; len++) ; ntfs_log_info("%s VCN LCN len\n", prefix); for (i = 0; rl->length; i++, rl++) { LCN lcn = rl->lcn; total += rl->length; if (abbr) if (len > 20) { if ((i == abbr) && (len > (abbr*2))) ntfs_log_info("%s ... ... ...\n", prefix); if ((i > (abbr-1)) && (i < (len - (abbr-1)))) continue; } if (rl->vcn < -1) res = -1; if (lcn < (LCN)0) { int j = -lcn - 1; if ((j < 0) || (j > 4)) { j = 4; res = -1; } ntfs_log_info("%s%8lld %8s %8lld\n", prefix, rl->vcn, lcn_str[j], rl->length); } else ntfs_log_info("%s%8lld %8lld %8lld\n", prefix, rl->vcn, rl->lcn, rl->length); } ntfs_log_info("%s --------\n", prefix); ntfs_log_info("%s %8lld\n", prefix, total); ntfs_log_info("\n"); return res; } #endif /* if 0 */ /** * resize_nonres_attr */ static int resize_nonres_attr(MFT_RECORD *m, ATTR_RECORD *a, const u32 new_size) { int this_attr; int next_attr; int tail_size; int file_size; int old_size; u8 *ptr; old_size = le32_to_cpu(a->length); file_size = le32_to_cpu(m->bytes_in_use); this_attr = p2n(a)-p2n(m); next_attr = this_attr + le32_to_cpu(a->length); tail_size = file_size - next_attr; ptr = (u8*) m; /* ntfs_log_info("old_size = %d\n", old_size); ntfs_log_info("new_size = %d\n", new_size); ntfs_log_info("file_size = %d\n", file_size); ntfs_log_info("this_attr = %d\n", this_attr); ntfs_log_info("next_attr = %d\n", next_attr); ntfs_log_info("tail_size = %d\n", tail_size); */ memmove(ptr + this_attr + new_size, ptr + next_attr, tail_size); a->length = cpu_to_le32(new_size); m->bytes_in_use = cpu_to_le32(le32_to_cpu(m->bytes_in_use) + (new_size - old_size)); return 0; } /** * calc_attr_length */ static int calc_attr_length(ATTR_RECORD *rec, int runlength) { int size; if (!rec) return -1; if (!rec->non_resident) return -1; size = le16_to_cpu(rec->mapping_pairs_offset) + runlength + 7; size &= 0xFFF8; return size; } #if 0 /** * dump_runs */ static void dump_runs(u8 *buffer, int len) { int i; ntfs_log_info("RUN: \e[01;31m"); for (i = 0; i < len; i++) { ntfs_log_info(" %02x", buffer[i]); } ntfs_log_info("\e[0m\n"); } #endif /* if 0 */ /** * find_unused */ static runlist * find_unused(ntfs_volume *vol, s64 size, u64 loc __attribute__((unused)), int flags __attribute__((unused))) { const int bufsize = 8192; u8 *buffer; int clus; int i; int curr = 0; int count = 0; s64 start = 0; int bit = 0; runlist *res = NULL; //ntfs_log_info("find_unused\n"); buffer = malloc(bufsize); if (!buffer) { ntfs_log_info("!buffer\n"); return NULL; } //ntfs_log_info("looking for space for %lld clusters\n", size); clus = vol->lcnbmp_na->allocated_size / bufsize; //ntfs_log_info("clus = %d\n", clus); for (i = 0; i < clus; i++) { int bytes_read, j; bytes_read = ntfs_attr_pread(vol->lcnbmp_na, i*bufsize, bufsize, buffer); if (bytes_read != bufsize) { ntfs_log_info("!read\n"); return NULL; } for (j = 0; j < bufsize*8; j++) { bit = !!test_bit(j & 7, buffer[j>>3]); if (curr == bit) { count++; if ((!bit) && (count >= size)) { //res = calloc(2, sizeof(*res)); res = calloc(1, 4096); if (res) { res[0].vcn = 0; res[0].lcn = start; res[0].length = size; res[1].lcn = LCN_ENOENT; } goto done; } } else { //ntfs_log_info("%d * %d\n", curr, count); curr = bit; count = 1; start = i*bufsize*8 + j; } } } done: //ntfs_log_info("%d * %d\n", curr, count); free(buffer); if (res) { for (i = 0; i < size; i++) { if (utils_cluster_in_use(vol, res->lcn + i)) { ntfs_log_info("ERROR cluster %lld in use\n", (long long)res->lcn + i); } } } else { ntfs_log_info("failed\n"); } return res; } /** * dont_move * * Don't let the user move: * ANY metadata * Any fragmented MFT records * The boot file 'ntldr' */ static int dont_move(ntfs_inode *ino) { static const ntfschar ntldr[6] = { const_cpu_to_le16('n'), const_cpu_to_le16('t'), const_cpu_to_le16('l'), const_cpu_to_le16('d'), const_cpu_to_le16('r'), const_cpu_to_le16('\0') }; ATTR_RECORD *rec; FILE_NAME_ATTR *name; if (utils_is_metadata(ino) == 1) { ntfs_log_error("metadata\n"); return 1; } rec = find_first_attribute(AT_ATTRIBUTE_LIST, ino->mrec); if (rec) { ntfs_log_error("attribute list\n"); return 1; } rec = find_first_attribute(AT_FILE_NAME, ino->mrec); if (!rec) { ntfs_log_error("extend inode\n"); return 1; } name = (FILE_NAME_ATTR*) ((u8*)rec + le16_to_cpu(rec->value_offset)); if (ntfs_names_are_equal(ntldr, 5, name->file_name, name->file_name_length, IGNORE_CASE, ino->vol->upcase, ino->vol->upcase_len)) { ntfs_log_error("ntldr\n"); return 1; } return 0; } /** * bitmap_alloc */ static int bitmap_alloc(ntfs_volume *vol, runlist_element *rl) { int res; if (!rl) return -1; res = ntfs_bitmap_set_run(vol->lcnbmp_na, rl->lcn, rl->length); if (res < 0) { ntfs_log_error("bitmap alloc returns %d\n", res); } return res; } /** * bitmap_free */ static int bitmap_free(ntfs_volume *vol, runlist_element *rl) { int res; if (!rl) return -1; res = ntfs_bitmap_clear_run(vol->lcnbmp_na, rl->lcn, rl->length); if (res < 0) { ntfs_log_error("bitmap free returns %d\n", res); } return res; } /** * data_copy */ static int data_copy(ntfs_volume *vol, runlist_element *from, runlist_element *to) { int i; u8 *buffer; s64 res = 0; if (!vol || !from || !to) return -1; if ((from->length != to->length) || (from->lcn < 0) || (to->lcn < 0)) return -1; //ntfs_log_info("data_copy: from 0x%llx to 0x%llx\n", from->lcn, to->lcn); buffer = malloc(vol->cluster_size); if (!buffer) { ntfs_log_info("!buffer\n"); return -1; } for (i = 0; i < from->length; i++) { //ntfs_log_info("read cluster at %8lld\n", from->lcn+i); res = ntfs_pread(vol->dev, (from->lcn+i) * vol->cluster_size, vol->cluster_size, buffer); if (res != vol->cluster_size) { ntfs_log_error("!read\n"); res = -1; break; } //ntfs_log_info("write cluster to %8lld\n", to->lcn+i); res = ntfs_pwrite(vol->dev, (to->lcn+i) * vol->cluster_size, vol->cluster_size, buffer); if (res != vol->cluster_size) { ntfs_log_error("!write %lld\n", (long long)res); res = -1; break; } } free(buffer); return res; } /** * move_runlist * * validate: * runlists are the same size * from in use * to not in use * allocate new space * copy data * deallocate old space */ static s64 move_runlist(ntfs_volume *vol, runlist_element *from, runlist_element *to) { int i; if (!vol || !from || !to) return -1; if (from->length != to->length) { ntfs_log_error("diffsizes\n"); return -1; } if ((from->lcn < 0) || (to->lcn < 0)) { ntfs_log_error("invalid runs\n"); return -1; } for (i = 0; i < from->length; i++) { if (!utils_cluster_in_use(vol, from->lcn+i)) { ntfs_log_error("from not in use\n"); return -1; } } for (i = 0; i < to->length; i++) { if (utils_cluster_in_use(vol, to->lcn+i)) { ntfs_log_error("to is in use\n"); return -1; } } if (bitmap_alloc(vol, to) < 0) { ntfs_log_error("cannot bitmap_alloc\n"); return -1; } if (data_copy(vol, from, to) < 0) { ntfs_log_error("cannot data_copy\n"); return -1; } if (bitmap_free(vol, from) < 0) { ntfs_log_error("cannot bitmap_free\n"); return -1; } return 0; } /**original * move_datarun * > 0 Bytes moved / size to be moved * = 0 Nothing to do * < 0 Error */ // get size of runlist // find somewhere to put data // backup original runlist // move the data // got to get the runlist out of this function // requires a mrec arg, not an ino (ino->mrec will do for now) // check size of new runlist before allocating / moving // replace one datarun with another (by hand) static s64 move_datarun(ntfs_volume *vol, ntfs_inode *ino, ATTR_RECORD *rec, runlist_element *run, u64 loc, int flags) { runlist *from; runlist *to; int need_from; int need_to; int i; s64 res = -1; // find empty space to = find_unused(vol, run->length, loc, flags); if (!to) { ntfs_log_error("!to\n"); return -1; } to->vcn = run->vcn; // copy original runlist from = ntfs_mapping_pairs_decompress(vol, rec, NULL); if (!from) { ntfs_log_info("!from\n"); return -1; } ntfs_log_info("move %lld,%lld,%lld to %lld,%lld,%lld\n", (long long)run->vcn, (long long)run->lcn, (long long)run->length, (long long)to->vcn, (long long)to->lcn, (long long)to->length); need_from = ntfs_get_size_for_mapping_pairs(vol, from, 0, INT_MAX); ntfs_log_info("orig data run = %d bytes\n", need_from); //ntfs_debug_runlist_dump2(from, 5, "\t"); for (i = 0; to[i].length > 0; i++) { if (from[i].vcn == run->vcn) { from[i].lcn = to->lcn; break; } } //ntfs_debug_runlist_dump2(from, 5, "\t"); need_to = ntfs_get_size_for_mapping_pairs(vol, from, 0, INT_MAX); ntfs_log_info("new data run = %d bytes\n", need_to); need_from = calc_attr_length(rec, need_from); need_to = calc_attr_length(rec, need_to); ntfs_log_info("Before %d, after %d\n", need_from, need_to); if (need_from != need_to) { if (resize_nonres_attr(ino->mrec, rec, need_to) < 0) { ntfs_log_info("!resize\n"); return -1; } } res = move_runlist(vol, run, to); if (res < 0) { ntfs_log_error("!move_runlist\n"); return -1; } // wipe orig runs memset(((u8*)rec) + le16_to_cpu(rec->mapping_pairs_offset), 0, need_to - le16_to_cpu(rec->mapping_pairs_offset)); // update data runs ntfs_mapping_pairs_build(vol, ((u8*)rec) + le16_to_cpu(rec->mapping_pairs_offset), need_to, from, 0, NULL); // commit ntfs_inode_mark_dirty(ino); if (ntfs_inode_sync(ino) < 0) { ntfs_log_info("!sync\n"); return -1; } free(from); free(to); return res; } /** * move_attribute - * * > 0 Bytes moved / size to be moved * = 0 Nothing to do * < 0 Error */ static s64 move_attribute(ntfs_volume *vol, ntfs_inode *ino, ATTR_RECORD *rec, u64 loc, int flags) { int i; s64 res; s64 count = 0; runlist *runs; // NTFS_MOVE_LOC_BEST : assess how much space this attribute will need, // find that space and pass the location to our children. // Anything else we pass directly to move_datarun. runs = ntfs_mapping_pairs_decompress(vol, rec, NULL); if (!runs) { ntfs_log_error("!runs\n"); return -1; } //ntfs_debug_runlist_dump2(runs, 5, "\t"); //ntfs_log_info(" VCN LCN Length\n"); for (i = 0; runs[i].length > 0; i++) { if (runs[i].lcn == LCN_RL_NOT_MAPPED) { continue; } res = move_datarun(vol, ino, rec, runs+i, loc, flags); //ntfs_log_info(" %8lld %8lld %8lld\n", runs[i].vcn, runs[i].lcn, runs[i].length); if (res < 0) { ntfs_log_error("!move_datarun\n"); count = res; break; } count += res; } return count; } /** * move_file - * * > 0 Bytes moved / size to be moved * = 0 Nothing to do * < 0 Error */ static s64 move_file(ntfs_volume *vol, ntfs_inode *ino, u64 loc, int flags) { char *buffer; ntfs_attr_search_ctx *ctx; ATTR_RECORD *rec; s64 res; s64 count = 0; buffer = malloc(MAX_PATH); if (!buffer) { ntfs_log_error("Out of memory\n"); return -1; } utils_inode_get_name(ino, buffer, MAX_PATH); if (dont_move(ino)) { ntfs_log_error("can't move\n"); return -1; } ntfs_log_info("Moving %s\n", buffer); // NTFS_MOVE_LOC_BEST : assess how much space all the attributes will need, // find that space and pass the location to our children. // Anything else we pass directly to move_attribute. ctx = ntfs_attr_get_search_ctx(ino, NULL); while ((rec = find_attribute(AT_UNUSED, ctx))) { utils_attr_get_name(vol, rec, buffer, MAX_PATH); ntfs_log_info("\tAttribute 0x%02x %s is ", le32_to_cpu(rec->type), buffer); if (rec->non_resident) { ntfs_log_info("non-resident. Moving it.\n"); res = move_attribute(vol, ino, rec, loc, flags); if (res < 0) { count = res; break; } count += res; } else { ntfs_log_info("resident.\n\t\tSkipping it.\n"); } } ntfs_attr_put_search_ctx(ctx); free(buffer); return count; } /** * main - Begin here * * Start from here. * * Return: 0 Success, the program worked * 1 Error, something went wrong */ int main(int argc, char *argv[]) { ntfs_volume *vol; ntfs_inode *inode; int flags = 0; int result = 1; s64 count; ntfs_log_set_handler(ntfs_log_handler_outerr); if (!parse_options(argc, argv)) return 1; utils_set_locale(); if (opts.noaction) flags |= NTFS_MNT_RDONLY; if (opts.force) flags |= NTFS_MNT_RECOVER; vol = utils_mount_volume(opts.device, flags); if (!vol) { ntfs_log_info("!vol\n"); return 1; } inode = ntfs_pathname_to_inode(vol, NULL, opts.file); if (!inode) { ntfs_log_info("!inode\n"); return 1; } count = move_file(vol, inode, opts.location, 0); if ((count > 0) && (!opts.nodirty)) { /* Porting note: libntfs-3g does not automatically set or clear * dirty flags on mount/unmount. It always preserves them until * they are explicitly changed with ntfs_volume_write_flags. * This means that the dirty flag is possibly not set, but * should be set. So we explicitly set it with a call to * ntfs_volume_write_flags. */ if(!(vol->flags & VOLUME_IS_DIRTY) && ntfs_volume_write_flags( vol, vol->flags | VOLUME_IS_DIRTY)) { ntfs_log_error("Error: Failed to set volume dirty " "flag (%d (%s))!\n", errno, strerror(errno)); } ntfs_log_info("Relocated %lld bytes\n", (long long)count); } if (count >= 0) result = 0; if (result) ntfs_log_info("failed\n"); else ntfs_log_info("success\n"); ntfs_inode_close(inode); ntfs_umount(vol, FALSE); return result; } ntfsprogs-plus-1.0.0/src/deprecated/ntfsmove.h000066400000000000000000000031211507404161300214150ustar00rootroot00000000000000/* * ntfsmove - Part of the Linux-NTFS project. * * Copyright (c) 2003 Richard Russon * * This utility will move files on an NTFS volume. * * 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 (in the main directory of the Linux-NTFS * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _NTFSMOVE_H_ #define _NTFSMOVE_H_ #include "types.h" /* Move files to */ #define NTFS_MOVE_LOC_START -1000 /* the first available space */ #define NTFS_MOVE_LOC_BEST -1001 /* place big enough for entire file */ #define NTFS_MOVE_LOC_END -1002 /* the last available space */ struct options { char *device; /* Device/File to work with */ char *file; /* File to display */ s64 location; /* Where to place the file */ int force; /* Override common sense */ int quiet; /* Less output */ int verbose; /* Extra output */ int noaction; /* Do not write to disk */ int nodirty; /* Do not mark volume dirty */ }; #endif /* _NTFSMOVE_H_ */ ntfsprogs-plus-1.0.0/src/deprecated/ntfsrecover.8.in000066400000000000000000000152301507404161300224450ustar00rootroot00000000000000.\" Copyright (c) 2015 Jean-Pierre Andre .\" This file may be copied under the terms of the GNU Public License. .\" .TH NTFSRECOVER 8 "September 2015" "ntfs-3g @VERSION@" .SH NAME ntfsrecover \- Recover updates committed by Windows on an NTFS volume .SH SYNOPSIS \fBntfsrecover\fR [\fIoptions\fR] \fIdevice\fR .SH DESCRIPTION .B ntfsrecover applies to the metadata the updates which were requested on Windows but could not be completed because they were interrupted by some event such as a power failure, a hardware crash, a software crash or the device being unplugged. Doing so, the file system is restored to a consistent state, however updates to user data may still be lost. Updating the file system generally requires updating several records which should all be made for the file system to be kept consistent. For instance, creating a new file requires reserving an inode number (set a bit in a bit map), creating a file record (store the file name and file attributes), and registering the file in a directory (locate the file from some path). When an unfortunate event occurs, and one of these updates could be done but not all of them, the file system is left inconsistent. A group of updates which have all to be done to preserve consistency is called a transaction, and the end of updates within a transaction is called the commitment of the transaction. To protect from unfortunate events, Windows first logs in a special file all the metadata update requests without applying any, until the commitment is known. If the event occurs before the commitment, no update has been made and the file system is consistent. If the event occurs after the update, the log file can be analyzed later and the transactions which were committed can be executed again, thus restoring the integrity of the file system. .B ntfsrecover similarly examines the log file and applies the updates within committed transactions which could not be done by Windows. Currently, ntfs-3g does not log updates, so .B ntfsrecover cannot be used to restore consistency after an unfortunate event occurred while the file system was updated by Linux. .SH OPTIONS Below is a summary of all the options that .B ntfsrecover accepts. The normal usage is to use no option at all, as most of these options are oriented towards developers needs. Nearly all options have two equivalent names. The short name is preceded by .B \- and the long name is preceded by .BR \-\- . Any single letter options, that don't take an argument, can be combined into a single command, e.g. .B \-bv is equivalent to .BR "\-b \-v" . Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-b\fR, \fB\-\-backward\fR Examine the actions described in the logfile backward from the latest one to the earliest one without applying any update. This may encompass records generated during several sessions, and when Windows is restarted, it often does not restart writing where it ended the previous session, so this leads to errors and bad sequencing when examining the full log file. .TP \fB\-c\fR, \fB\-\-clusters\fR \fBCLUSTER-RANGE\fR Restrict the output generated when using options -b -f -u -p to the actions operating on a cluster within the given cluster range. CLUSTER-RANGE is defined by the first and last cluster numbers separated by a hyphen, for instance 100-109 or 0x3e8-0x3ff. A single number means restricting to a single cluster. The first four log blocks have a special role and they are always shown. .TP \fB\-f\fR, \fB\-\-forward\fR \fBNUM\fR Examine the actions described in the logfile forward from the first one to the last one without applying any update. As the log file is reused circularly, the first one is generally not the earliest. Moreover when Windows is restarted, it often does not restart writing where it ended the previous sessions, and this leads to errors when examining a log file generated during several sessions. .TP \fB\-h\fR, \fB\-\-help\fR Show some help information. .TP \fB\-k\fR, \fB\-\-kill\-fast\-restart\fR When Windows has been interrupted with fast restart mode activated, part of pending changes are kept in the Windows cache and only the same Windows version can recover them. This option can be used to apply the changes recorded in the log file and drop the ones in the Windows cache. This is dangerous and may cause loss of data. .TP \fB\-n\fR, \fB\-\-no-action\fR Do not apply any modification, useful when using the options -p, -s or -u. .TP \fB\-p\fR, \fB\-\-play\fR \fBCOUNT\fR Undo COUNT transaction sets and redo a single one, a transaction set being all transactions between two consecutive checkpoints. This is useful for replaying some transaction in the past. As a few actions are not undoable, this is not always possible. .TP \fB\-r\fR, \fB\-\-range\fR \fBBLOCK-RANGE\fR Examine the actions described in the logfile forward restricted to the requested log file block range without applying any update. The first four log blocks have a special role and they are always examined. .TP \fB\-s\fR, \fB\-\-sync\fR Sync the file system by applying the committed actions which have not been synced previously. This is the default option, used when none of the options -n, -f, -r, -p and -u are present. The option -s can be repeated to request applying the committed actions mentioned in the obsolete restart page. This is useful for testing the situations where the latest restart page cannot be read though it can actually be read. .TP \fB\-t\fR, \fB\-\-transactions\fR \fBCOUNT\fR Display the transaction parameters when examining the log file with one of the options --forward, --backward or --range. .TP \fB\-u\fR, \fB\-\-undo\fR \fBCOUNT\fR Undo COUNT transaction sets, thus resetting the file system to some checkpoint in the past, a transaction set being all transactions between two consecutive checkpoints. As a few actions are not undoable, this is not always possible. .TP \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. This option may be used twice to display even more information. .TP \fB\-V\fR, \fB\-\-version\fR Show the version number, copyright and license of .BR ntfsrecover . .SH EXAMPLES Sync an NTFS volume on /dev/sda1. .RS .sp .B ntfsrecover -s /dev/sda1 .sp .RE Display all actions which updated a cluster in range 100 to 119 : .RS .sp .B ntfsrecover --verbose --backward --clusters=100-119 /dev/sda1 .sp .RE .SH BUGS If you find a bug please send an email describing the problem to the development team: .br .nh ntfs\-3g\-devel@lists.sf.net .hy .SH AUTHORS .B ntfsrecover was written by Jean-Pierre Andre .SH AVAILABILITY .B ntfsrecover is part of the .B ntfs-3g package and is available from: .br .nh https://github.com/tuxera/ntfs-3g/wiki/ .hy .SH SEE ALSO .BR ntfs-3g (8), .BR ntfsfix (8), .BR ntfsprogs (8) ntfsprogs-plus-1.0.0/src/deprecated/ntfsrecover.c000066400000000000000000003527741507404161300221340ustar00rootroot00000000000000/* * Process log data from an NTFS partition * * Copyright (c) 2012-2017 Jean-Pierre Andre * * This program examines the Windows log file of an ntfs partition * and plays the committed transactions in order to restore the * integrity of metadata. * * It can also display the contents of the log file in human-readable * text, either from a full partition or from the log file itself. * * * History * * Sep 2012 * - displayed textual logfile contents forward * * Nov 2014 * - decoded multi-page log records * - displayed textual logfile contents backward * * Nov 2015 * - made a general cleaning and redesigned as an ntfsprogs * - applied committed actions from logfile */ /* * 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 (in the main directory of the NTFS-3G * distribution in the file COPYING); if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #define BASEBLKS 4 /* number of special blocks (always shown) */ #define BASEBLKS2 34 /* number of special blocks when version >= 2.0 */ #define RSTBLKS 2 /* number of restart blocks */ #define BUFFERCNT 64 /* number of block buffers - a power of 2 */ #define NTFSBLKLTH 512 /* usa block size */ #define SHOWATTRS 20 /* max attrs shown in a dump */ #define SHOWLISTS 10 /* max lcn or lsn shown in a list */ #define BLOCKBITS 9 /* This is only used to read the restart page */ #define MAXEXCEPTION 10 /* Max number of exceptions (option -x) */ #define MINRECSIZE 48 /* Minimal log record size */ #define MAXRECSIZE 65536 /* Maximal log record size (seen > 56000) */ #include "config.h" #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_GETOPT_H #include #endif #ifdef HAVE_MALLOC_H #include #endif #ifdef HAVE_TIME_H #include #endif #include "types.h" #include "endians.h" #include "support.h" #include "layout.h" #include "param.h" #include "ntfstime.h" #include "device_io.h" #include "device.h" #include "logging.h" #include "runlist.h" #include "mft.h" #include "inode.h" #include "attrib.h" #include "bitmap.h" #include "index.h" #include "volume.h" #include "unistr.h" #include "mst.h" #include "logfile.h" #include "ntfsrecover.h" #include "utils.h" #include "misc.h" typedef struct { ntfs_volume *vol; FILE *file; struct ACTION_RECORD *firstaction; struct ACTION_RECORD *lastaction; } CONTEXT; typedef enum { T_OK, T_ERR, T_DONE } TRISTATE; RESTART_PAGE_HEADER log_header; RESTART_AREA restart; LOG_CLIENT_RECORD client; u32 clustersz = 0; int clusterbits; u32 blocksz; int blockbits; int log_major; u16 bytespersect; u64 mftlcn; u32 mftrecsz; int mftrecbits; u32 mftcnt; /* number of entries */ ntfs_inode *log_ni; ntfs_attr *log_na; u64 logfilelcn; u32 logfilesz; /* bytes */ u64 redos_met; u64 committed_lsn; u64 synced_lsn; u64 latest_lsn; u64 restart_lsn; u64 offset_mask; /* block number in an lsn */ unsigned long firstblk; /* first block to dump (option -r) */ unsigned long lastblk; /* last block to dump (option -r) */ u64 firstlcn; /* first block to dump (option -c) */ u64 lastlcn; /* last block to dump (option -c) */ BOOL optb; /* show the log backward */ BOOL optc; /* restrict to cluster range */ BOOL optd; /* device argument present*/ BOOL opth; /* show help */ BOOL opti; /* show invalid (stale) records */ BOOL optf; /* show full log */ BOOL optk; /* kill fast restart */ BOOL optn; /* do not apply modifications */ BOOL optp; /* count of transaction sets to play */ BOOL optr; /* show a range of blocks */ int opts; /* sync the file system */ BOOL optt; /* show transactions */ BOOL optu; /* count of transaction sets to undo */ int optv; /* verbose */ int optV; /* version */ int optx[MAXEXCEPTION + 1]; struct ATTR **attrtable; unsigned int actionnum; unsigned int attrcount; unsigned int playcount; unsigned int playedactions; // change the name unsigned int redocount; unsigned int undocount; struct BUFFER *buffer_table[BASEBLKS + BUFFERCNT]; unsigned int redirect[BASEBLKS2]; static const le16 SDS[4] = { const_cpu_to_le16('$'), const_cpu_to_le16('S'), const_cpu_to_le16('D'), const_cpu_to_le16('S') } ; static const le16 I30[4] = { const_cpu_to_le16('$'), const_cpu_to_le16('I'), const_cpu_to_le16('3'), const_cpu_to_le16('0') } ; /* * Byte address of a log block */ static s64 loclogblk(CONTEXT *ctx, unsigned int blk) { s64 loc; LCN lcn; if (ctx->vol) { lcn = ntfs_attr_vcn_to_lcn(log_na, ((s64)blk << blockbits) >> clusterbits); loc = lcn << clusterbits; } else { if (((s64)blk << blockbits) >= logfilesz) loc = -1; else loc = (logfilelcn << clusterbits) + ((s64)blk << blockbits); } return (loc); } /* * Deprotect a block * Only to be used for log buffers * * Returns 0 if block was found correct */ static int replaceusa(struct BUFFER *buffer, unsigned int lth) { char *buf; RECORD_PAGE_HEADER *record; unsigned int j; BOOL err; unsigned int used; unsigned int xusa, nusa; err = FALSE; /* Restart blocks have no protection */ if (buffer->num >= RSTBLKS) { /* Do not check beyond used sectors */ record = &buffer->block.record; used = blocksz; xusa = le16_to_cpu(record->usa_ofs); nusa = le16_to_cpu(record->usa_count); if (xusa && nusa && ((xusa + 1) < lth) && ((nusa - 1)*NTFSBLKLTH == lth)) { buf = buffer->block.data; for (j=1; (j> 1; if (key < attrtable[mid]->key) high = mid; else if (key > attrtable[mid]->key) low = mid; else { low = mid; high = mid + 1; } } } if ((low < attrcount) && (attrtable[low]->key == key)) { pa = attrtable[low]; if (pa->namelen < lth) { pa = (struct ATTR*)realloc(pa, sizeof(struct ATTR) + lth); attrtable[low] = pa; } } else { mid = low + 1; if (!low && attrcount && (attrtable[0]->key > key)) mid = 0; pa = (struct ATTR*)malloc(sizeof(struct ATTR) + lth); if (pa) { if (attrcount++) { old = attrtable; attrtable = (struct ATTR**)realloc(attrtable, attrcount*sizeof(struct ATTR*)); if (attrtable) { high = attrcount; while (--high > mid) attrtable[high] = attrtable[high - 1]; attrtable[mid] = pa; } else attrtable = old; } else { attrtable = (struct ATTR**) malloc(sizeof(struct ATTR*)); attrtable[0] = pa; } pa->key = key; pa->namelen = 0; pa->type = const_cpu_to_le32(0); pa->inode = 0; } } return (pa); } /* * Read blocks in a circular buffer * * returns NULL if block cannot be read or it is found bad * otherwise returns the full unprotected block data */ static const struct BUFFER *read_buffer(CONTEXT *ctx, unsigned int num) { struct BUFFER *buffer; BOOL got; int k; unsigned int rnum; /* * The first four blocks are stored apart, to make * sure pages 2 and 3 and the page which is logically * before them can be accessed at the same time. * (Only two blocks are stored apart if version >= 2.0) * Also, block 0 is smaller because it has to be read * before the block size is known. * Note : the last block is supposed to have an odd * number, and cannot be overwritten by block 4 (or 34 * if version >= 2.0) which follows logically. */ if ((num < RSTBLKS) || ((log_major < 2) && (num < BASEBLKS))) buffer = buffer_table[num + BUFFERCNT]; else buffer = buffer_table[num & (BUFFERCNT - 1)]; if (buffer && (buffer->size < blocksz)) { free(buffer); buffer = (struct BUFFER*)NULL; } if (!buffer) { buffer = (struct BUFFER*) malloc(sizeof(struct BUFFER) + blocksz); buffer->size = blocksz; buffer->rnum = num + 1; /* forced to being read */ buffer->safe = FALSE; if (num < BASEBLKS) buffer_table[num + BUFFERCNT] = buffer; else buffer_table[num & (BUFFERCNT - 1)] = buffer; } rnum = num; if (log_major >= 2) { for (k=RSTBLKS; krnum != rnum)) { buffer->num = num; buffer->rnum = rnum; if (ctx->vol) got = (ntfs_attr_pread(log_na,(u64)rnum << blockbits, blocksz, buffer->block.data) == blocksz); else got = !fseek(ctx->file, loclogblk(ctx, rnum), 0) && (fread(buffer->block.data, blocksz, 1, ctx->file) == 1); if (got) { char *data = buffer->block.data; buffer->headsz = sizeof(RECORD_PAGE_HEADER) + ((2*getle16(data,6) - 1) | 7) + 1; buffer->safe = !replaceusa(buffer, blocksz); } else { buffer->safe = FALSE; fprintf(stderr,"** Could not read block %d\n", rnum); } } return (buffer && buffer->safe ? buffer : (const struct BUFFER*)NULL); } void hexdump(const char *buf, unsigned int lth) { unsigned int i,j,k; for (i=0; i 0x20) && (buf[j] < 0x7f)) printf("%c",buf[j]); else printf("."); printf("\n"); } } /* * Display a date */ static void showdate(const char *text, le64 lestamp) { time_t utime; struct tm *ptm; s64 stamp; const char *months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" } ; stamp = le64_to_cpu(lestamp); if ((stamp < ((2147000000 + 134774*86400LL)*10000000LL)) && (stamp > ((-2147000000 + 134774*86400LL)*10000000LL))) { /* date within traditional Unix limits */ utime = stamp/10000000 - 134774*86400LL; ptm = gmtime(&utime); printf("%s %02d %3s %4d %2d:%02d:%02d UTC\n", text, ptm->tm_mday,months[ptm->tm_mon],ptm->tm_year+1900, ptm->tm_hour,ptm->tm_min,ptm->tm_sec); } else { u32 days; unsigned int year; int mon; int cnt; days = stamp/(86400*10000000LL); year = 1601; /* periods of 400 years */ cnt = days/146097; days -= 146097*cnt; year += 400*cnt; /* periods of 100 years */ cnt = (3*days + 3)/109573; days -= 36524*cnt; year += 100*cnt; /* periods of 4 years */ cnt = days/1461; days -= 1461L*cnt; year += 4*cnt; /* periods of a single year */ cnt = (3*days + 3)/1096; days -= 365*cnt; year += cnt; if ((!(year % 100) ? (year % 400) : (year % 4)) && (days > 58)) days++; if (days > 59) { mon = (5*days + 161)/153; days -= (153*mon - 162)/5; } else { mon = days/31 + 1; days -= 31*(mon - 1) - 1; } if (mon > 12) { printf("** Bad day stamp %lld days %lu mon %d year %u\n", (long long)stamp,(unsigned long)days,mon,year); } printf("%s %02u %3s %4u\n",text, (unsigned int)days,months[mon-1],(unsigned int)year); } } void showname(const char *prefix, const char *name, int cnt) { const le16 *n; int i; int c; printf("%s",prefix); n = (const le16*)name; for (i=0; (i> 6) + 0xc0, (c & 63) + 0x80); else printf("%c%c%c", (c >> 12) + 0xe0, ((c >> 6) & 63) + 0x80, (c & 63) + 0x80); } printf("\n"); } static const char *commitment(u64 lsn) { const char *commit; s64 diff; /* Computations assume lsn could wraparound, they probably never do */ diff = lsn - synced_lsn; if (diff <= 0) commit = "synced"; else { diff = lsn - committed_lsn; if (diff <= 0) commit = "committed"; else { /* may find lsn from older session */ diff = lsn - latest_lsn; if (diff <= 0) commit = "*uncommitted*"; else commit = "*stale*"; } } return (commit); } const char *actionname(int op) { static char buffer[24]; const char *p; switch (op) { case Noop : p = "Noop"; break; case CompensationlogRecord : p = "CompensationlogRecord"; break; case InitializeFileRecordSegment : p = "InitializeFileRecordSegment"; break; case DeallocateFileRecordSegment : p = "DeallocateFileRecordSegment"; break; case WriteEndofFileRecordSegment : p = "WriteEndofFileRecordSegment"; break; case CreateAttribute : p = "CreateAttribute"; break; case DeleteAttribute : p = "DeleteAttribute"; break; case UpdateResidentValue : p = "UpdateResidentValue"; break; case UpdateNonResidentValue : p = "UpdateNonResidentValue"; break; case UpdateMappingPairs : p = "UpdateMappingPairs"; break; case DeleteDirtyClusters : p = "DeleteDirtyClusters"; break; case SetNewAttributeSizes : p = "SetNewAttributeSizes"; break; case AddIndexEntryRoot : p = "AddIndexEntryRoot"; break; case DeleteIndexEntryRoot : p = "DeleteIndexEntryRoot"; break; case AddIndexEntryAllocation : p = "AddIndexEntryAllocation"; break; case DeleteIndexEntryAllocation : p = "DeleteIndexEntryAllocation"; break; case WriteEndOfIndexBuffer : p = "WriteEndOfIndexBuffer"; break; case SetIndexEntryVcnRoot : p = "SetIndexEntryVcnRoot"; break; case SetIndexEntryVcnAllocation : p = "SetIndexEntryVcnAllocation"; break; case UpdateFileNameRoot : p = "UpdateFileNameRoot"; break; case UpdateFileNameAllocation : p = "UpdateFileNameAllocation"; break; case SetBitsInNonResidentBitMap : p = "SetBitsInNonResidentBitMap"; break; case ClearBitsInNonResidentBitMap : p = "ClearBitsInNonResidentBitMap"; break; case HotFix : p = "HotFix"; break; case EndTopLevelAction : p = "EndTopLevelAction"; break; case PrepareTransaction : p = "PrepareTransaction"; break; case CommitTransaction : p = "CommitTransaction"; break; case ForgetTransaction : p = "ForgetTransaction"; break; case OpenNonResidentAttribute : p = "OpenNonResidentAttribute"; break; case OpenAttributeTableDump : p = "OpenAttributeTableDump"; break; case AttributeNamesDump : p = "AttributeNamesDump"; break; case DirtyPageTableDump : p = "DirtyPageTableDump"; break; case TransactionTableDump : p = "TransactionTableDump"; break; case UpdateRecordDataRoot : p = "UpdateRecordDataRoot"; break; case UpdateRecordDataAllocation : p = "UpdateRecordDataAllocation"; break; case Win10Action35 : p = "Win10Action35"; break; case Win10Action36 : p = "Win10Action36"; break; case Win10Action37 : p = "Win10Action37"; break; default : sprintf(buffer,"*Unknown-Action-%d*",op); p = buffer; break; } return (p); } static const char *attrname(unsigned int key) { static char name[256]; const char *p; struct ATTR *pa; unsigned int i; if ((key <= 65535) && !(key & 3)) { pa = getattrentry(key,0); if (pa) { if (!pa->namelen) p = "Unnamed"; else { p = name; /* Assume ascii for now */ for (i=0; 2*inamelen; i++) name[i] = le16_to_cpu(pa->name[i]); name[i] = 0; } } else p = "Undefined"; } else p = "Invalid"; return (p); } int fixnamelen(const char *name, int len) { int i; i = 0; while ((i < len) && (name[i] || name[i + 1])) i += 2; return (i); } const char *mftattrname(ATTR_TYPES attr) { static char badattr[24]; const char *p; switch (attr) { case AT_STANDARD_INFORMATION : p = "Standard-Information"; break; case AT_ATTRIBUTE_LIST : p = "Attribute-List"; break; case AT_FILE_NAME : p = "Name"; break; case AT_OBJECT_ID : p = "Volume-Version"; break; case AT_SECURITY_DESCRIPTOR : p = "Security-Descriptor"; break; case AT_VOLUME_NAME : p = "Volume-Name"; break; case AT_VOLUME_INFORMATION : p = "Volume-Information"; break; case AT_DATA : p = "Data"; break; case AT_INDEX_ROOT : p = "Index-Root"; break; case AT_INDEX_ALLOCATION : p = "Index-Allocation"; break; case AT_BITMAP : p = "Bitmap"; break; case AT_REPARSE_POINT : p = "Reparse-Point"; break; case AT_EA_INFORMATION : p = "EA-Information"; break; case AT_EA : p = "EA"; break; case AT_PROPERTY_SET : p = "Property-Set"; break; case AT_LOGGED_UTILITY_STREAM : p = "Logged-Utility-Stream"; break; case AT_END : p = "End"; break; default : sprintf(badattr,"*0x%x-Unknown*",attr); p = badattr; break; } return (p); } static void showattribute(const char *prefix, const struct ATTR *pa) { if (pa) { if (pa->type) { printf("%sattr 0x%x : inode %lld type %s", prefix, pa->key, (long long)pa->inode, mftattrname(pa->type)); if (pa->namelen) showname(" name ",(const char*)pa->name, pa->namelen/2); else printf("\n"); } else { if (pa->namelen) { printf("%sattr 0x%x : type Unknown", prefix, pa->key); showname(" name ",(const char*)pa->name, pa->namelen/2); } else printf("%s(definition of attr 0x%x not met)\n", prefix, pa->key); } } } /* * Determine if an action acts on the MFT */ static BOOL acts_on_mft(int op) { BOOL onmft; /* A few actions may have to be added to the list */ switch (op) { case InitializeFileRecordSegment : case DeallocateFileRecordSegment : case CreateAttribute : case DeleteAttribute : case UpdateResidentValue : case UpdateMappingPairs : case SetNewAttributeSizes : case AddIndexEntryRoot : case DeleteIndexEntryRoot : case UpdateFileNameRoot : case WriteEndofFileRecordSegment : case Win10Action37 : onmft = TRUE; break; default : onmft = FALSE; break; } return (onmft); } u32 get_undo_offset(const LOG_RECORD *logr) { u32 offset; if (logr->lcns_to_follow) offset = 0x30 + le16_to_cpu(logr->undo_offset); else offset = 0x28 + le16_to_cpu(logr->undo_offset); return (offset); } u32 get_redo_offset(const LOG_RECORD *logr) { u32 offset; if (logr->lcns_to_follow) offset = 0x30 + le16_to_cpu(logr->redo_offset); else offset = 0x28 + le16_to_cpu(logr->redo_offset); return (offset); } u32 get_extra_offset(const LOG_RECORD *logr) { u32 uoffset; u32 roffset; roffset = get_redo_offset(logr) + le16_to_cpu(logr->redo_length); uoffset = get_undo_offset(logr) + le16_to_cpu(logr->undo_length); return ((((uoffset > roffset ? uoffset : roffset) - 1) | 7) + 1); } static BOOL likelyop(const LOG_RECORD *logr) { BOOL likely; switch (logr->record_type) { case LOG_STANDARD : /* standard record */ /* Operations in range 0..LastAction-1, can be both null */ likely = ((unsigned int)le16_to_cpu(logr->redo_operation) < LastAction) && ((unsigned int)le16_to_cpu(logr->undo_operation) < LastAction) /* Offsets aligned to 8 bytes */ && !(le16_to_cpu(logr->redo_offset) & 7) && !(le16_to_cpu(logr->undo_offset) & 7) /* transaction id must not be null */ && logr->transaction_id /* client data length aligned to 8 bytes */ && !(le32_to_cpu(logr->client_data_length) & 7) /* client data length less than 64K (131K ?) */ && (le32_to_cpu(logr->client_data_length) < MAXRECSIZE) /* if there is redo data, offset must be >= 0x28 */ && (!le16_to_cpu(logr->redo_length) || ((unsigned int)le16_to_cpu(logr->redo_offset) >= 0x28)) /* if there is undo data, offset must be >= 0x28 */ && (!le16_to_cpu(logr->undo_length) || ((unsigned int)le16_to_cpu(logr->undo_offset) >= 0x28)); /* undo data and redo data should be contiguous when both present */ if (likely && logr->redo_length && logr->undo_length) { /* undo and redo data may be the same when both present and same size */ if (logr->undo_offset == logr->redo_offset) { if (logr->redo_length != logr->undo_length) likely = FALSE; } else { if (le16_to_cpu(logr->redo_offset) < le16_to_cpu(logr->undo_offset)) { /* undo expected just after redo */ if ((((le16_to_cpu(logr->redo_offset) + le16_to_cpu(logr->redo_length) - 1) | 7) + 1) != le16_to_cpu(logr->undo_offset)) likely = FALSE; } else { /* redo expected just after undo */ if ((((le16_to_cpu(logr->undo_offset) + le16_to_cpu(logr->undo_length) - 1) | 7) + 1) != le16_to_cpu(logr->redo_offset)) likely = FALSE; } } } break; case LOG_CHECKPOINT : /* check-point */ /* * undo and redo operations are null * or CompensationlogRecord with no data */ likely = (!logr->redo_operation || ((logr->redo_operation == const_cpu_to_le16(1)) && !logr->redo_length)) && (!logr->undo_operation || ((logr->undo_operation == const_cpu_to_le16(1)) && !logr->undo_length)) /* transaction id must be null */ && !logr->transaction_id /* client_data_length is 0x68 or 0x70 (Vista and subsequent) */ && ((le32_to_cpu(logr->client_data_length) == 0x68) || (le32_to_cpu(logr->client_data_length) == 0x70)); break; default : likely = FALSE; break; } return (likely); } /* * Search for a likely record in a block * * Must not be used when syncing. * * Returns 0 when not found */ static u16 searchlikely(const struct BUFFER *buf) { const LOG_RECORD *logr; const char *data; u16 k; if (opts) printf("** Error : searchlikely() used for syncing\n"); data = buf->block.data; k = buf->headsz; logr = (const LOG_RECORD*)&data[k]; if (!likelyop(logr)) { do { k += 8; logr = (const LOG_RECORD*)&data[k]; } while ((k <= (blocksz - LOG_RECORD_HEAD_SZ)) && !likelyop(logr)); if (k > (blocksz - LOG_RECORD_HEAD_SZ)) k = 0; } return (k); } /* * From a previous block, determine the location of first record * * The previous block must have the beginning of an overlapping * record, and the current block must have the beginning of next * record (which can overlap on next blocks). * The argument "skipped" is the number of blocks in-between. * * Note : the overlapping record from previous block does not reach * the current block when it ends near the end of the last skipped block. * * Returns 0 if some bad condition is found * Returns near blocksz when there is no beginning of record in * the current block */ static u16 firstrecord(int skipped, const struct BUFFER *buf, const struct BUFFER *prevbuf) { const RECORD_PAGE_HEADER *rph; const RECORD_PAGE_HEADER *prevrph; const LOG_RECORD *logr; const char *data; const char *prevdata; u16 k; u16 blkheadsz; s32 size; rph = &buf->block.record; data = buf->block.data; if (prevbuf) { prevrph = &prevbuf->block.record; prevdata = prevbuf->block.data; blkheadsz = prevbuf->headsz; /* From previous page, determine where the current one starts */ k = le16_to_cpu(prevrph->next_record_offset); /* a null value means there is no full record in next block */ if (!k) k = blkheadsz; } else k = 0; /* Minimal size is apparently 48 : offset of redo_operation */ if (k && ((blocksz - k) >= LOG_RECORD_HEAD_SZ)) { logr = (const LOG_RECORD*)&prevdata[k]; if (!logr->client_data_length) { /* * Sometimes the end of record is free space. * This apparently means reaching the end of * a previous session, and must be considered * as an error. * We however tolerate this, unless syncing * is requested. */ printf("* Reaching free space at end of block %d\n", (int)prevbuf->num); /* As a consequence, there cannot be skipped blocks */ if (skipped) { printf("*** Inconsistency : blocks skipped after free space\n"); k = 0; /* error returned */ } if (opts) k = 0; else { k = searchlikely(buf); printf("* Skipping over free space\n"); } } else { size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; if ((size < MINRECSIZE) || (size > MAXRECSIZE)) { printf("** Bad record size %ld in block %ld" " offset 0x%x\n", (long)size,(long)prevbuf->num,(int)k); k = blkheadsz; } else { if ((int)(blocksz - k) >= size) printf("*** Inconsistency : the final" " record does not overlap\n"); k += size - (blocksz - blkheadsz)*(skipped + 1); } if ((k <= blkheadsz) && (k > (blkheadsz - LOG_RECORD_HEAD_SZ))) { /* There were not enough space in the last skipped block */ k = blkheadsz; } else { if (optv && ((blocksz - k) < LOG_RECORD_HEAD_SZ)) { /* Not an error : just no space */ printf("No minimal record space\n"); } if (optv >= 2) printf("Overlapping record from block %d," " starting at offset 0x%x\n", (int)prevbuf->num,(int)k); } } } else { k = buf->headsz; if (optv >= 2) { if (prevbuf) printf("No minimal record from block %d," " starting at offset 0x%x\n", (int)prevbuf->num, (int)k); else printf("No block before %d," " starting at offset 0x%x\n", (int)buf->num, (int)k); } } /* * In a wraparound situation, there is frequently no * match... because there were no wraparound. * Return an error if syncing is requested, otherwise * try to find a starting record. */ if (k && prevbuf && (prevbuf->num > buf->num)) { logr = (const LOG_RECORD*)&data[k]; /* Accept reaching the end with no record beginning */ if ((k != le16_to_cpu(rph->next_record_offset)) && !likelyop(logr)) { if (opts) { k = 0; printf("** Could not wraparound\n"); } else { k = searchlikely(buf); printf("* Skipping over bad wraparound\n"); } } } return (k); } /* * Find the block which defines the first record in current one * * Either the wanted block has the beginning of a record overlapping * on current one, or it ends in such as there is no space for an * overlapping one. * * Returns 0 if the previous block cannot be determined. */ static const struct BUFFER *findprevious(CONTEXT *ctx, const struct BUFFER *buf) { const struct BUFFER *prevbuf; const struct BUFFER *savebuf; const RECORD_PAGE_HEADER *rph; int skipped; int prevblk; BOOL prevmiddle; BOOL error; u16 endoff; error = FALSE; prevblk = buf->num; savebuf = (struct BUFFER*)NULL; skipped = 0; do { prevmiddle = FALSE; if (prevblk > (log_major < 2 ? BASEBLKS : BASEBLKS2)) prevblk--; else if (prevblk == (log_major < 2 ? BASEBLKS : BASEBLKS2)) prevblk = (logfilesz >> blockbits) - 1; else { rph = &buf->block.record; if (log_major < 2) prevblk = (sle64_to_cpu( rph->copy.file_offset) >> blockbits) - 1; else prevblk = (sle64_to_cpu( rph->copy.last_lsn) & offset_mask) >> (blockbits - 3); /* * If an initial block leads to block 4, it * can mean the last block or no previous * block at all. Using the last block is safer, * its lsn will indicate whether it is stale. */ if (prevblk < (log_major < 2 ? BASEBLKS : BASEBLKS2)) prevblk = (logfilesz >> blockbits) - 1; } /* No previous block if the log only consists of block 2 or 3 */ if (prevblk < BASEBLKS) { prevbuf = (struct BUFFER*)NULL; error = TRUE; /* not a real error */ } else { prevbuf = read_buffer(ctx, prevblk); if (prevbuf) { rph = &prevbuf->block.record; prevmiddle = !(rph->flags & const_cpu_to_le32(1)) || !rph->next_record_offset; if (prevmiddle) { savebuf = prevbuf; skipped++; } } else { error = TRUE; printf("** Could not read block %d\n", (int)prevblk); } } } while (prevmiddle && !error); if (!prevmiddle && !error && skipped) { /* No luck if there is not enough space in this record */ rph = &prevbuf->block.record; endoff = le16_to_cpu(rph->next_record_offset); if (endoff > (blocksz - LOG_RECORD_HEAD_SZ)) { prevbuf = savebuf; } } return (error ? (struct BUFFER*)NULL : prevbuf); } void copy_attribute(struct ATTR *pa, const char *buf, int length) { const ATTR_NEW *panew; ATTR_OLD old_aligned; if (pa) { switch (length) { case sizeof(ATTR_NEW) : panew = (const ATTR_NEW*)buf; pa->type = panew->type; pa->lsn = sle64_to_cpu(panew->lsn); pa->inode = MREF(le64_to_cpu(panew->inode)); break; case sizeof(ATTR_OLD) : /* Badly aligned, first realign */ memcpy(&old_aligned,buf,sizeof(old_aligned)); pa->type = old_aligned.type; pa->lsn = sle64_to_cpu(old_aligned.lsn); pa->inode = MREF(le64_to_cpu(old_aligned.inode)); break; default : printf("** Unexpected attribute format, length %d\n", length); } } } static int refresh_attributes(const struct ACTION_RECORD *firstaction) { const struct ACTION_RECORD *action; const LOG_RECORD *logr; struct ATTR *pa; const char *buf; u32 extra; u32 length; u32 len; u32 key; u32 x; u32 i; u32 step; u32 used; for (action=firstaction; action; action=action->next) { logr = &action->record; buf = ((const char*)logr) + get_redo_offset(logr); length = le16_to_cpu(logr->redo_length); switch (le16_to_cpu(action->record.redo_operation)) { case OpenNonResidentAttribute : extra = get_extra_offset(logr) - get_redo_offset(logr); if (logr->undo_length) { len = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ - get_extra_offset(logr); /* this gives a length aligned modulo 8 */ len = fixnamelen(&buf[extra], len); } else len = 0; pa = getattrentry(le16_to_cpu(logr->target_attribute), len); if (pa) { copy_attribute(pa, buf, length); pa->namelen = len; if (len) { memcpy(pa->name,&buf[extra],len); } } break; case OpenAttributeTableDump : i = 24; step = getle16(buf, 8); used = getle16(buf, 12); /* * Changed from Win10, formerly we got step = 44. * The record layout has also changed */ for (x=0; (x 510) { printf("** Error : bad" " attribute name" " length %d\n", len); key = 0; } if (key) { /* Apparently, may have to stop before reaching the end */ pa = getattrentry(key,len); if (pa) { pa->namelen = len; memcpy(pa->name, &buf[i+4],len); } i += len + 6; x++; } } while (key && (i < length)); } break; default : break; } } return (0); } /* * Display a fixup */ static void fixup(CONTEXT *ctx, const LOG_RECORD *logr, const char *buf, BOOL redo) { struct ATTR *pa; int action; int attr; int offs; s32 length; int extra; s32 i; int p; s32 base; u16 firstpos; /* position of first mft attribute */ le32 v; ATTR_TYPES mftattr; le64 w; le64 inode; le64 size; int lth; int len; attr = le16_to_cpu(logr->target_attribute); offs = le16_to_cpu(logr->attribute_offset); if (redo) { action = le16_to_cpu(logr->redo_operation); length = le16_to_cpu(logr->redo_length); } else { action = le16_to_cpu(logr->undo_operation); length = le16_to_cpu(logr->undo_length); } if (redo) printf("redo fixup %dR %s attr 0x%x offs 0x%x\n", actionnum, actionname(action), attr, offs); else printf("undo fixup %dU %s attr 0x%x offs 0x%x\n", actionnum, actionname(action), attr, offs); switch (action) { case InitializeFileRecordSegment : /* 2 */ /* * When this is a redo (with a NoOp undo), the * full MFT record is logged. * When this is an undo (with DeallocateFileRecordSegment redo), * only the header of the MFT record is logged. */ if (!ctx->vol && !mftrecsz && (length > 8)) { /* mftrecsz can be determined from usa_count */ mftrecsz = (getle16(buf,6) - 1)*512; mftrecbits = 1; while ((u32)(1 << mftrecbits) < mftrecsz) mftrecbits++; } printf(" new base MFT record, attr 0x%x (%s)\n",attr,attrname(attr)); printf(" inode %lld\n", (((long long)sle64_to_cpu(logr->target_vcn) << clusterbits) + (le16_to_cpu(logr->cluster_index) << 9)) >> mftrecbits); if (length >= 18) printf(" seq number 0x%04x\n",(int)getle16(buf, 16)); if (length >= 20) printf(" link count %d\n",(int)getle16(buf, 18)); if (length >= 24) { u16 flags; flags = getle16(buf, 22); printf(" flags 0x%x",(int)flags); switch (flags & 3) { case 1 : printf(" (file in use)\n"); break; case 3 : printf(" (directory in use)\n"); break; default : printf(" (not in use)\n"); break; } } base = getle16(buf, 4) + ((getle16(buf, 6)*2 - 1) | 7) + 1; while (base < length) { mftattr = feedle32(buf, base); printf(" attrib 0x%lx (%s) at offset 0x%x\n", (long)le32_to_cpu(mftattr), mftattrname(mftattr), (int)base); if (mftattr == AT_FILE_NAME) { showname(" name ",&buf[base + 90], buf[base + 88] & 255); inode = feedle64(buf, base + 24); printf(" parent dir inode %lld\n", (long long)MREF(le64_to_cpu(inode))); } lth = getle32(buf, base + 4); if ((lth <= 0) || (lth & 7)) base = length; else base += lth; } break; case DeallocateFileRecordSegment : /* 3 */ printf(" free base MFT record, attr 0x%x (%s)\n", attr,attrname(attr)); printf(" inode %lld\n", (((long long)sle64_to_cpu(logr->target_vcn) << clusterbits) + (le16_to_cpu(logr->cluster_index) << 9)) >> mftrecbits); break; case CreateAttribute : /* 5 */ pa = getattrentry(attr,0); base = 24; /* Assume the beginning of the attribute is always present */ switch (getle32(buf,0)) { case 0x30 : printf(" create file name, attr 0x%x\n",attr); if (pa) showattribute(" ",pa); showname(" file ", &buf[base + 66],buf[base + 64] & 255); if (base >= -8) showdate(" created ",feedle64(buf,base + 8)); if (base >= -16) showdate(" modified ",feedle64(buf,base + 16)); if (base >= -24) showdate(" changed ",feedle64(buf,base + 24)); if (base >= -32) showdate(" read ",feedle64(buf,base + 32)); size = feedle64(buf,base + 40); printf(" allocated size %lld\n", (long long)le64_to_cpu(size)); size = feedle64(buf,base + 48); printf(" real size %lld\n", (long long)le64_to_cpu(size)); v = feedle32(buf,base + 56); printf(" DOS flags 0x%lx\n", (long)le32_to_cpu(v)); break; case 0x80 : printf(" create a data stream, attr 0x%x\n",attr); break; case 0xc0 : printf(" create reparse data\n"); if (pa) showattribute(" ",pa); printf(" tag 0x%lx\n",(long)getle32(buf, base)); showname(" print name ", &buf[base + 20 + getle16(buf, base + 12)], getle16(buf, base + 14)/2); break; } break; case UpdateResidentValue : /* 7 */ /* * The record offset designates the mft attribute offset, * offs and length define a right-justified window in this * attribute. * At this stage, we do not know which kind of mft * attribute this is about, we assume this is standard * information when it is the first attribute in the * record. */ base = 0x18 - offs; /* p 8 */ pa = getattrentry(attr,0); firstpos = 0x30 + (((mftrecsz/512 + 1)*2 - 1 ) | 7) + 1; if (pa && !pa->inode && (pa->type == const_cpu_to_le32(0x80)) && !(offs & 3) && (le16_to_cpu(logr->record_offset) == firstpos)) { printf(" set standard information, attr 0x%x\n",attr); showattribute(" ",pa); if ((base >= 0) && ((base + 8) <= length)) showdate(" created ", feedle64(buf,base)); if (((base + 8) >= 0) && ((base + 16) <= length)) showdate(" modified ", feedle64(buf,base + 8)); if (((base + 16) >= 0) && ((base + 24) <= length)) showdate(" changed ", feedle64(buf,base + 16)); if (((base + 24) >= 0) && ((base + 32) <= length)) showdate(" read ", feedle64(buf,base + 24)); if (((base + 32) >= 0) && ((base + 36) <= length)) { v = feedle32(buf, base + 32); printf(" DOS flags 0x%lx\n", (long)le32_to_cpu(v)); } if (((base + 52) >= 0) && ((base + 56) <= length)) { v = feedle32(buf, base + 52); printf(" security id 0x%lx\n", (long)le32_to_cpu(v)); } if (((base + 64) >= 0) && ((base + 72) <= length)) { /* * This is badly aligned for Sparc when * stamps not present and base == 52 */ memcpy(&w, &buf[base + 64], 8); printf(" journal idx 0x%llx\n", (long long)le64_to_cpu(w)); } } else { printf(" set an MFT attribute at offset 0x%x, attr 0x%x\n", (int)offs, attr); if (pa) showattribute(" ",pa); } break; case UpdateNonResidentValue : /* 8 */ printf(" set attr 0x%x (%s)\n",attr,attrname(attr)); pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); base = 0; /* ? */ // Should not be decoded, unless attr is of identified type (I30, ...) if (pa && (pa->namelen == 8) && !memcmp(pa->name, SDS, 8)) { if (length >= 4) printf(" security hash 0x%lx\n", (long)getle32(buf, 0)); if (length >= 8) printf(" security id 0x%lx\n", (long)getle32(buf, 4)); if (length >= 20) printf(" entry size %ld\n", (long)getle32(buf, 16)); } if (pa && (pa->namelen == 8) && !memcmp(pa->name, I30, 8)) { if (!memcmp(buf, "INDX", 4)) base = 64; /* full record */ else base = 0; /* entries */ inode = feedle64(buf, base); printf(" inode %lld\n", (long long)MREF(le64_to_cpu(inode))); inode = feedle64(buf, base + 16); printf(" parent inode %lld\n", (long long)MREF(le64_to_cpu(inode))); showname(" file ",&buf[base + 82], buf[base + 80] & 255); showdate(" date ",feedle64(buf, base + 32)); } break; case UpdateMappingPairs : /* 9 */ printf(" update runlist in attr 0x%x (%s)\n",attr, attrname(attr)); /* argument is a compressed runlist (or part of it ?) */ /* stop when finding 00 */ break; case SetNewAttributeSizes : /* 11 */ printf(" set sizes in attr 0x%x (%s)\n",attr,attrname(attr)); base = 0; /* left justified ? */ size = feedle64(buf,0); printf(" allocated size %lld\n",(long long)le64_to_cpu(size)); size = feedle64(buf,8); printf(" real size %lld\n",(long long)le64_to_cpu(size)); size = feedle64(buf,16); printf(" initialized size %lld\n",(long long)le64_to_cpu(size)); break; case AddIndexEntryRoot : /* 12 */ case AddIndexEntryAllocation : /* 14 */ /* * The record offset designates the mft attribute offset, * offs and length define a left-justified window in this * attribute. */ if (action == AddIndexEntryRoot) printf(" add resident index entry, attr 0x%x\n",attr); else printf(" add nonres index entry, attr 0x%x\n",attr); pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); base = 0; p = getle16(buf, base + 8); /* index types may be discriminated by inode in base+0 */ switch (p) { /* size of index entry */ case 32 : /* $R entry */ memcpy(&inode, &buf[base + 20], 8); /* bad align */ printf(" $R reparse index\n"); printf(" reparsed inode 0x%016llx\n", (long long)le64_to_cpu(inode)); printf(" reparse tag 0x%lx\n", (long)getle32(buf, 16)); break; case 40 : /* $SII entry */ printf(" $SII security id index\n"); printf(" security id 0x%lx\n", (long)getle32(buf, 16)); printf(" security hash 0x%lx\n", (long)getle32(buf, 20)); break; case 48 : /* $SDH entry */ printf(" $SDH security id index\n"); printf(" security id 0x%lx\n", (long)getle32(buf, 20)); printf(" security hash 0x%lx\n", (long)getle32(buf, 16)); break; default : /* directory index are at least 84 bytes long, ntfsdoc p 98 */ /* have everything needed to create the index */ lth = buf[base + 80] & 255; /* consistency of file name length */ if (getle16(buf,10) == (u32)(2*lth + 66)) { printf(" directory index\n"); inode = feedle64(buf,16); printf(" parent dir inode %lld\n", (long long)MREF(le64_to_cpu(inode))); if (feedle32(buf,72) & const_cpu_to_le32(0x10000000)) showname(" file (dir) ", &buf[base + 82], buf[base + 80] & 255); else showname(" file ", &buf[base + 82], buf[base + 80] & 255); inode = feedle64(buf,0); printf(" file inode %lld\n", (long long)MREF(le64_to_cpu(inode))); size = feedle64(buf,64); printf(" file size %lld\n", (long long)le64_to_cpu(size)); showdate(" created ", feedle64(buf,base + 24)); showdate(" modified ", feedle64(buf,base + 32)); showdate(" changed ", feedle64(buf,base + 40)); showdate(" read ", feedle64(buf,base + 48)); } else printf(" unknown index type\n"); break; } break; case SetIndexEntryVcnRoot : /* 17 */ printf(" set vcn of non-resident index root, attr 0x%x\n", attr); pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); printf(" vcn %lld\n", (long long)getle64(buf,0)); break; case UpdateFileNameRoot : /* 19 */ /* * Update an entry in a resident directory index. * The record offset designates the mft attribute offset, * offs and length define a right-justified window in this * attribute. */ printf(" set directory resident entry, attr 0x%x\n",attr); base = length - 0x50; pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); if (pa && !pa->inode && (pa->type == const_cpu_to_le32(0x80)) && !(offs & 3)) { if (base >= -24) showdate(" created ",feedle64(buf, base + 24)); if (base >= -32) showdate(" modified ",feedle64(buf, base + 32)); if (base >= -40) showdate(" changed ",feedle64(buf, base + 40)); if (base >= -48) showdate(" read ",feedle64(buf, base + 48)); if (base >= -56) { size = feedle64(buf,base + 56); printf(" allocated size %lld\n", (long long)le64_to_cpu(size)); } if (base >= -64) { size = feedle64(buf,base + 64); printf(" real size %lld\n", (long long)le64_to_cpu(size)); } if (base > -72) { v = feedle32(buf,base + 72); printf(" DOS flags 0x%lx\n", (long)le32_to_cpu(v)); } } else { /* Usually caused by attr not yet defined */ if (pa && pa->type) printf("** Unexpected index parameters\n"); } break; case UpdateFileNameAllocation : /* 20 */ /* update entry in directory index */ /* only dates, sizes and attrib */ base = length - 64; /* p 12 */ printf(" set directory nonres entry, attr 0x%x\n",attr); pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); if (base >= -8) showdate(" created ",feedle64(buf, base + 8)); if (base >= -16) showdate(" modified ",feedle64(buf, base + 16)); if (base >= -24) showdate(" changed ",feedle64(buf, base + 24)); if (base >= -32) showdate(" read ",*(const le64*)&buf[base + 32]); if (base >= -40) { size = feedle64(buf, base + 40); printf(" allocated size %lld\n", (long long)le64_to_cpu(size)); } if (base >= -48) { size = feedle64(buf, base + 48); printf(" real size %lld\n", (long long)le64_to_cpu(size)); } if (base >= -56) { v = feedle32(buf, base + 56); printf(" DOS flags 0x%lx\n",(long)le32_to_cpu(v)); } break; case SetBitsInNonResidentBitMap : /* 21 */ case ClearBitsInNonResidentBitMap : /* 22 */ if (action == SetBitsInNonResidentBitMap) printf(" SetBitsInNonResidentBitMap, attr 0x%x\n", attr); else printf(" ClearBitsInNonResidentBitMap, attr 0x%x\n", attr); pa = getattrentry(attr,0); if (pa) showattribute(" ",pa); v = feedle32(buf, 0); printf(" first bit %ld\n",(long)le32_to_cpu(v)); v = feedle32(buf, 4); printf(" bit count %ld\n",(long)le32_to_cpu(v)); break; case OpenNonResidentAttribute : /* 28 */ printf(" OpenNonResidentAttribute, attr 0x%x\n",attr); extra = get_extra_offset(logr) - (redo ? get_redo_offset(logr) : get_undo_offset(logr)); if (logr->undo_length) { len = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ - get_extra_offset(logr); /* this gives a length aligned modulo 8 */ len = fixnamelen(&buf[extra], len); } else len = 0; pa = getattrentry(attr,len); if (pa && redo) { /* * If this is a redo, collect the attribute data. * This should only be done when walking forward. */ copy_attribute(pa, buf, length); pa->namelen = len; if (len) memcpy(pa->name,&buf[extra],len); printf(" MFT attribute 0x%lx (%s)\n", (long)le32_to_cpu(pa->type), mftattrname(pa->type)); printf(" lsn 0x%016llx\n", (long long)pa->lsn); printf(" inode %lld\n", (long long)pa->inode); } if (logr->undo_length) showname(" extra : attr name ", &buf[extra], len/2); if (!redo && length) { printf(" * undo attr not shown\n"); } break; case OpenAttributeTableDump : /* 29 */ printf(" OpenAttributeTableDump, attr 0x%x (%s)\n", attr,attrname(attr)); i = 24; if (i < length) { int x; int more; int step; int used; step = getle16(buf, 8); used = getle16(buf, 12); /* * Changed from Win10, formerly we got step = 44. * The record layout has also changed */ if ((step != sizeof(ATTR_OLD)) && (step != sizeof(ATTR_NEW))) { printf(" ** Unexpected step %d\n",step); } more = 0; for (x=0; (xinode, mftattrname(pa->type)); if (pa->namelen) showname(" name ", (char*)pa->name, pa->namelen/2); else printf("\n"); } else more++; } } if (more) printf(" (%d more attrs not shown)\n",more); } break; case AttributeNamesDump : /* 30 */ printf(" AttributeNamesDump, attr 0x%x (%s)\n", attr,attrname(attr)); i = 8; if (i < length) { unsigned int l; unsigned int key; int x; int more; more = 0; x = 0; do { l = le16_to_cpu(*(const le16*)&buf[i+2]); key = le16_to_cpu(*(const le16*)&buf[i]); if (l > 510) { printf("** Error : bad attribute name" " length %d\n",l); key = 0; } /* Apparently, may have to stop before reaching the end */ if (key) { pa = getattrentry(key,l); if (pa) { pa->namelen = l; memcpy(pa->name,&buf[i+4],l); } if (x < SHOWATTRS) { printf(" attr 0x%x is",key); showname(" ",&buf[i+4],l/2); } else more++; i += l + 6; x++; } } while (key && (i < length)); if (more) printf(" (%d more attrs not shown)\n",more); } break; default : break; } } static void detaillogr(CONTEXT *ctx, const LOG_RECORD *logr) { u64 lcn; u64 baselcn; unsigned int i; unsigned int off; unsigned int undo; unsigned int redo; unsigned int extra; unsigned int end; unsigned int listsize; BOOL onmft; switch (logr->record_type) { case LOG_STANDARD : onmft = logr->cluster_index || acts_on_mft(le16_to_cpu(logr->redo_operation)) || acts_on_mft(le16_to_cpu(logr->undo_operation)); printf("redo_operation %04x %s\n", (int)le16_to_cpu(logr->redo_operation), actionname(le16_to_cpu(logr->redo_operation))); printf("undo_operation %04x %s\n", (int)le16_to_cpu(logr->undo_operation), actionname(le16_to_cpu(logr->undo_operation))); printf("redo_offset %04x\n", (int)le16_to_cpu(logr->redo_offset)); printf("redo_length %04x\n", (int)le16_to_cpu(logr->redo_length)); printf("undo_offset %04x\n", (int)le16_to_cpu(logr->undo_offset)); printf("undo_length %04x\n", (int)le16_to_cpu(logr->undo_length)); printf("target_attribute %04x\n", (int)le16_to_cpu(logr->target_attribute)); printf("lcns_to_follow %04x\n", (int)le16_to_cpu(logr->lcns_to_follow)); printf("record_offset %04x\n", (int)le16_to_cpu(logr->record_offset)); printf("attribute_offset %04x\n", (int)le16_to_cpu(logr->attribute_offset)); printf("cluster_index %04x\n", (int)le16_to_cpu(logr->cluster_index)); printf("attribute_flags %04x\n", (int)le16_to_cpu(logr->attribute_flags)); if (mftrecbits && onmft) printf("target_vcn %016llx (inode %lld)\n", (long long)sle64_to_cpu(logr->target_vcn), (((long long)sle64_to_cpu(logr->target_vcn) << clusterbits) + (le16_to_cpu(logr->cluster_index) << 9)) >> mftrecbits); else printf("target_vcn %016llx\n", (long long)sle64_to_cpu(logr->target_vcn)); /* Compute a base for the current run of mft */ baselcn = sle64_to_cpu(logr->lcn_list[0]) - sle64_to_cpu(logr->target_vcn); for (i=0; ilcns_to_follow) && (ilcn_list[i]); printf(" (%d offs 0x%x) lcn %016llx",i, (int)(8*i + sizeof(LOG_RECORD) - 8), (long long)lcn); lcn &= 0xffffffffffffULL; if (mftrecsz && onmft) { if (clustersz > mftrecsz) printf(" (MFT records for inodes" " %lld-%lld)\n", (long long)((lcn - baselcn) *clustersz/mftrecsz), (long long)((lcn + 1 - baselcn) *clustersz/mftrecsz - 1)); else printf(" (MFT record for inode %lld)\n", (long long)((lcn - baselcn) *clustersz/mftrecsz)); printf(" assuming record for inode %lld\n", (long long)((lcn - baselcn) *clustersz/mftrecsz + (le16_to_cpu(logr->cluster_index) >> 1))); } else printf("\n"); } /* * redo_offset and undo_offset are considered unsafe * (actually they are safe when you know the logic) * 2) redo : redo (defined by redo_offset) * 3) undo : undo (defined by undo_offset) * 4) extra : unknown data (end of undo to data_length) */ end = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; if (logr->redo_length && logr->undo_length) { /* both undo and redo are present */ if (le16_to_cpu(logr->undo_offset) <= le16_to_cpu(logr->redo_offset)) { undo = sizeof(LOG_RECORD) - 8 + 8*le16_to_cpu(logr->lcns_to_follow); if (logr->redo_offset == logr->undo_offset) redo = undo; else redo = undo + ((le16_to_cpu(logr->undo_length) - 1) | 7) + 1; extra = redo + ((le16_to_cpu(logr->redo_length) - 1) | 7) + 1; } else { redo = sizeof(LOG_RECORD) - 8 + 8*le16_to_cpu(logr->lcns_to_follow); undo = redo + ((le16_to_cpu(logr->redo_length) - 1) | 7) + 1; extra = undo + ((le16_to_cpu(logr->undo_length) - 1) | 7) + 1; } } else if (logr->redo_length) { /* redo and not undo */ redo = undo = sizeof(LOG_RECORD) - 8 + 8*le16_to_cpu(logr->lcns_to_follow); extra = redo + ((le16_to_cpu(logr->redo_length) - 1) | 7) + 1; } else { /* optional undo and not redo */ redo = undo = sizeof(LOG_RECORD) - 8 + 8*le16_to_cpu(logr->lcns_to_follow); extra = undo + ((le16_to_cpu(logr->undo_length) - 1) | 7) + 1; } printf("redo 0x%x (%u) undo 0x%x (%u) extra 0x%x (%d)\n", redo,(int)(((le16_to_cpu(logr->redo_length) - 1) | 7) + 1), undo,(int)(((le16_to_cpu(logr->undo_length) - 1) | 7) + 1), extra,(int)(end > extra ? end - extra : 0)); if (logr->redo_length && (get_redo_offset(logr) != redo)) printf("** Unexpected redo offset 0x%x %u (%u)\n", get_redo_offset(logr),(int)redo, (int)le16_to_cpu(logr->lcns_to_follow)); if (logr->undo_length && (get_undo_offset(logr) != undo)) printf("** Unexpected undo offset 0x%x %u (%u)\n", get_undo_offset(logr),(int)undo, (int)le16_to_cpu(logr->lcns_to_follow)); if (get_extra_offset(logr) != extra) printf("** Unexpected extra offset 0x%x %u (%u)\n", get_extra_offset(logr),(int)extra, (int)le16_to_cpu(logr->lcns_to_follow)); if (extra <= end) { /* show redo data */ if (logr->redo_length) { if (logr->lcns_to_follow) { off = le16_to_cpu(logr->record_offset) + le16_to_cpu(logr->attribute_offset); printf("redo data (new data) cluster 0x%llx pos 0x%x :\n", (long long)sle64_to_cpu(logr->lcn_list[off >> clusterbits]), (int)(off & (clustersz - 1))); } else printf("redo data (new data) at offs 0x%x :\n",redo); if ((u32)(redo + le16_to_cpu(logr->redo_length)) <= end) { hexdump((const char*)logr + redo,le16_to_cpu(logr->redo_length)); fixup(ctx, logr, (const char*)logr + redo, TRUE); } else printf("redo data overflowing from record\n"); } else { printf("no redo data (new data)\n"); fixup(ctx, logr, (const char*)logr + redo, TRUE); } /* show undo data */ if (logr->undo_length) { if (logr->lcns_to_follow) { off = le16_to_cpu(logr->record_offset) + le16_to_cpu(logr->attribute_offset); printf("undo data (old data) cluster 0x%llx pos 0x%x :\n", (long long)sle64_to_cpu(logr->lcn_list[off >> clusterbits]), (int)(off & (clustersz - 1))); } else printf("undo data (old data) at offs 0x%x :\n",undo); if ((u32)(undo + le16_to_cpu(logr->undo_length)) <= end) { if ((undo + le16_to_cpu(logr->undo_length)) < 2*blocksz) { hexdump((const char*)logr + undo,le16_to_cpu(logr->undo_length)); fixup(ctx, logr, (const char*)logr + undo, FALSE); } else printf("undo data overflowing from two blocks\n"); } else printf("undo data overflowing from record\n"); } else { printf("no undo data (old data)\n"); fixup(ctx, logr, (const char*)logr + undo, FALSE); } /* show extra data, if any */ if (extra != end) { if (end > blocksz) printf("invalid extra data size\n"); else { printf("extra data at offs 0x%x\n",extra); hexdump((const char*)logr + extra, end - extra); } } } else { /* sometimes the designated data overflows */ if (logr->redo_length && ((u32)(redo + le16_to_cpu(logr->redo_length)) > end)) printf("* redo data overflows from record\n"); if (logr->undo_length && ((u32)(undo + le16_to_cpu(logr->undo_length)) > end)) printf("* undo data overflows from record\n"); } break; case LOG_CHECKPOINT : printf("---> checkpoint record\n"); printf("redo_operation %04x %s\n", (int)le16_to_cpu(logr->redo_operation), actionname(le16_to_cpu(logr->redo_operation))); printf("undo_operation %04x %s\n", (int)le16_to_cpu(logr->undo_operation), actionname(le16_to_cpu(logr->undo_operation))); printf("redo_offset %04x\n", (int)le16_to_cpu(logr->redo_offset)); printf("redo_length %04x\n", (int)le16_to_cpu(logr->redo_length)); printf("transaction_lsn %016llx\n", (long long)sle64_to_cpu(logr->transaction_lsn)); printf("attributes_lsn %016llx\n", (long long)sle64_to_cpu(logr->attributes_lsn)); printf("names_lsn %016llx\n", (long long)sle64_to_cpu(logr->names_lsn)); printf("dirty_pages_lsn %016llx\n", (long long)sle64_to_cpu(logr->dirty_pages_lsn)); listsize = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ - offsetof(LOG_RECORD, unknown_list); if (listsize > 8*SHOWLISTS) listsize = 8*SHOWLISTS; for (i=0; 8*iunknown_list[i])); break; default : printf("** Unknown action type\n"); if (le32_to_cpu(logr->client_data_length) < blocksz) { printf("client_data for record type %ld\n", (long)le32_to_cpu(logr->record_type)); hexdump((const char*)&logr->redo_operation, le32_to_cpu(logr->client_data_length)); } else printf("** Bad client data\n"); break; } } BOOL within_lcn_range(const LOG_RECORD *logr) { u64 lcn; unsigned int i; BOOL within; within = FALSE; switch (logr->record_type) { case LOG_STANDARD : for (i=0; ilcns_to_follow); i++) { lcn = MREF(sle64_to_cpu(logr->lcn_list[i])); if ((lcn >= firstlcn) && (lcn <= lastlcn)) within = TRUE; } break; default : break; } return (within); } static void showlogr(CONTEXT *ctx, int k, const LOG_RECORD *logr) { s32 diff; if (optv && (!optc || within_lcn_range(logr))) { diff = sle64_to_cpu(logr->this_lsn) - synced_lsn; printf("this_lsn %016llx (synced%s%ld) %s\n", (long long)sle64_to_cpu(logr->this_lsn), (diff < 0 ? "" : "+"),(long)diff, commitment(diff + synced_lsn)); printf("client_previous_lsn %016llx\n", (long long)sle64_to_cpu(logr->client_previous_lsn)); printf("client_undo_next_lsn %016llx\n", (long long)sle64_to_cpu(logr->client_undo_next_lsn)); printf("client_data_length %08lx\n", (long)le32_to_cpu(logr->client_data_length)); printf("seq_number %d\n", (int)le16_to_cpu(logr->client_id.seq_number)); printf("client_index %d\n", (int)le16_to_cpu(logr->client_id.client_index)); printf("record_type %08lx\n", (long)le32_to_cpu(logr->record_type)); printf("transaction_id %08lx\n", (long)le32_to_cpu(logr->transaction_id)); printf("log_record_flags %04x\n", (int)le16_to_cpu(logr->log_record_flags)); printf("reserved1 %04x %04x %04x\n", (int)le16_to_cpu(logr->reserved_or_alignment[0]), (int)le16_to_cpu(logr->reserved_or_alignment[1]), (int)le16_to_cpu(logr->reserved_or_alignment[2])); detaillogr(ctx, logr); } if (optt) { const char *state; if (logr->record_type == LOG_CHECKPOINT) state = "--checkpoint--"; else state = commitment(sle64_to_cpu(logr->this_lsn)); printf(" at %04x %016llx %s (%ld) %s\n",k, (long long)sle64_to_cpu(logr->this_lsn), state, (long)(sle64_to_cpu(logr->this_lsn) - synced_lsn), actionname(le16_to_cpu(logr->redo_operation))); if (logr->client_previous_lsn || logr->client_undo_next_lsn) { if (logr->client_previous_lsn == logr->client_undo_next_lsn) { printf(" " " previous and undo %016llx\n", (long long)sle64_to_cpu( logr->client_previous_lsn)); } else { printf(" " " previous %016llx", (long long)sle64_to_cpu( logr->client_previous_lsn)); if (logr->client_undo_next_lsn) printf(" undo %016llx\n", (long long)sle64_to_cpu( logr->client_undo_next_lsn)); else printf("\n"); } } } } /* * Mark transactions which should be redone */ static void mark_transactions(struct ACTION_RECORD *lastaction) { struct ACTION_RECORD *action; const LOG_RECORD *logr; le32 id; int actives; BOOL more; BOOL committed; actives = 0; do { more = FALSE; id = const_cpu_to_le32(0); for (action=lastaction; action; action=action->prev) { logr = &action->record; if ((logr->redo_operation == const_cpu_to_le16(ForgetTransaction)) && !(action->flags & ACTION_TO_REDO) && !id) { id = logr->transaction_id; action->flags |= ACTION_TO_REDO; if (optv) printf("Marking transaction 0x%x\n", (int)le32_to_cpu(id)); } committed = ((s64)(sle64_to_cpu(logr->this_lsn) - committed_lsn)) <= 0; if (!logr->transaction_id && committed) action->flags |= ACTION_TO_REDO; if (id && (logr->transaction_id == id) && committed) { action->flags |= ACTION_TO_REDO; more = TRUE; } } if (more) actives++; } while (more); /* * Show unmarked (aborted) actions */ if (optv) { for (action=lastaction; action; action=action->prev) { logr = &action->record; if (logr->transaction_id && !(action->flags & ACTION_TO_REDO)) printf("** Action %d was aborted\n", (int)action->num); } } if (optv && (actives > 1)) printf("%d active transactions in set\n",actives); } /* * Enqueue an action and play the queued actions on end of set */ static TRISTATE enqueue_action(CONTEXT *ctx, const LOG_RECORD *logr, int size, int num) { struct ACTION_RECORD *action; TRISTATE state; int err; err = 1; state = T_ERR; /* enqueue record */ action = (struct ACTION_RECORD*) malloc(size + offsetof(struct ACTION_RECORD, record)); if (action) { memcpy(&action->record, logr, size); action->num = num; action->flags = 0; /* enqueue ahead of list, firstaction is the oldest one */ action->prev = (struct ACTION_RECORD*)NULL; action->next = ctx->firstaction; if (ctx->firstaction) ctx->firstaction->prev = action; else ctx->lastaction = action; ctx->firstaction = action; err = 0; state = T_OK; if ((optp || optu) && (logr->record_type == LOG_CHECKPOINT)) { /* if chkp process queue, and increment count */ playedactions++; if (playedactions <= playcount) { if (optv) printf("* Refreshing attributes\n"); err = refresh_attributes(ctx->firstaction); if (optv) printf("* Undoing transaction set %d" " (actions %d->%d)\n", (int)playedactions, (int)ctx->lastaction->num, (int)ctx->firstaction->num); err = play_undos(ctx->vol, ctx->lastaction); if (err) printf("* Undoing transaction" " set failed\n"); } if (!err && optp && (playedactions == playcount)) { if (optv) printf("* Redoing transaction set %d" " (actions %d->%d)\n", (int)playedactions, (int)ctx->firstaction->num, (int)ctx->lastaction->num); mark_transactions(ctx->lastaction); err = play_redos(ctx->vol, ctx->firstaction); if (err) printf("* Redoing transaction" " set failed\n"); } if (err) state = T_ERR; else if (playedactions == playcount) state = T_DONE; /* free queue */ while (ctx->firstaction) { action = ctx->firstaction->next; free(ctx->firstaction); ctx->firstaction = action; } ctx->lastaction = (struct ACTION_RECORD*)NULL; } if (opts && ((s64)(sle64_to_cpu(logr->this_lsn) - synced_lsn) <= 0)) { if (optv) printf("* Refreshing attributes\n"); // should refresh backward ? err = refresh_attributes(ctx->firstaction); mark_transactions(ctx->lastaction); if (!err) { if (optv) printf("* Syncing actions %d->%d\n", (int)ctx->firstaction->num, (int)ctx->lastaction->num); err = play_redos(ctx->vol, ctx->firstaction); } if (err) { printf("* Syncing actions failed\n"); state = T_ERR; } else state = T_DONE; } } return (state); } static void showheadrcrd(u32 blk, const RECORD_PAGE_HEADER *rph) { s32 diff; if (optv) { printf("magic %08lx\n", (long)le32_to_cpu(rph->magic)); printf("usa_ofs %04x\n", (int)le16_to_cpu(rph->usa_ofs)); printf("usa_count %04x\n", (int)le16_to_cpu(rph->usa_count)); if (blk < 4) printf("file_offset %016llx\n", (long long)sle64_to_cpu(rph->copy.file_offset)); else { diff = sle64_to_cpu(rph->copy.last_lsn) - synced_lsn; printf("last_lsn %016llx" " (synced%s%ld)\n", (long long)sle64_to_cpu(rph->copy.last_lsn), (diff < 0 ? "" : "+"),(long)diff); } printf("flags %08lx\n", (long)le32_to_cpu(rph->flags)); printf("page_count %d\n", (int)le16_to_cpu(rph->page_count)); printf("page_position %d\n", (int)le16_to_cpu(rph->page_position)); printf("next_record_offset %04x\n", (int)le16_to_cpu(rph->next_record_offset)); printf("reserved4 %04x %04x %04x\n", (int)le16_to_cpu(rph->reserved[0]), (int)le16_to_cpu(rph->reserved[1]), (int)le16_to_cpu(rph->reserved[2])); diff = sle64_to_cpu(rph->last_end_lsn) - synced_lsn; printf("last_end_lsn %016llx (synced%s%ld)\n", (long long)sle64_to_cpu(rph->last_end_lsn), (diff < 0 ? "" : "+"),(long)diff); printf("usn %04x\n", (int)getle16(rph,le16_to_cpu(rph->usa_ofs))); printf("\n"); } else { if (optt) { const char *state; state = commitment(sle64_to_cpu(rph->copy.last_lsn)); diff = sle64_to_cpu(rph->copy.last_lsn) - synced_lsn; printf(" last %016llx (synced%s%ld) %s\n", (long long)sle64_to_cpu(rph->copy.last_lsn), (diff < 0 ? "" : "+"),(long)diff, state); state = commitment(sle64_to_cpu(rph->last_end_lsn)); diff = sle64_to_cpu(rph->last_end_lsn) - synced_lsn; printf(" last_end %016llx (synced%s%ld) %s\n", (long long)sle64_to_cpu(rph->last_end_lsn), (diff < 0 ? "" : "+"),(long)diff, state); } } } /* * Analyze and display an action overlapping log blocks * * Returns the position of first action in next block. If this is * greater than a block size (for actions overlapping more than * two blocks), then some blocks have to be skipped. * * Returns 0 in case of error */ static u16 overlapshow(CONTEXT *ctx, u16 k, u32 blk, const struct BUFFER *buf, const struct BUFFER *nextbuf) { const LOG_RECORD *logr; const char *data; const char *nextdata; char *fullrec; u32 size; u32 nextspace; u32 space; BOOL likely; u16 blkheadsz; data = buf->block.data; logr = (const LOG_RECORD*)&data[k]; size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; blkheadsz = buf->headsz; if (nextbuf && (blk >= BASEBLKS)) { nextdata = nextbuf->block.data; space = blocksz - k; nextspace = blocksz - blkheadsz; if ((space >= LOG_RECORD_HEAD_SZ) && (size > space)) { fullrec = (char*)malloc(size); if (size <= (space + nextspace)) { /* Overlap on two blocks */ memcpy(fullrec,&data[k],space); memcpy(&fullrec[space], nextdata + blkheadsz, size - space); likely = likelyop((LOG_RECORD*)fullrec); actionnum++; if (optv) { printf("\nOverlapping record %u at 0x%x" " size %d (next at 0x%x)\n", (int)actionnum,(int)k, (int)size, (int)(k + size)); printf("Overlap marked for block %ld" " space %d likely %d\n", (long)blk,(int)space,likely); } if (likely) showlogr(ctx, k, (LOG_RECORD*)fullrec); else printf("** Skipping unlikely" " overlapping record\n"); k += size - blocksz + blkheadsz; } else { const struct BUFFER *midbuf; int skip; u32 next; u32 pos; int i; /* * The maximum size of of log record is 131104 * (when both offset and length are 65528 for * redo or undo). * So up to 33 log blocks (useful size 4032) * could be needed. However never both undo and * redo have been found big, and 17 should be * the real maximum. */ if (optv) printf("More than two blocks required" " (size %lu)\n",(long)size); memcpy(fullrec,&data[k],space); skip = (size - space - 1)/nextspace; pos = space; likely = TRUE; for (i=1; (i<=skip) && likely; i++) { midbuf = read_buffer(ctx, blk + i); if (midbuf) { memcpy(&fullrec[pos], &midbuf->block .data[blkheadsz], nextspace); pos += nextspace; } else likely = FALSE; } if (pos >= size) { printf("** Error : bad big overlap" " pos %d size %d\n", (int)pos,(int)size); likely = FALSE; } midbuf = read_buffer(ctx, blk + skip + 1); if (midbuf) memcpy(&fullrec[pos], &midbuf->block.data[blkheadsz], size - pos); else likely = FALSE; if (!likelyop((LOG_RECORD*)fullrec)) likely = FALSE; actionnum++; if (optv) { printf("\nBig overlapping record %u at " "0x%x size %u (next at 0x%x)\n", (int)actionnum,(int)k,(int)size, (int)(k + size)); printf("Overlap marked for block %ld" " space %d likely %d\n", (long)blk,(int)space,likely); } if (likely) showlogr(ctx, k, (LOG_RECORD*)fullrec); else printf("** Skipping unlikely" " overlapping record\n"); /* next and skip are only for displaying */ next = (size - space) % nextspace + blkheadsz; if ((blocksz - next) < LOG_RECORD_HEAD_SZ) next = blkheadsz; if (next == blkheadsz) skip++; if (optv) printf("Next record expected in" " block %lu index 0x%x\n", (long)(blk + skip + 1),next); /* Quick check, with no consequences */ if (firstrecord(skip,buf,buf) != next) printf("** Error next != firstrecord" " after block %d\n",blk); k += size - blocksz + blkheadsz; } if (!likely) k = 0; else if (!k) printf("* Bad return from overlap()\n"); free(fullrec); } else { /* No conditions for overlap, usually a new session */ printf("* No block found overlapping on block %d\n", (int)blk); k = 0; } } else { /* blocks 2, 3 and the last one have no next block */ k = 0; } return (k); } /* * Analyze and forward display the actions in a log block * * Returns the position of first action in next block. If this is * greater than a block size, then some blocks have to be skipped. * * Returns 0 in case of error */ static u16 forward_rcrd(CONTEXT *ctx, u32 blk, u16 pos, const struct BUFFER *buf, const struct BUFFER *nextbuf) { const RECORD_PAGE_HEADER *rph; const LOG_RECORD *logr; const char *data; u16 k; u16 endoff; BOOL stop; rph = &buf->block.record; if (rph && (rph->magic == magic_RCRD)) { data = buf->block.data; showheadrcrd(blk, rph); k = buf->headsz; if ((k < pos) && (pos < blocksz)) { k = ((pos - 1) | 7) + 1; } // TODO check bad start > blocksz - 48 logr = (const LOG_RECORD*)&data[k]; stop = FALSE; if (!likelyop(logr)) { if (optv) printf("* Bad start 0x%x for block %d\n", (int)pos,(int)blk); k = searchlikely(buf); if ((k + sizeof(LOG_RECORD)) > blocksz) { printf("No likely full record in block %lu\n", (unsigned long)blk); /* there can be a partial one */ k = le16_to_cpu(rph->next_record_offset); if ((k < (u16)sizeof(RECORD_PAGE_HEADER)) || ((blocksz - k) < LOG_RECORD_HEAD_SZ)) stop = TRUE; } else { if (optv) printf("First record computed at" " offset 0x%x\n", (int)k); } } while (!stop) { s32 size; logr = (const LOG_RECORD*)&data[k]; size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; if ((size < MINRECSIZE) || (size > MAXRECSIZE) || (size & 7)) { printf("** Bad record size %ld in block %ld" " offset 0x%x\n", (long)size, (long)buf->num, (int)k); showlogr(ctx, k, logr); k = 0; stop = TRUE; } else { endoff = le16_to_cpu(rph->next_record_offset); if (((u32)(k + size) <= blocksz) && ((u32)(k + size) <= endoff)) { actionnum++; if (optv) { printf("\n* log action %u at" " 0x%x size %d (next" " at 0x%x)\n", actionnum,k,size, k + size); } showlogr(ctx, k, logr); if (!logr->client_data_length) { printf("** Bad" " client_data_length\n"); stop = TRUE; } k += size; if ((blocksz - k) < LOG_RECORD_HEAD_SZ) { k = nextbuf->headsz; stop = TRUE; } } else { k = overlapshow(ctx, k, blk, buf, nextbuf); stop = TRUE; } } } } else { printf("** Not a RCRD record, MAGIC 0x%08lx\n", (long)le32_to_cpu(rph->magic)); k = 0; } return (k); } /* * Display a restart page */ static void showrest(const RESTART_PAGE_HEADER *rest) { const RESTART_AREA *resa; const LOG_CLIENT_RECORD *rcli; const char *data; data = (const char*)rest; if ((rest->magic == magic_RSTR) || (rest->magic == magic_CHKD)) { if (optv) { printf("magic %08lx\n", (long)le32_to_cpu(rest->magic)); printf("usa_ofs %04x\n", (int)le16_to_cpu(rest->usa_ofs)); printf("usa_count %04x\n", (int)le16_to_cpu(rest->usa_count)); printf("chkdsk_lsn %016llx\n", (long long)sle64_to_cpu(rest->chkdsk_lsn)); printf("system_page_size %08lx\n", (long)le32_to_cpu(rest->system_page_size)); printf("log_page_size %08lx\n", (long)le32_to_cpu(rest->log_page_size)); printf("restart_area_offset %04x\n", (int)le16_to_cpu(rest->restart_area_offset)); printf("minor_vers %d\n", (int)sle16_to_cpu(rest->minor_ver)); printf("major_vers %d\n", (int)sle16_to_cpu(rest->major_ver)); printf("usn %04x\n", (int)le16_to_cpu(rest->usn)); printf("\n"); } else { if (optt) printf(" chkdsk %016llx\n", (long long)sle64_to_cpu(rest->chkdsk_lsn)); } resa = (const RESTART_AREA*) &data[le16_to_cpu(rest->restart_area_offset)]; if (optv) { printf("current_lsn %016llx\n", (long long)sle64_to_cpu(resa->current_lsn)); printf("log_clients %04x\n", (int)le16_to_cpu(resa->log_clients)); printf("client_free_list %04x\n", (int)le16_to_cpu(resa->client_free_list)); printf("client_in_use_list %04x\n", (int)le16_to_cpu(resa->client_in_use_list)); printf("flags %04x\n", (int)le16_to_cpu(resa->flags)); printf("seq_number_bits %08lx\n", (long)le32_to_cpu(resa->seq_number_bits)); printf("restart_area_length %04x\n", (int)le16_to_cpu(resa->restart_area_length)); printf("client_array_offset %04x\n", (int)le16_to_cpu(resa->client_array_offset)); printf("file_size %016llx\n", (long long)sle64_to_cpu(resa->file_size)); printf("last_lsn_data_len %08lx\n", (long)le32_to_cpu(resa->last_lsn_data_length)); printf("record_length %04x\n", (int)le16_to_cpu(resa->log_record_header_length)); printf("log_page_data_offs %04x\n", (int)le16_to_cpu(resa->log_page_data_offset)); printf("restart_log_open_count %08lx\n", (long)le32_to_cpu(resa->restart_log_open_count)); printf("\n"); } else { if (optt) printf(" latest %016llx\n", (long long)sle64_to_cpu(resa->current_lsn)); } rcli = (const LOG_CLIENT_RECORD*) &data[le16_to_cpu(rest->restart_area_offset) + le16_to_cpu(resa->client_array_offset)]; if (optv) { printf("oldest_lsn %016llx\n", (long long)sle64_to_cpu(rcli->oldest_lsn)); printf("client_restart_lsn %016llx\n", (long long)sle64_to_cpu(rcli->client_restart_lsn)); printf("prev_client %04x\n", (int)le16_to_cpu(rcli->prev_client)); printf("next_client %04x\n", (int)le16_to_cpu(rcli->next_client)); printf("seq_number %04x\n", (int)le16_to_cpu(rcli->seq_number)); printf("client_name_length %08x\n", (int)le32_to_cpu(rcli->client_name_length)); showname("client_name ", (const char*)rcli->client_name, le32_to_cpu(rcli->client_name_length) >> 1); } else { if (optt) { printf(" synced %016llx\n", (long long)sle64_to_cpu( rcli->oldest_lsn)); printf(" committed %016llx\n", (long long)sle64_to_cpu( rcli->client_restart_lsn)); } } } else printf("Not a RSTR or CHKD record, MAGIC 0x%08lx\n", (long)le32_to_cpu(rest->magic)); } static BOOL dorest(CONTEXT *ctx, unsigned long blk, const RESTART_PAGE_HEADER *rph, BOOL initial) { const RESTART_AREA *resa; const LOG_CLIENT_RECORD *rcli; const char *data; s64 diff; int offs; int size; BOOL change; BOOL dirty; data = (const char*)rph; offs = le16_to_cpu(rph->restart_area_offset); resa = (const RESTART_AREA*)&data[offs]; rcli = (const LOG_CLIENT_RECORD*)&data[offs + le16_to_cpu(resa->client_array_offset)]; if (initial) { /* Information from block initially found best */ latest_lsn = sle64_to_cpu(resa->current_lsn); committed_lsn = sle64_to_cpu(rcli->client_restart_lsn); synced_lsn = sle64_to_cpu(rcli->oldest_lsn); memcpy(&log_header, rph, sizeof(RESTART_PAGE_HEADER)); offs = le16_to_cpu(log_header.restart_area_offset); memcpy(&restart, &data[offs], sizeof(RESTART_AREA)); offs += le16_to_cpu(restart.client_array_offset); memcpy(&client, &data[offs], sizeof(LOG_CLIENT_RECORD)); dirty = !(resa->flags & RESTART_VOLUME_IS_CLEAN); if (optv || optt) printf("* Using initial restart page," " syncing from 0x%llx, %s\n", (long long)synced_lsn, (dirty ? "dirty" : "clean")); /* Get the block page size */ blocksz = le32_to_cpu(rph->log_page_size); if (optv) printf("* Block size %ld bytes\n", (long)blocksz); blockbits = 1; while ((u32)(1 << blockbits) < blocksz) blockbits++; } else { size = offs + le16_to_cpu(resa->restart_area_length); if (optv) { if (optv >= 2) hexdump(data,size); printf("* RSTR in block %ld 0x%lx (addr 0x%llx)\n", (long)blk,(long)blk, (long long)loclogblk(ctx, blk)); } else { if (optt) printf("restart %ld\n",(long)blk); } showrest(rph); /* Information from an older restart block if requested */ dirty = !(restart.flags & RESTART_VOLUME_IS_CLEAN); diff = sle64_to_cpu(rcli->client_restart_lsn) - committed_lsn; if (ctx->vol) { change = (opts > 1) && (diff < 0); } else { change = (opts > 1 ? diff < 0 : diff > 0); } if (change) { committed_lsn = sle64_to_cpu(rcli->client_restart_lsn); synced_lsn = sle64_to_cpu(rcli->oldest_lsn); latest_lsn = sle64_to_cpu(resa->current_lsn); memcpy(&log_header, rph, sizeof(RESTART_PAGE_HEADER)); offs = le16_to_cpu(log_header.restart_area_offset); memcpy(&restart, &data[offs], sizeof(RESTART_AREA)); offs += le16_to_cpu(restart.client_array_offset); memcpy(&client, &data[offs], sizeof(LOG_CLIENT_RECORD)); dirty = !(resa->flags & RESTART_VOLUME_IS_CLEAN); if (optv || optt) printf("* Using %s restart page," " syncing from 0x%llx, %s\n", (diff < 0 ? "older" : "newer"), (long long)synced_lsn, (dirty ? "dirty" : "clean")); } } restart_lsn = synced_lsn; offset_mask = ((u64)1 << (64 - le32_to_cpu(restart.seq_number_bits))) - (1 << (blockbits - 3)); return (dirty); } /* * Read and process the first restart block * * In full mode, both restart page are silently analyzed by the * library and the most recent readable one is used to define the * sync parameters. * * Returns the first restart buffer * or NULL if the restart block is not valid */ static const struct BUFFER *read_restart(CONTEXT *ctx) { const struct BUFFER *buf; BOOL bad; int blk; int major, minor; bad = FALSE; for (blk=0; blkvol) { RESTART_PAGE_HEADER *rph; rph = (RESTART_PAGE_HEADER*)NULL; /* Full mode : use the restart page selected by the library */ if (ntfs_check_logfile(log_na, &rph)) { /* rph is left unchanged for a wiped out log file */ if (rph) { dorest(ctx, 0, rph, TRUE); free(rph); buf = read_buffer(ctx,0); } else { buf = (const struct BUFFER*)NULL; printf("** The log file has been wiped out\n"); } } else { buf = (const struct BUFFER*)NULL; printf("** Could not get any restart page\n"); } } else { /* Reduced mode : rely on first restart page */ blockbits = BLOCKBITS; /* Until the correct value is read */ blocksz = 1L << blockbits; buf = read_buffer(ctx,0); } if (buf) { NTFS_RECORD_TYPES magic; magic = buf->block.restart.magic; switch (magic) { case magic_RSTR : break; case magic_CHKD : printf("** The log file has been obsoleted by chkdsk\n"); bad = TRUE; break; case magic_empty : printf("** The log file has been wiped out\n"); bad = TRUE; break; default : printf("** Invalid restart block\n"); bad = TRUE; break; } if (!bad && !ctx->vol) dorest(ctx, 0, &buf->block.restart, TRUE); major = sle16_to_cpu(buf->block.restart.major_ver); minor = sle16_to_cpu(buf->block.restart.minor_ver); if ((major == 2) && (minor == 0)) { if (!optk) { printf("** Fast restart mode detected," " data could be lost\n"); printf(" Use option --kill-fast-restart" " to bypass\n"); bad = TRUE; } } else if ((major != 1) || (minor != 1)) { printf("** Unsupported $LogFile version %d.%d\n", major, minor); bad = TRUE; } log_major = major; if (bad) { buf = (const struct BUFFER*)NULL; } } return (buf); } /* * Mark the logfile as synced */ static int reset_logfile(CONTEXT *ctx __attribute__((unused))) { char *buffer; int off; int err; err = 1; buffer = (char*)malloc(blocksz); if (buffer) { memset(buffer, 0, blocksz); restart.client_in_use_list = LOGFILE_NO_CLIENT; restart.flags |= RESTART_VOLUME_IS_CLEAN; client.oldest_lsn = cpu_to_sle64(restart_lsn); /* Set $LogFile version to 1.1 so that volume can be mounted */ log_header.major_ver = const_cpu_to_sle16(1); log_header.minor_ver = const_cpu_to_sle16(1); memcpy(buffer, &log_header, sizeof(RESTART_PAGE_HEADER)); off = le16_to_cpu(log_header.restart_area_offset); memcpy(&buffer[off], &restart, sizeof(RESTART_AREA)); off += le16_to_cpu(restart.client_array_offset); memcpy(&buffer[off], &client, sizeof(LOG_CLIENT_RECORD)); if (!ntfs_mst_pre_write_fixup((NTFS_RECORD*)buffer, blocksz) && (ntfs_attr_pwrite(log_na, 0, blocksz, buffer) == blocksz) && (ntfs_attr_pwrite(log_na, (u64)1 << blockbits, blocksz, buffer) == blocksz)) err = 0; free(buffer); } return (err); } /* * Determine the most recent valid record block */ static const struct BUFFER *best_start(const struct BUFFER *buf, const struct BUFFER *altbuf) { const struct BUFFER *best; const RECORD_PAGE_HEADER *head; const RECORD_PAGE_HEADER *althead; s64 diff; if (!buf || !altbuf) best = (buf ? buf : altbuf); else { head = &buf->block.record; althead = &altbuf->block.record; /* determine most recent, caring for wraparounds */ diff = sle64_to_cpu(althead->last_end_lsn) - sle64_to_cpu(head->last_end_lsn); if (diff > 0) best = altbuf; else best = buf; } if (best && (best->block.record.magic != magic_RCRD)) best = (const struct BUFFER*)NULL; return (best); } /* * Interpret the boot data * * Probably not needed any more, use ctx->vol */ static BOOL getboot(const char *buf) { u64 sectors; u64 clusters; u16 sectpercluster; BOOL ok; ok = TRUE; /* Beware : bad alignment */ bytespersect = (buf[11] & 255) + ((buf[12] & 255) << 8); sectpercluster = buf[13] & 255; clustersz = bytespersect * (u32)sectpercluster; clusterbits = 1; while ((u32)(1 << clusterbits) < clustersz) clusterbits++; sectors = getle64(buf, 0x28); clusters = sectors/sectpercluster; mftlcn = getle64(buf, 0x30); if (buf[0x40] & 0x80) mftrecsz = 1 << (16 - (buf[0x40] & 15)); else mftrecsz = (buf[0x40] & 127)*clustersz; mftrecbits = 1; while ((u32)(1 << mftrecbits) < mftrecsz) mftrecbits++; if (optv) { if ((long long)sectors*bytespersect > 10000000000LL) printf("Capacity %lld bytes (%lld GB)\n", (long long)sectors*bytespersect, (long long)sectors*bytespersect/1000000000); else printf("Capacity %lld bytes (%lld MB)\n", (long long)sectors*bytespersect, (long long)sectors*bytespersect/1000000); printf("sectors %lld (0x%llx), sector size %d\n", (long long)sectors,(long long)sectors, (int)bytespersect); printf("clusters %lld (0x%llx), cluster size %d (%d bits)\n", (long long)clusters,(long long)clusters, (int)clustersz,(int)clusterbits); printf("MFT at cluster %lld (0x%llx), entry size %lu\n", (long long)mftlcn,(long long)mftlcn, (unsigned long)mftrecsz); if (mftrecsz > clustersz) printf("%ld clusters per MFT entry\n", (long)(mftrecsz/clustersz)); else printf("%ld MFT entries per cluster\n", (long)(clustersz/mftrecsz)); } return (ok); } static int locatelogfile(CONTEXT *ctx) { int err; err = 1; log_ni = ntfs_inode_open(ctx->vol, FILE_LogFile); if (log_ni) { log_na = ntfs_attr_open(log_ni, AT_DATA, AT_UNNAMED, 0); if (log_na) { logfilesz = log_na->data_size; err = 0; } } return (err); } /* * Analyze a $LogFile copy * * A $LogFile cannot be played. It can be however be analyzed in * stand-alone mode. * The location of the $MFT will have to be determined elsewhere. */ static BOOL getlogfiledata(CONTEXT *ctx, const char *boot) { const RESTART_PAGE_HEADER *rph; const RESTART_AREA *rest; BOOL ok; u32 off; s64 size; u32 system_page_size; u32 log_page_size; ok = FALSE; fseek(ctx->file,0L,2); size = ftell(ctx->file); rph = (const RESTART_PAGE_HEADER*)boot; off = le16_to_cpu(rph->restart_area_offset); /* * If the system or log page sizes are smaller than the ntfs block size * or either is not a power of 2 we cannot handle this log file. */ system_page_size = le32_to_cpu(rph->system_page_size); log_page_size = le32_to_cpu(rph->log_page_size); if (system_page_size < NTFS_BLOCK_SIZE || log_page_size < NTFS_BLOCK_SIZE || system_page_size & (system_page_size - 1) || log_page_size & (log_page_size - 1)) { printf("** Unsupported page size.\n"); goto out; } if (off & 7 || off > system_page_size) { printf("** Inconsistent restart area offset.\n"); goto out; } rest = (const RESTART_AREA*)&boot[off]; /* estimate cluster size from log file size (unreliable) */ switch (le32_to_cpu(rest->seq_number_bits)) { case 45 : clustersz = 512; break; case 43 : clustersz = 1024; break; /* can be 1024 or 2048 */ case 40 : default : clustersz = 4096; break; } clusterbits = 1; while ((u32)(1 << clusterbits) < clustersz) clusterbits++; printf("* Assuming cluster size %ld\n",(long)clustersz); logfilelcn = 0; logfilesz = size; if (optv) printf("Log file size %lld bytes, cluster size %ld\n", (long long)size, (long)clustersz); /* Have to wait an InitializeFileRecordSegment to get these values */ mftrecsz = 0; mftrecbits = 0; ok = TRUE; out: return (ok); } /* * Get basic volume data * * Locate the MFT and Logfile * Not supposed to read the first log block... */ static BOOL getvolumedata(CONTEXT *ctx, char *boot) { const RESTART_AREA *rest; BOOL ok; ok = FALSE; rest = (const RESTART_AREA*)NULL; if (ctx->vol) { getboot(boot); mftlcn = ctx->vol->mft_lcn; mftcnt = ctx->vol->mft_na->data_size/mftrecsz; if (!locatelogfile(ctx)) ok = TRUE; else { fprintf(stderr,"** Could not read the log file\n"); } } else { if (ctx->file && (!memcmp(boot,"RSTR",4) || !memcmp(boot,"CHKD",4))) { printf("* Assuming a log file copy\n"); ok = getlogfiledata(ctx, boot); if (!ok) goto out; } else fprintf(stderr,"** Not an NTFS image or log file\n"); } // TODO get rest ?, meaningful ? if (ok && rest) { if (rest->client_in_use_list || !(rest->flags & const_cpu_to_le16(2))) printf("Volume was not unmounted safely\n"); else printf("Volume was unmounted safely\n"); if (le16_to_cpu(rest->client_in_use_list) > 1) printf("** multiple clients not implemented\n"); } out: return (ok); } /* * Open the volume (or the log file) and gets its parameters * * Returns TRUE if successful */ static BOOL open_volume(CONTEXT *ctx, const char *device_name) { union { char buf[1024]; /* alignment may be needed in getboot() */ long long force_align; } boot; BOOL ok; int got; ok =FALSE; /* * First check the boot sector, to avoid library errors * when trying to mount a log file. * If the device cannot be fopened or fread, then it is * unlikely to be a file. */ ctx->vol = (ntfs_volume*)NULL; ctx->file = fopen(device_name, "rb"); if (ctx->file) { got = fread(boot.buf,1,1024,ctx->file); if ((got == 1024) && (!memcmp(boot.buf, "RSTR", 4) || !memcmp(boot.buf, "CHKD", 4))) { /* This appears to be a log file */ ctx->vol = (ntfs_volume*)NULL; ok = getvolumedata(ctx, boot.buf); if (!ok) { fclose(ctx->file); goto out; } } else { fclose(ctx->file); } } if (!ok) { /* Not a log file, assume an ntfs device, mount it */ ctx->file = (FILE*)NULL; ctx->vol = ntfs_mount(device_name, ((optk || optp || optu || opts) && !optn ? NTFS_MNT_FORENSIC : NTFS_MNT_RDONLY)); if (ctx->vol) { ok = getvolumedata(ctx, boot.buf); if (!ok) ntfs_umount(ctx->vol, TRUE); } } out: return (ok); } static u16 dorcrd(CONTEXT *ctx, u32 blk, u16 pos, const struct BUFFER *buf, const struct BUFFER *nextbuf) { if (optv) { if (optv >= 2) hexdump(buf->block.data,blocksz); printf("* RCRD in block %ld 0x%lx (addr 0x%llx)" " from pos 0x%x\n", (long)blk,(long)blk, (long long)loclogblk(ctx, blk),(int)pos); } else { if (optt) printf("block %ld\n",(long)blk); } return (forward_rcrd(ctx, blk, pos, buf, nextbuf)); } /* * Concatenate and process a record overlapping on several blocks */ static TRISTATE backoverlap(CONTEXT *ctx, int blk, const char *data, const char *nextdata, int k) { const LOG_RECORD *logr; char *fullrec; s32 size; int space; int nextspace; TRISTATE state; u16 blkheadsz; logr = (const LOG_RECORD*)&data[k]; state = T_ERR; size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; space = blocksz - k; blkheadsz = sizeof(RECORD_PAGE_HEADER) + ((2*getle16(data,6) - 1) | 7) + 1; nextspace = blocksz - blkheadsz; if ((space >= LOG_RECORD_HEAD_SZ) && (size > space) && (size < MAXRECSIZE)) { fullrec = (char*)malloc(size); memcpy(fullrec,&data[k],space); if (size <= (space + nextspace)) memcpy(&fullrec[space], nextdata + blkheadsz, size - space); else { const struct BUFFER *morebuf; const char *moredata; int total; int more; unsigned int mblk; if (optv) printf("* big record, size %d\n",size); total = space; mblk = blk + 1; while (total < size) { if (mblk >= (logfilesz >> blockbits)) mblk = (log_major < 2 ? BASEBLKS : BASEBLKS2); more = size - total; if (more > nextspace) more = nextspace; morebuf = read_buffer(ctx, mblk); if (morebuf) { moredata = morebuf->block.data; memcpy(&fullrec[total], moredata + blkheadsz, more); } total += more; mblk++; } } state = (likelyop((LOG_RECORD*)fullrec) ? T_OK : T_ERR); actionnum++; if (optv) { printf("\nOverlapping backward action %d at 0x%x" " size %d (next at 0x%x)\n", (int)actionnum,(int)k, (int)size,(int)(k + size)); printf("Overlap marked for block %ld space %d" " likely %d\n", (long)blk,(int)space,(state == T_OK)); } if (state == T_OK) { showlogr(ctx, k, (LOG_RECORD*)fullrec); if (optp || optu || opts) state = enqueue_action(ctx, (LOG_RECORD*)fullrec, size, actionnum); } else { /* Try to go on unless playing actions */ if (optb && (state == T_ERR)) state = T_OK; } free(fullrec); } else { /* Error conditions */ if ((size < MINRECSIZE) || (size > MAXRECSIZE)) { printf("** Invalid record size %ld" " in block %ld\n", (long)size,(long)blk); } else printf("** Inconsistency : the final" " record in block %ld" " does not overlap\n", (long)blk); /* Do not abort, unless playing actions */ state = (optb ? T_OK : T_ERR); } return (state); } static TRISTATE backward_rcrd(CONTEXT *ctx, u32 blk, int skipped, const struct BUFFER *buf, const struct BUFFER *prevbuf, const struct BUFFER *nextbuf) { u16 poslist[75]; /* 4096/sizeof(LOG_RECORD) */ const RECORD_PAGE_HEADER *rph; const RECORD_PAGE_HEADER *prevrph; const LOG_RECORD *logr; const char *data; const char *nextdata; BOOL stop; TRISTATE state; s32 size; int cnt; u16 k; u16 endoff; int j; state = T_ERR; rph = &buf->block.record; prevrph = (RECORD_PAGE_HEADER*)NULL; if (prevbuf) prevrph = &prevbuf->block.record; data = buf->block.data; if (rph && (rph->magic == magic_RCRD) && (!prevrph || (prevrph->magic == magic_RCRD))) { if (optv) { if (optv >= 2) hexdump(data,blocksz); if (buf->rnum != blk) printf("* RCRD for block %ld 0x%lx" " in block %ld (addr 0x%llx)\n", (long)blk,(long)blk,(long)buf->rnum, (long long)loclogblk(ctx, blk)); else printf("* RCRD in block %ld 0x%lx (addr 0x%llx)\n", (long)blk,(long)blk, (long long)loclogblk(ctx, blk)); } else { if (optt) printf("block %ld\n",(long)blk); } showheadrcrd(blk, rph); if (!prevbuf) k = buf->headsz; else k = firstrecord(skipped, buf, prevbuf); logr = (const LOG_RECORD*)&data[k]; cnt = 0; /* check whether there is at least one beginning of record */ endoff = le16_to_cpu(rph->next_record_offset); if (k && ((k < endoff) || !endoff)) { logr = (const LOG_RECORD*)&data[k]; if (likelyop(logr)) { stop = FALSE; state = T_OK; if (optv) printf("First record checked" " at offset 0x%x\n", (int)k); } else { printf("** Bad first record at offset 0x%x\n", (int)k); if (optv) showlogr(ctx, k,logr); k = searchlikely(buf); stop = !k; if (stop) { printf("** Could not recover," " stopping at block %d\n", (int)blk); state = T_ERR; } else { /* Try to go on, unless running */ if (optb) state = T_OK; } } while (!stop) { logr = (const LOG_RECORD*)&data[k]; size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; if ((size < MINRECSIZE) || (size > MAXRECSIZE) || (size & 7)) { printf("** Bad size %ld in block %ld" " offset 0x%x, stopping\n", (long)size,(long)blk,(int)k); stop = TRUE; } else { if (((u32)(k + size) <= blocksz) && ((u32)(k + size) <= endoff)) { poslist[cnt++] = k; if (!logr->client_data_length) stop = TRUE; k += size; if ((u32)(k + LOG_RECORD_HEAD_SZ) > blocksz) stop = TRUE; } else { stop = TRUE; } } } } else { stop = TRUE; state = (k ? T_OK : T_ERR); } /* Now examine an overlapping record */ if (k && ((k == endoff) || !endoff) && ((u32)(k + LOG_RECORD_HEAD_SZ) <= blocksz)) { if (nextbuf && (blk >= BASEBLKS)) { nextdata = nextbuf->block.data; state = backoverlap(ctx, blk, data, nextdata, k); } } for (j=cnt-1; (j>=0) && (state==T_OK); j--) { k = poslist[j]; logr = (const LOG_RECORD*)&data[k]; size = le32_to_cpu(logr->client_data_length) + LOG_RECORD_HEAD_SZ; actionnum++; if (optv && (!optc || within_lcn_range(logr))) { printf("\n* log backward action %u at 0x%x" " size %d (next at 0x%x)\n", actionnum, k, size, k + size); } if ((optv | optt) && (!nextbuf && (j == (cnt - 1)))) { printf("* This is the latest record\n"); if (logr->this_lsn == restart.current_lsn) printf(" its lsn matches the global" " restart lsn\n"); if (logr->this_lsn == client.client_restart_lsn) printf(" its lsn matches the client" " restart lsn\n"); if (logr->client_data_length == restart.last_lsn_data_length) printf(" its length matches the" " last record length\n"); } showlogr(ctx, k, logr); if (optp || optu || opts) state = enqueue_action(ctx, logr, size, actionnum); } } return (state); } static int walkback(CONTEXT *ctx, const struct BUFFER *buf, u32 blk, const struct BUFFER *prevbuf, u32 prevblk) { const struct BUFFER *nextbuf; NTFS_RECORD_TYPES magic; u32 stopblk; TRISTATE state; if (optv) { if ((log_major >= 2) && (buf->rnum != blk)) printf("\n* block %d for block %d at 0x%llx\n", (int)buf->rnum,(int)blk, (long long)loclogblk(ctx, buf->rnum)); else printf("\n* block %d at 0x%llx\n",(int)blk, (long long)loclogblk(ctx, blk)); } ctx->firstaction = (struct ACTION_RECORD*)NULL; ctx->lastaction = (struct ACTION_RECORD*)NULL; nextbuf = (const struct BUFFER*)NULL; stopblk = prevblk + 2; // wraparound ! state = backward_rcrd(ctx, blk, 0, buf, prevbuf, (struct BUFFER*)NULL); while ((state == T_OK) && !((blk > stopblk) && (prevblk <= stopblk)) && (!(optp || optu) || (playedactions < playcount))) { int skipped; nextbuf = buf; buf = prevbuf; blk = prevblk; skipped = 0; prevbuf = findprevious(ctx, buf); if (prevbuf) { prevblk = prevbuf->num; if (prevblk < blk) skipped = blk - prevblk - 1; else skipped = blk - prevblk - 1 + (logfilesz >> blockbits) - (log_major < 2 ? BASEBLKS : BASEBLKS2); magic = prevbuf->block.record.magic; switch (magic) { case magic_RCRD : break; case magic_CHKD : printf("** Unexpected block type CHKD\n"); break; case magic_RSTR : printf("** Unexpected block type RSTR\n"); break; default : printf("** Invalid block %d\n",(int)prevblk); break; } if (optv) { if (skipped) printf("\n* block %ld at 0x%llx (block" " %ld used as previous one)\n", (long)blk, (long long)loclogblk(ctx, blk), (long)prevblk); else if ((log_major >= 2) && (buf->rnum != blk)) printf("\n* block %ld for block %ld at 0x%llx\n", (long)buf->rnum, (long)blk, (long long)loclogblk( ctx,buf->rnum)); else printf("\n* block %ld at 0x%llx\n", (long)blk, (long long)loclogblk( ctx, blk)); } state = backward_rcrd(ctx, blk, skipped, buf, prevbuf, nextbuf); } else { fprintf(stderr,"** Could not read block %lu\n", (long)prevblk); state = T_ERR; } } if ((blk > stopblk) && (prevblk <= stopblk)) printf("* Earliest block reached\n"); if ((optp || optu) && (playedactions >= playcount)) printf("* Transaction set count reached\n"); if (opts) printf("* %s %s after playing %u actions\n", (optn ? "Sync simulation" : "Syncing"), (state == T_ERR ? "failed" : "successful"), redocount); /* free queue */ while (ctx->firstaction) { struct ACTION_RECORD *action; action = ctx->firstaction->next; free(ctx->firstaction); ctx->firstaction = action; } ctx->lastaction = (struct ACTION_RECORD*)NULL; return (state == T_ERR ? 1 : 0); } /* * Find the latest log block * * Usually, the latest block is either block 2 or 3 which act as * temporary block before being copied to target location. * However under some unknown condition the block are written * immediately to target location, and we have to scan for the * latest one. * Currently this is not checked for logfile version 2.x which * use a different layout of temporary blocks. */ static const struct BUFFER *find_latest_block(CONTEXT *ctx, u32 baseblk, const struct BUFFER *basebuf) { le64 offset; leLSN prevlsn; leLSN curlsn; u32 curblk; u32 prevblk; const struct BUFFER *prevbuf; const struct BUFFER *curbuf; offset = basebuf->block.record.copy.file_offset; curbuf = (const struct BUFFER*)NULL; curlsn = const_cpu_to_le64(0); prevblk = 0; curblk = baseblk; do { if (curblk < BASEBLKS) { prevbuf = basebuf; prevlsn = basebuf->block.record.last_end_lsn; prevblk = baseblk; curblk = le64_to_cpu(offset) >> blockbits; } else { if (optv) printf("block %d is more recent than block %d\n", (int)curblk, (int)prevblk); prevbuf = curbuf; prevlsn = curlsn; prevblk = curblk; curblk++; if (curblk >= (logfilesz >> blockbits)) curblk = (log_major < 2 ? BASEBLKS : BASEBLKS2); } curbuf = read_buffer(ctx, curblk); if (curbuf && (curbuf->block.record.magic == magic_RCRD)) { curlsn = curbuf->block.record.copy.last_lsn; } } while (curbuf && (curbuf->block.record.magic == magic_RCRD) && (le64_to_cpu(curlsn) > le64_to_cpu(prevlsn))); if (optv) printf("Block %d is the latest one\n",(int)prevblk); return (prevbuf); } /* * Determine the sequencing of blocks (when version >= 2.0) * * Blocks 2..17 and 18..33 are temporary blocks being filled until * they are copied to their target locations, so there are three * possible location for recent blocks. * * Returns the latest target block number */ static int block_sequence(CONTEXT *ctx) { const struct BUFFER *buf; int blk; int k; int target_blk; int latest_blk; s64 final_lsn; s64 last_lsn; s64 last_lsn12; s64 last_lsn1, last_lsn2; final_lsn = 0; for (blk=RSTBLKS; 2*blk<(RSTBLKS+BASEBLKS2); blk++) { /* First temporary block */ last_lsn1 = 0; buf = read_buffer(ctx, blk); if (buf && (buf->block.record.magic == magic_RCRD)) { last_lsn1 = le64_to_cpu( buf->block.record.copy.last_lsn); if (!final_lsn || ((s64)(last_lsn1 - final_lsn) > 0)) final_lsn = last_lsn1; } /* Second temporary block */ buf = read_buffer(ctx, blk + (BASEBLKS2 - RSTBLKS)/2); last_lsn2 = 0; if (buf && (buf->block.record.magic == magic_RCRD)) { last_lsn2 = le64_to_cpu( buf->block.record.copy.last_lsn); if (!final_lsn || ((s64)(last_lsn2 - final_lsn) > 0)) final_lsn = last_lsn2; } /* the latest last_lsn defines the target block */ last_lsn12 = 0; latest_blk = 0; if (last_lsn1 || last_lsn2) { if (!last_lsn2 || ((s64)(last_lsn1 - last_lsn2) > 0)) { last_lsn12 = last_lsn1; latest_blk = blk; } if (!last_lsn1 || ((s64)(last_lsn1 - last_lsn2) <= 0)) { last_lsn12 = last_lsn2; latest_blk = blk + (BASEBLKS2 - RSTBLKS)/2; } } last_lsn = 0; target_blk = 0; if (last_lsn12) { target_blk = (last_lsn12 & offset_mask) >> (blockbits - 3); buf = read_buffer(ctx, target_blk); if (buf && (buf->block.record.magic == magic_RCRD)) { last_lsn = le64_to_cpu( buf->block.record.copy.last_lsn); if (!final_lsn || ((s64)(last_lsn - final_lsn) > 0)) final_lsn = last_lsn; } } /* redirect to the latest block */ if (latest_blk && (!last_lsn || ((s64)(last_lsn - last_lsn12) < 0))) redirect[latest_blk] = target_blk; } if (optv) { printf("\n Blocks redirected :\n"); for (k=RSTBLKS; k> (blockbits - 3); if (optv > 1) printf("final lsn %llx in blk %d\n",(long long)final_lsn,blk); return (blk); } static int walk(CONTEXT *ctx) { const struct BUFFER *buf; const struct BUFFER *nextbuf; const struct BUFFER *prevbuf; const struct BUFFER *startbuf; const NTFS_RECORD *record; const RECORD_PAGE_HEADER *rph; NTFS_RECORD_TYPES magic; u32 blk; u32 nextblk; u32 prevblk; u32 finalblk; int err; u16 blkheadsz; u16 pos; BOOL dirty; BOOL done; buf = (struct BUFFER*)NULL; nextbuf = (struct BUFFER*)NULL; if (optb || optp || optu || opts) { prevbuf = (struct BUFFER*)NULL; } done = FALSE; dirty = TRUE; finalblk = 0; err = 0; blk = 0; pos = 0; /* read and process the first restart block */ buf = read_restart(ctx); if (buf) { if (optv) printf("\n* block %d at 0x%llx\n",(int)blk, (long long)loclogblk(ctx, blk)); } else { done = TRUE; err = 1; } nextblk = blk + 1; while (!done) { /* next block is needed to process the current one */ if ((nextblk >= (logfilesz >> blockbits)) && (optr || optf)) nextbuf = read_buffer(ctx, (log_major < 2 ? BASEBLKS : BASEBLKS2)); else nextbuf = read_buffer(ctx,nextblk); if (nextbuf) { record = (const NTFS_RECORD*)&nextbuf->block.data; blkheadsz = nextbuf->headsz; magic = record->magic; switch (magic) { case magic_CHKD : case magic_RSTR : case magic_RCRD : break; default : printf("** Invalid block\n"); err = 1; break; } magic = buf->block.record.magic; switch (magic) { case magic_CHKD : case magic_RSTR : dirty = dorest(ctx, blk, &buf->block.restart, FALSE); break; case magic_RCRD : if (blk < BASEBLKS) pos = buf->headsz; pos = dorcrd(ctx, blk, pos, buf, nextbuf); while (pos >= blocksz) { if (optv > 1) printf("Skipping block %d" " pos 0x%x\n", (int)nextblk,(int)pos); pos -= (blocksz - blkheadsz); nextblk++; } if ((blocksz - pos) < LOG_RECORD_HEAD_SZ) { pos = 0; nextblk++; } if (nextblk != (blk + 1)) { nextbuf = read_buffer(ctx,nextblk); } break; default : if (!~magic) { if (optv) printf(" empty block\n"); } break; } } else { fprintf(stderr,"* Could not read block %d\n",nextblk); if (ctx->vol) { /* In full mode, ignore errors on restart blocks */ if (blk >= RSTBLKS) { done = TRUE; err = 1; } } else { done = TRUE; err = 1; } } blk = nextblk; nextblk++; if (!optr && (log_major >= 2) && (nextblk == RSTBLKS)) { finalblk = block_sequence(ctx); if (!finalblk) { done = TRUE; err = 1; } } if (optr) { /* Only selected range */ u32 endblk; endblk = (log_major < 2 ? BASEBLKS : RSTBLKS); if ((nextblk == endblk) && (nextblk < firstblk)) nextblk = firstblk; if ((blk >= endblk) && (blk > lastblk)) done = TRUE; } else if (optf) { /* Full log, forward */ if (blk*blocksz >= logfilesz) done = TRUE; } else if (optb || optp || optu || opts || (log_major >= 2)) { /* Restart blocks only (2 blocks) */ if (blk >= RSTBLKS) done = TRUE; } else { /* Base blocks only (4 blocks) */ if (blk >= BASEBLKS) done = TRUE; } if (!done) { buf = nextbuf; if (blk >= RSTBLKS && blk < BASEBLKS) { /* The latest buf may be more recent than restart */ rph = &buf->block.record; if ((s64)(sle64_to_cpu(rph->last_end_lsn) - committed_lsn) > 0) { committed_lsn = sle64_to_cpu(rph->last_end_lsn); if (optv) printf("* Restart page was " "obsolete, updated " "committed lsn\n"); } } if (optv) printf("\n* block %d at 0x%llx\n",(int)blk, (long long)loclogblk(ctx, blk)); } } if (optv && opts && !dirty) printf("* Volume is clean, nothing to do\n"); if (log_major >= 2) blk = finalblk; if (!err && (optb || optp || optu || (opts && dirty))) { playedactions = 0; ctx->firstaction = (struct ACTION_RECORD*)NULL; ctx->lastaction = (struct ACTION_RECORD*)NULL; if (log_major < 2) { buf = nextbuf; nextbuf = read_buffer(ctx, blk+1); startbuf = best_start(buf,nextbuf); if (startbuf && (startbuf == nextbuf)) { /* nextbuf is better, show blk */ if (optv && buf) { printf("* Ignored block %d at 0x%llx\n", (int)blk, (long long)loclogblk(ctx, blk)); if (optv >= 2) hexdump(buf->block.data, blocksz); showheadrcrd(blk, &buf->block.record); } blk++; buf = nextbuf; } else { /* buf is better, show blk + 1 */ if (optv && nextbuf) { printf("* Ignored block %d at 0x%llx\n", (int)(blk + 1), (long long)loclogblk(ctx, blk + 1)); if (optv >= 2) hexdump(nextbuf->block.data, blocksz); showheadrcrd(blk + 1, &nextbuf->block.record); } } if (startbuf && opts) { buf = startbuf = find_latest_block(ctx, blk, startbuf); latest_lsn = le64_to_cpu( buf->block.record.last_end_lsn); } } else { buf = startbuf = read_buffer(ctx, blk); nextbuf = (const struct BUFFER*)NULL; } if (startbuf) { /* The latest buf may be more recent than restart */ rph = &buf->block.record; if ((s64)(sle64_to_cpu(rph->last_end_lsn) - committed_lsn) > 0) { committed_lsn = sle64_to_cpu(rph->last_end_lsn); if (optv) printf("* Restart page was obsolete\n"); } nextbuf = (const struct BUFFER*)NULL; prevbuf = findprevious(ctx, buf); if (prevbuf) { prevblk = prevbuf->num; magic = prevbuf->block.record.magic; switch (magic) { case magic_RCRD : break; case magic_CHKD : printf("** Unexpected block type CHKD\n"); err = 1; break; case magic_RSTR : err = 1; printf("** Unexpected block type RSTR\n"); break; default : err = 1; printf("** Invalid block\n"); break; } } else prevblk = BASEBLKS; if (!err) err = walkback(ctx, buf, blk, prevbuf, prevblk); } else { fprintf(stderr,"** No valid start block, aborting\n"); err = 1; } } return (err); } BOOL exception(int num) { int i; i = 0; while ((i < 10) && optx[i] && (optx[i] != num)) i++; return (optx[i] == num); } static void version(void) { printf("\n%s v%s (libntfs-3g) - Recover updates committed by Windows" " on an NTFS Volume.\n\n", "ntfsrecover", VERSION); printf("Copyright (c) 2012-2017 Jean-Pierre Andre\n"); printf("\n%s\n%s%s\n", ntfs_gpl, ntfs_bugs, ntfs_home); } static void usage(void) { fprintf(stderr,"Usage : for recovering the updates committed by Windows :\n"); fprintf(stderr," ntfsrecover partition\n"); fprintf(stderr," (e.g. ntfsrecover /dev/sda1)\n"); fprintf(stderr,"Advanced : ntfsrecover [-b] [-c first-last] [-i] [-f] [-n] [-p count]\n"); fprintf(stderr," [-r first-last] [-t] [-u count] [-v] partition\n"); fprintf(stderr," -b : show the full log backward\n"); fprintf(stderr," -c : restrict to the actions related to cluster range\n"); fprintf(stderr," -i : show invalid (stale) records\n"); fprintf(stderr," -f : show the full log forward\n"); fprintf(stderr," -h : show this help information\n"); fprintf(stderr," -k : kill fast restart data\n"); fprintf(stderr," -n : do not apply any modification\n"); fprintf(stderr," -p : undo the latest count transaction sets and play one\n"); fprintf(stderr," -r : show a range of log blocks forward\n"); fprintf(stderr," -s : sync the committed changes (default)\n"); fprintf(stderr," -t : show transactions\n"); fprintf(stderr," -u : undo the latest count transaction sets\n"); fprintf(stderr," -v : show more information (-vv yet more)\n"); fprintf(stderr," -V : show version and exit\n"); } /* * Process command options */ static BOOL getoptions(int argc, char *argv[]) { int c; int xcount; u32 xval; char *endptr; BOOL err; static const char *sopt = "-bc:hifknp:r:stu:vVx:"; static const struct option lopt[] = { { "backward", no_argument, NULL, 'b' }, { "clusters", required_argument, NULL, 'c' }, { "forward", no_argument, NULL, 'f' }, { "help", no_argument, NULL, 'h' }, { "kill-fast-restart", no_argument, NULL, 'k' }, { "no-action", no_argument, NULL, 'n' }, { "play", required_argument, NULL, 'p' }, { "range", required_argument, NULL, 'r' }, { "sync", no_argument, NULL, 's' }, { "transactions", no_argument, NULL, 't' }, { "undo", required_argument, NULL, 'u' }, { "verbose", no_argument, NULL, 'v' }, { "version", no_argument, NULL, 'V' }, { "exceptions", required_argument, NULL, 'x' }, { NULL, 0, NULL, 0 } }; err = FALSE; optb = FALSE; optc = FALSE; optd = FALSE; optf = FALSE; opth = FALSE; opti = FALSE; optk = FALSE; optn = FALSE; optp = FALSE; optr = FALSE; opts = 0; optt = FALSE; optu = FALSE; optv = 0; optV = FALSE; optx[0] = 0; while ((c = getopt_long(argc, argv, sopt, lopt, NULL)) != -1) { switch (c) { case 1: /* A non-option argument */ if (optind == argc) optd = TRUE; else { fprintf(stderr, "Device must be the" " last argument.\n"); err = TRUE; } break; case 'b': optb = TRUE; break; case 'c': firstlcn = strtoull(optarg, &endptr, 0); lastlcn = firstlcn; if (*endptr == '-') lastlcn = strtoull(++endptr, &endptr, 0); if (*endptr || (lastlcn < firstlcn)) { fprintf(stderr,"Bad cluster range\n"); err = TRUE; } else optc = TRUE; break; case 'f': optf = TRUE; break; case '?': case 'h': opth = TRUE; break; case 'k': optk = TRUE; break; case 'n': optn = TRUE; break; case 'p': playcount = strtoull(optarg, &endptr, 0); if (*endptr) { fprintf(stderr,"Bad play count\n"); err = TRUE; } else optp = TRUE; break; case 'r' : firstblk = strtoull(optarg, &endptr, 0); lastblk = firstblk; if (*endptr == '-') lastblk = strtoull(++endptr, &endptr, 0); if (*endptr || (lastblk < firstblk)) { fprintf(stderr,"Bad log block range\n"); err = TRUE; } else optr = TRUE; break; case 's': opts++; break; case 't': optt = TRUE; break; case 'u': playcount = strtoull(optarg, &endptr, 0); if (*endptr) { fprintf(stderr,"Bad undo count\n"); err = TRUE; } else optu = TRUE; break; case 'v': optv++; break; case 'V': optV = TRUE; break; case 'x': /* * Undocumented : actions to execute, though * they should be skipped under normal rules. */ xcount = 0; xval = strtoull(optarg, &endptr, 0); while ((*endptr == ',') && (xcount < (MAXEXCEPTION - 1))) { optx[xcount++] = xval; xval = strtoull(++endptr, &endptr, 0); } if (*endptr || (xcount >= MAXEXCEPTION)) { fprintf(stderr,"Bad exception list\n"); err = TRUE; } else { optx[xcount++] = xval; optx[xcount] = 0; } break; default: fprintf(stderr,"Unknown option '%s'.\n", argv[optind - 1]); err = TRUE; } } if (!optd && !optV && !opth) { fprintf(stderr,"Device argument is missing\n"); err = TRUE; } if (!(optb || optf || optp || optr || opts || optt || optu || optV)) opts = 1; if (optb && (optf || optr || opts)) { fprintf(stderr,"Options -f, -r and -s are incompatible with -b\n"); err = TRUE; } if (optf && (optp || opts || optu)) { fprintf(stderr,"Options -p, -s and -u are incompatible with -f\n"); err = TRUE; } if (optp && (optr || opts || optt || optu)) { fprintf(stderr,"Options -r, -s, -t and -u are incompatible with -p\n"); err = TRUE; } if (optr && (opts || optu)) { fprintf(stderr,"Options -s and -u are incompatible with -r\n"); err = TRUE; } if (opts && (optt || optu)) { fprintf(stderr,"Options -t and -u are incompatible with -s\n"); err = TRUE; } if (opth || err) usage(); else if (optV) version(); return (!err); } /* * Quick checks on the layout of needed structs */ static BOOL checkstructs(void) { BOOL ok; ok = TRUE; if (sizeof(RECORD_PAGE_HEADER) != 40) { fprintf(stderr, "* error : bad sizeof(RECORD_PAGE_HEADER) %d\n", (int)sizeof(RECORD_PAGE_HEADER)); ok = FALSE; } if (sizeof(LOG_RECORD) != 88) { fprintf(stderr, "* error : bad sizeof(LOG_RECORD) %d\n", (int)sizeof(LOG_RECORD)); ok = FALSE; } if (sizeof(RESTART_PAGE_HEADER) != 32) { fprintf(stderr, "* error : bad sizeof(RESTART_PAGE_HEADER) %d\n", (int)sizeof(RESTART_PAGE_HEADER)); ok = FALSE; } if (sizeof(RESTART_AREA) != 48) { fprintf(stderr, "* error : bad sizeof(RESTART_AREA) %d\n", (int)sizeof(RESTART_AREA)); ok = FALSE; } if (sizeof(ATTR_OLD) != 44) { fprintf(stderr, "* error : bad sizeof(ATTR_OLD) %d\n", (int)sizeof(ATTR_OLD)); ok = FALSE; } if (sizeof(ATTR_NEW) != 40) { fprintf(stderr, "* error : bad sizeof(ATTR_NEW) %d\n", (int)sizeof(ATTR_NEW)); ok = FALSE; } if (LastAction != 38) { fprintf(stderr, "* error : bad action list, %d actions\n", (int)LastAction); ok = FALSE; } return (ok); } int main(int argc, char *argv[]) { CONTEXT ctx; unsigned int i; int err; err = 1; if (checkstructs() && getoptions(argc,argv)) { if (optV || opth) { err = 0; } else { redocount = 0; undocount = 0; actionnum = 0; attrcount = 0; redos_met = 0; attrtable = (struct ATTR**)NULL; for (i=0; i<(BUFFERCNT + BASEBLKS); i++) buffer_table[i] = (struct BUFFER*)NULL; ntfs_log_set_handler(ntfs_log_handler_outerr); if (open_volume(&ctx, argv[argc - 1])) { if (!ctx.vol && (opts || optp || optu)) { printf("Options -s, -p and -u" " require a full device\n"); err = 1; } else { err = walk(&ctx); if (ctx.vol) { if ((optp || optu || opts) && !err && !optn) { reset_logfile(&ctx); } ntfs_attr_close(log_na); ntfs_inode_close(log_ni); ntfs_umount(ctx.vol, TRUE); } else fclose(ctx.file); } } else fprintf(stderr,"Could not open %s\n", argv[argc - 1]); for (i=0; i<(BUFFERCNT + BASEBLKS); i++) free(buffer_table[i]); for (i=0; i