diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..c9e15ea --- /dev/null +++ b/.clang-format @@ -0,0 +1,120 @@ +# SPDX-License-Identifier: GPL-2.0 +# +# clang-format configuration file. Intended for clang-format >= 4. +# +# For more information, see: +# +# Documentation/process/clang-format.rst +# https://clang.llvm.org/docs/ClangFormat.html +# https://clang.llvm.org/docs/ClangFormatStyleOptions.html +# +# Copied from Linux @ 5.18.0 +--- +AccessModifierOffset: -4 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignConsecutiveMacros: AcrossEmptyLines +#AlignEscapedNewlines: Left # Unknown to clang-format-4.0 +AlignOperands: true +AlignTrailingComments: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: false +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: true + AfterNamespace: true + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + #AfterExternBlock: false # Unknown to clang-format-5.0 + BeforeCatch: false + BeforeElse: false + IndentBraces: false + #SplitEmptyFunction: true # Unknown to clang-format-4.0 + #SplitEmptyRecord: true # Unknown to clang-format-4.0 + #SplitEmptyNamespace: true # Unknown to clang-format-4.0 +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Custom +#BreakBeforeInheritanceComma: false # Unknown to clang-format-4.0 +BreakBeforeTernaryOperators: false +BreakConstructorInitializersBeforeComma: false +#BreakConstructorInitializers: BeforeComma # Unknown to clang-format-4.0 +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: false +ColumnLimit: 80 +CommentPragmas: '^ IWYU pragma:' +#CompactNamespaces: false # Unknown to clang-format-4.0 +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 8 +ContinuationIndentWidth: 8 +Cpp11BracedListStyle: false +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +#FixNamespaceComments: false # Unknown to clang-format-4.0 + +IncludeBlocks: Preserve +IncludeCategories: + - Regex: '.*' + Priority: 1 +IncludeIsMainRegex: '(Test)?$' +IndentCaseLabels: false +#IndentPPDirectives: None # Unknown to clang-format-5.0 +IndentWidth: 8 +IndentWrappedFunctionNames: false +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +#ObjCBinPackProtocolList: Auto # Unknown to clang-format-5.0 +ObjCBlockIndentWidth: 8 +ObjCSpaceAfterProperty: true +ObjCSpaceBeforeProtocolList: true + +# Taken from git's rules +#PenaltyBreakAssignment: 10 # Unknown to clang-format-4.0 +PenaltyBreakBeforeFirstCallParameter: 30 +PenaltyBreakComment: 10 +PenaltyBreakFirstLessLess: 0 +PenaltyBreakString: 10 +PenaltyExcessCharacter: 100 +PenaltyReturnTypeOnItsOwnLine: 60 + +PointerAlignment: Right +ReflowComments: false +SortIncludes: false +#SortUsingDeclarations: false # Unknown to clang-format-4.0 +SpaceAfterCStyleCast: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +#SpaceBeforeCtorInitializerColon: true # Unknown to clang-format-5.0 +#SpaceBeforeInheritanceColon: true # Unknown to clang-format-5.0 +SpaceBeforeParens: ControlStatements +#SpaceBeforeRangeBasedForLoopColon: true # Unknown to clang-format-5.0 +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: false +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp03 +TabWidth: 8 +UseTab: Always +... diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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 Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index a3a7546..26a82dd 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,22 @@ This HAL was pulled from AOSP source code and bastardised to build and run on a ## Dependencies * zlib-dev +* meson +* cmake +* linux-headers -## Usage +## Building + +qbootctl uses the meson build system +```sh +meson build +meson compile -C build ``` + +## Usage + +```text qbootctl: qcom bootctrl HAL port for Linux ------------------------------------------- qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT] diff --git a/bootctrl.h b/bootctrl.h new file mode 100644 index 0000000..03da69b --- /dev/null +++ b/bootctrl.h @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2016 The Android Open Source Project + * Copyright (C) 2022 Caleb Connolly + * + * 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 3 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, see . + */ + +#ifndef __BOOTCTRL_H__ +#define __BOOTCTRL_H__ + +struct slot_info { + bool active; + bool bootable; + bool successful; +}; + +struct boot_control_module { + + /* + * (*getCurrentSlot)() returns the value letting the system know + * whether the current slot is A or B. The meaning of A and B is + * left up to the implementer. It is assumed that if the current slot + * is A, then the block devices underlying B can be accessed directly + * without any risk of corruption. + * The returned value is always guaranteed to be strictly less than the + * value returned by getNumberSlots. Slots start at 0 and + * finish at getNumberSlots() - 1 + */ + unsigned (*getCurrentSlot)(); + + /* + * (*markBootSuccessful)() marks the specified slot + * as boot successful + * + * Returns 0 on success, -errno on error. + */ + int (*markBootSuccessful)(unsigned slot); + + /* + * (*setActiveBootSlot)() marks the slot passed in parameter as + * the active boot slot (see getCurrentSlot for an explanation + * of the "slot" parameter). This overrides any previous call to + * setSlotAsUnbootable. + * Returns 0 on success, -errno on error. + */ + int (*setActiveBootSlot)(unsigned slot); + + /* + * (*setSlotAsUnbootable)() marks the slot passed in parameter as + * an unbootable. This can be used while updating the contents of the slot's + * partitions, so that the system will not attempt to boot a known bad set up. + * Returns 0 on success, -errno on error. + */ + int (*setSlotAsUnbootable)(unsigned slot); + + /* + * (*isSlotBootable)() returns if the slot passed in parameter is + * bootable. Note that slots can be made unbootable by both the + * bootloader and by the OS using setSlotAsUnbootable. + * Returns 1 if the slot is bootable, 0 if it's not, and -errno on + * error. + */ + int (*isSlotBootable)(unsigned slot); + + /* + * (*getSuffix)() returns the string suffix used by partitions that + * correspond to the slot number passed in parameter. The returned string + * is expected to be statically allocated and not need to be freed. + * Returns NULL if slot does not match an existing slot. + */ + const char* (*getSuffix)(unsigned slot); + + /* + * (*isSlotMarkedSucessful)() returns if the slot passed in parameter has + * been marked as successful using markBootSuccessful. + * Returns 1 if the slot has been marked as successful, 0 if it's + * not the case, and -errno on error. + */ + int (*isSlotMarkedSuccessful)(unsigned slot); + + /** + * Returns the active slot to boot into on the next boot. If + * setActiveBootSlot() has been called, the getter function should return + * the same slot as the one provided in the last setActiveBootSlot() call. + */ + unsigned (*getActiveBootSlot)(); +}; + +extern const struct boot_control_module bootctl; +extern const struct boot_control_module bootctl_test; + +#endif // __BOOTCTRL_H__ diff --git a/bootctrl_impl.cpp b/bootctrl_impl.cpp new file mode 100644 index 0000000..bfbcda5 --- /dev/null +++ b/bootctrl_impl.cpp @@ -0,0 +1,717 @@ +/* + * Copyright (c) 2016, The Linux Foundation. All rights reserved. + * Copyright (C) 2021-2022 Caleb Connolly + * + * 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 3 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, see . + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "utils.h" +#include "gpt-utils.h" + +#include "bootctrl.h" + +#define BOOTDEV_DIR "/dev/disk/by-partlabel" +#define BOOT_IMG_PTN_NAME "boot_" +#define LUN_NAME_END_LOC 14 +#define BOOT_SLOT_PROP "slot_suffix" + +#define MAX_CMDLINE_SIZE 4096 + +#define SLOT_ACTIVE 1 +#define SLOT_INACTIVE 2 +#define UPDATE_SLOT(pentry, guid, slot_state) \ + ({ \ + memcpy(pentry, guid, TYPE_GUID_SIZE); \ + if (slot_state == SLOT_ACTIVE) \ + *(pentry + AB_FLAG_OFFSET) = AB_SLOT_ACTIVE_VAL; \ + else if (slot_state == SLOT_INACTIVE) \ + *(pentry + AB_FLAG_OFFSET) = \ + (*(pentry + AB_FLAG_OFFSET) & \ + ~AB_PARTITION_ATTR_SLOT_ACTIVE); \ + }) + +using namespace std; +const char *slot_suffix_arr[] = { AB_SLOT_A_SUFFIX, AB_SLOT_B_SUFFIX, NULL }; + +enum part_attr_type { + ATTR_SLOT_ACTIVE = 0, + ATTR_BOOT_SUCCESSFUL, + ATTR_UNBOOTABLE, + ATTR_BOOTABLE, +}; + +void get_kernel_cmdline_arg(const char *arg, char *buf, const char *def) +{ + int fd; + char pcmd[MAX_CMDLINE_SIZE]; + char *val, *found, *ptr = buf; + fd = open("/proc/cmdline", O_RDONLY); + int rc = read(fd, pcmd, MAX_CMDLINE_SIZE); + if (rc < 0) { + fprintf(stderr, "Couldn't open /proc/cmdline: %d (%s)\n", rc, + strerror(errno)); + goto error; + } + close(fd); + found = strstr(pcmd, arg); + if (!found || !(val = strstr(found, "="))) { + fprintf(stderr, "Couldn't find cmdline arg: '%s'\n", arg); + goto error; + } + + val++; + // no this doesn't handle quotes lol + while (*val != ' ') { + *ptr++ = *val++; + } + + return; + +error: + strcpy(buf, def); +} + +//Get the value of one of the attribute fields for a partition. +static int get_partition_attribute(char *partname, + enum part_attr_type part_attr) +{ + struct gpt_disk *disk = NULL; + uint8_t *pentry = NULL; + int retval = -1; + uint8_t *attr = NULL; + if (!partname) + goto error; + disk = gpt_disk_alloc(); + if (!disk) { + fprintf(stderr, "%s: Failed to alloc disk struct\n", __func__); + goto error; + } + if (gpt_disk_get_disk_info(partname, disk)) { + fprintf(stderr, "%s: Failed to get disk info\n", __func__); + goto error; + } + pentry = gpt_disk_get_pentry(disk, partname, PRIMARY_GPT); + + if (!pentry) { + fprintf(stderr, "%s: pentry does not exist in disk struct\n", + __func__); + goto error; + } + attr = pentry + AB_FLAG_OFFSET; + LOGD("get_partition_attribute() partname = %s, attr = 0x%x\n", partname, + *attr); + if (part_attr == ATTR_SLOT_ACTIVE) { + retval = !!(*attr & AB_PARTITION_ATTR_SLOT_ACTIVE); + LOGD("ATTR_SLOT_ACTIVE, retval = %d\n", retval); + } else if (part_attr == ATTR_BOOT_SUCCESSFUL) { + retval = !!(*attr & AB_PARTITION_ATTR_BOOT_SUCCESSFUL); + LOGD("AB_PARTITION_ATTR_BOOT_SUCCESSFUL, retval = %d\n", + retval); + } else if (part_attr == ATTR_UNBOOTABLE) { + retval = !!(*attr & AB_PARTITION_ATTR_UNBOOTABLE); + LOGD("AB_PARTITION_ATTR_UNBOOTABLE, retval = %d\n", retval); + } else { + retval = -1; + } + gpt_disk_free(disk); + return retval; +error: + if (disk) + gpt_disk_free(disk); + return retval; +} + +//Set a particular attribute for all the partitions in a +//slot +static int update_slot_attribute(const char *slot, enum part_attr_type ab_attr) +{ + unsigned int i = 0; + char buf[PATH_MAX]; + struct stat st; + struct gpt_disk *disk = NULL; + uint8_t *pentry = NULL; + uint8_t *pentry_bak = NULL; + int rc = -1; + uint8_t *attr = NULL; + uint8_t *attr_bak = NULL; + char partName[MAX_GPT_NAME_SIZE + 1] = { 0 }; + const char ptn_list[][MAX_GPT_NAME_SIZE - 1] = { AB_PTN_LIST }; + int slot_name_valid = 0; + if (!slot) { + fprintf(stderr, "%s: Invalid argument\n", __func__); + goto error; + } + for (i = 0; slot_suffix_arr[i] != NULL; i++) { + if (!strncmp(slot, slot_suffix_arr[i], + strlen(slot_suffix_arr[i]))) + slot_name_valid = 1; + } + if (!slot_name_valid) { + fprintf(stderr, "%s: Invalid slot name\n", __func__); + goto error; + } + for (i = 0; i < ARRAY_SIZE(ptn_list); i++) { + memset(buf, '\0', sizeof(buf)); + //Check if A/B versions of this ptn exist + snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, + ptn_list[i], AB_SLOT_A_SUFFIX); + if (stat(buf, &st) < 0) { + //partition does not have _a version + continue; + } + memset(buf, '\0', sizeof(buf)); + snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, + ptn_list[i], AB_SLOT_B_SUFFIX); + if (stat(buf, &st) < 0) { + //partition does not have _b version + continue; + } + memset(partName, '\0', sizeof(partName)); + snprintf(partName, sizeof(partName) - 1, "%s%s", ptn_list[i], + slot); + disk = gpt_disk_alloc(); + if (!disk) { + fprintf(stderr, "%s: Failed to alloc disk struct\n", + __func__); + goto error; + } + rc = gpt_disk_get_disk_info(partName, disk); + if (rc != 0) { + fprintf(stderr, "%s: Failed to get disk info for %s\n", + __func__, partName); + goto error; + } + pentry = gpt_disk_get_pentry(disk, partName, PRIMARY_GPT); + pentry_bak = gpt_disk_get_pentry(disk, partName, SECONDARY_GPT); + if (!pentry || !pentry_bak) { + fprintf(stderr, + "%s: Failed to get pentry/pentry_bak for %s\n", + __func__, partName); + goto error; + } + attr = pentry + AB_FLAG_OFFSET; + LOGD("%s: got pentry for part '%s': 0x%lx (at flags: 0x%x)\n", + __func__, partName, *(uint64_t *)pentry, *attr); + attr_bak = pentry_bak + AB_FLAG_OFFSET; + switch (ab_attr) { + case ATTR_BOOT_SUCCESSFUL: + *attr = (*attr) | AB_PARTITION_ATTR_BOOT_SUCCESSFUL; + *attr_bak = + (*attr_bak) | AB_PARTITION_ATTR_BOOT_SUCCESSFUL; + break; + case ATTR_UNBOOTABLE: + *attr = (*attr) | AB_PARTITION_ATTR_UNBOOTABLE; + *attr_bak = (*attr_bak) | AB_PARTITION_ATTR_UNBOOTABLE; + break; + case ATTR_BOOTABLE: + *attr = (*attr) ^ AB_PARTITION_ATTR_UNBOOTABLE; + *attr_bak = (*attr_bak) ^ AB_PARTITION_ATTR_UNBOOTABLE; + break; + case ATTR_SLOT_ACTIVE: + *attr = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; + *attr_bak = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; + break; + default: + fprintf(stderr, "%s: Unrecognized attr\n", __func__); + goto error; + } + if (gpt_disk_update_crc(disk)) { + fprintf(stderr, "%s: Failed to update crc for %s\n", + __func__, partName); + goto error; + } + if (gpt_disk_commit(disk)) { + fprintf(stderr, + "%s: Failed to write back entry for %s\n", + __func__, partName); + goto error; + } + gpt_disk_free(disk); + disk = NULL; + } + return 0; +error: + if (disk) + gpt_disk_free(disk); + return -1; +} + +unsigned get_number_slots() +{ + struct dirent *de = NULL; + DIR *dir_bootdev = NULL; + unsigned slot_count = 0; + + dir_bootdev = opendir(BOOTDEV_DIR); + if (!dir_bootdev) { + fprintf(stderr, "%s: Failed to open bootdev dir (%s)\n", + __func__, strerror(errno)); + goto error; + } + while ((de = readdir(dir_bootdev))) { + if (de->d_name[0] == '.') + continue; + static_assert(AB_SLOT_A_SUFFIX[0] == '_', + "Breaking change to slot A suffix"); + static_assert(AB_SLOT_B_SUFFIX[0] == '_', + "Breaking change to slot B suffix"); + if (!strncmp(de->d_name, BOOT_IMG_PTN_NAME, + strlen(BOOT_IMG_PTN_NAME)) && + !!strncmp(de->d_name, "boot_aging\n", + strlen("boot_aging"))) { + slot_count++; + } + } + closedir(dir_bootdev); + return slot_count; +error: + if (dir_bootdev) + closedir(dir_bootdev); + return 0; +} + +static unsigned int get_current_slot() +{ + uint32_t num_slots = 0; + char bootSlotProp[MAX_CMDLINE_SIZE] = { '\0' }; + unsigned i = 0; + num_slots = get_number_slots(); + if (num_slots <= 1) { + //Slot 0 is the only slot around. + return 0; + } + get_kernel_cmdline_arg(BOOT_SLOT_PROP, bootSlotProp, "_a"); + if (!strncmp(bootSlotProp, "N/A\n", strlen("N/A"))) { + fprintf(stderr, "%s: Unable to read boot slot property\n", + __func__); + goto error; + } + //Iterate through a list of partitons named as boot+suffix + //and see which one is currently active. + for (i = 0; slot_suffix_arr[i] != NULL; i++) { + if (!strncmp(bootSlotProp, slot_suffix_arr[i], + strlen(slot_suffix_arr[i]))) { + //printf("%s current_slot = %d\n", __func__, i); + return i; + } + } +error: + //The HAL spec requires that we return a number between + //0 to num_slots - 1. Since something went wrong here we + //are just going to return the default slot. + return 0; +} + +static int boot_control_check_slot_sanity(unsigned slot) +{ + uint32_t num_slots = get_number_slots(); + if ((num_slots < 1) || (slot > num_slots - 1)) { + fprintf(stderr, "Invalid slot number"); + return -1; + } + return 0; +} + +int get_boot_attr(unsigned slot, enum part_attr_type attr) +{ + char bootPartition[MAX_GPT_NAME_SIZE + 1] = { 0 }; + + if (boot_control_check_slot_sanity(slot) != 0) { + fprintf(stderr, "%s: Argument check failed\n", __func__); + return -1; + } + snprintf(bootPartition, sizeof(bootPartition) - 1, "boot%s", + slot_suffix_arr[slot]); + + return get_partition_attribute(bootPartition, attr); +} + +int is_slot_bootable(unsigned slot) +{ + int attr = 0; + attr = get_boot_attr(slot, ATTR_UNBOOTABLE); + if (attr >= 0) + return !attr; + + return -1; +} + +int mark_boot_successful(unsigned slot) +{ + int successful = get_boot_attr(slot, ATTR_BOOT_SUCCESSFUL); + + if (!is_slot_bootable(slot)) { + printf("SLOT %s: was marked unbootable, fixing this" + " (I hope you know what you're doing...)\n", + slot_suffix_arr[slot]); + update_slot_attribute(slot_suffix_arr[slot], ATTR_BOOTABLE); + } + + if (successful) { + fprintf(stderr, "SLOT %s: already marked successful\n", + slot_suffix_arr[slot]); + return -1; + } + + if (update_slot_attribute(slot_suffix_arr[slot], + ATTR_BOOT_SUCCESSFUL)) { + goto error; + } + return 0; +error: + fprintf(stderr, "SLOT %s: Failed to mark boot successful\n", + slot_suffix_arr[slot]); + return -1; +} + +const char *get_suffix(unsigned slot) +{ + if (boot_control_check_slot_sanity(slot) != 0) + return NULL; + else + return slot_suffix_arr[slot]; +} + +//Return a gpt disk structure representing the disk that holds +//partition. +static struct gpt_disk *boot_ctl_get_disk_info(char *partition) +{ + struct gpt_disk *disk = NULL; + if (!partition) + return NULL; + disk = gpt_disk_alloc(); + if (!disk) { + fprintf(stderr, "%s: Failed to alloc disk\n", __func__); + goto error; + } + if (gpt_disk_get_disk_info(partition, disk)) { + fprintf(stderr, "failed to get disk info for %s\n", partition); + goto error; + } + return disk; +error: + if (disk) + gpt_disk_free(disk); + return NULL; +} + +//The argument here is a vector of partition names(including the slot suffix) +//that lie on a single disk +static int boot_ctl_set_active_slot_for_partitions(vector part_list, + unsigned slot) +{ + char buf[PATH_MAX] = { 0 }; + struct gpt_disk *disk = NULL; + char slotA[MAX_GPT_NAME_SIZE + 1] = { 0 }; + char slotB[MAX_GPT_NAME_SIZE + 1] = { 0 }; + char active_guid[TYPE_GUID_SIZE + 1] = { 0 }; + char inactive_guid[TYPE_GUID_SIZE + 1] = { 0 }; + int rc; + //Pointer to the partition entry of current 'A' partition + uint8_t *pentryA = NULL; + uint8_t *pentryA_bak = NULL; + //Pointer to partition entry of current 'B' partition + uint8_t *pentryB = NULL; + uint8_t *pentryB_bak = NULL; + struct stat st; + vector::iterator partition_iterator; + + LOGD("Marking slot %s as active:\n", slot_suffix_arr[slot]); + + for (partition_iterator = part_list.begin(); + partition_iterator != part_list.end(); partition_iterator++) { + //Chop off the slot suffix from the partition name to + //make the string easier to work with. + string prefix = *partition_iterator; + LOGD("Part: %s\n", prefix.c_str()); + if (prefix.size() < (strlen(AB_SLOT_A_SUFFIX) + 1)) { + fprintf(stderr, "Invalid partition name: %s\n", + prefix.c_str()); + goto error; + } + prefix.resize(prefix.size() - strlen(AB_SLOT_A_SUFFIX)); + //Check if A/B versions of this ptn exist + snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, + prefix.c_str(), AB_SLOT_A_SUFFIX); + LOGD("\t_a Path: '%s'\n", buf); + rc = stat(buf, &st); + if (rc < 0) { + fprintf(stderr, "Failed to stat() path: %d: %s\n", rc, + strerror(errno)); + continue; + } + memset(buf, '\0', sizeof(buf)); + snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, + prefix.c_str(), AB_SLOT_B_SUFFIX); + LOGD("\t_b Path: '%s'\n", buf); + rc = stat(buf, &st); + if (rc < 0) { + fprintf(stderr, "Failed to stat() path: %d: %s\n", rc, + strerror(errno)); + continue; + } + memset(slotA, 0, sizeof(slotA)); + memset(slotB, 0, sizeof(slotA)); + snprintf(slotA, sizeof(slotA) - 1, "%s%s", prefix.c_str(), + AB_SLOT_A_SUFFIX); + snprintf(slotB, sizeof(slotB) - 1, "%s%s", prefix.c_str(), + AB_SLOT_B_SUFFIX); + //Get the disk containing the partitions that were passed in. + //All partitions passed in must lie on the same disk. + if (!disk) { + disk = boot_ctl_get_disk_info(slotA); + if (!disk) + goto error; + } + //Get partition entry for slot A & B from the primary + //and backup tables. + pentryA = gpt_disk_get_pentry(disk, slotA, PRIMARY_GPT); + pentryA_bak = gpt_disk_get_pentry(disk, slotA, SECONDARY_GPT); + pentryB = gpt_disk_get_pentry(disk, slotB, PRIMARY_GPT); + pentryB_bak = gpt_disk_get_pentry(disk, slotB, SECONDARY_GPT); + if (!pentryA || !pentryA_bak || !pentryB || !pentryB_bak) { + //None of these should be NULL since we have already + //checked for A & B versions earlier. + fprintf(stderr, "Slot pentries for %s not found.\n", + prefix.c_str()); + goto error; + } + LOGD("\tAB attr (A): 0x%x (backup: 0x%x)\n", + *(uint16_t *)(pentryA + AB_FLAG_OFFSET), + *(uint16_t *)(pentryA_bak + AB_FLAG_OFFSET)); + LOGD("\tAB attr (B): 0x%x (backup: 0x%x)\n", + *(uint16_t *)(pentryB + AB_FLAG_OFFSET), + *(uint16_t *)(pentryB_bak + AB_FLAG_OFFSET)); + memset(active_guid, '\0', sizeof(active_guid)); + memset(inactive_guid, '\0', sizeof(inactive_guid)); + if (get_partition_attribute(slotA, ATTR_SLOT_ACTIVE) == 1) { + //A is the current active slot + memcpy((void *)active_guid, (const void *)pentryA, + TYPE_GUID_SIZE); + memcpy((void *)inactive_guid, (const void *)pentryB, + TYPE_GUID_SIZE); + } else if (get_partition_attribute(slotB, ATTR_SLOT_ACTIVE) == + 1) { + //B is the current active slot + memcpy((void *)active_guid, (const void *)pentryB, + TYPE_GUID_SIZE); + memcpy((void *)inactive_guid, (const void *)pentryA, + TYPE_GUID_SIZE); + } else { + fprintf(stderr, "Both A & B are inactive..Aborting"); + goto error; + } + // printf("\tActive GUID: %s\n", active_guid); + // printf("\tInactive GUID: %s\n", active_guid); + if (!strncmp(slot_suffix_arr[slot], AB_SLOT_A_SUFFIX, + strlen(AB_SLOT_A_SUFFIX))) { + //Mark A as active in primary table + UPDATE_SLOT(pentryA, active_guid, SLOT_ACTIVE); + //Mark A as active in backup table + UPDATE_SLOT(pentryA_bak, active_guid, SLOT_ACTIVE); + //Mark B as inactive in primary table + UPDATE_SLOT(pentryB, inactive_guid, SLOT_INACTIVE); + //Mark B as inactive in backup table + UPDATE_SLOT(pentryB_bak, inactive_guid, SLOT_INACTIVE); + } else if (!strncmp(slot_suffix_arr[slot], AB_SLOT_B_SUFFIX, + strlen(AB_SLOT_B_SUFFIX))) { + //Mark B as active in primary table + UPDATE_SLOT(pentryB, active_guid, SLOT_ACTIVE); + //Mark B as active in backup table + UPDATE_SLOT(pentryB_bak, active_guid, SLOT_ACTIVE); + //Mark A as inavtive in primary table + UPDATE_SLOT(pentryA, inactive_guid, SLOT_INACTIVE); + //Mark A as inactive in backup table + UPDATE_SLOT(pentryA_bak, inactive_guid, SLOT_INACTIVE); + } else { + //Something has gone terribly terribly wrong + fprintf(stderr, "%s: Unknown slot suffix!\n", __func__); + goto error; + } + if (gpt_disk_update_crc(disk) != 0) { + fprintf(stderr, "%s: Failed to update gpt_disk crc\n", + __func__); + goto error; + } + } + //write updated content to disk + if (disk) { + if (gpt_disk_commit(disk)) { + fprintf(stderr, "Failed to commit disk entry"); + goto error; + } + gpt_disk_free(disk); + } + return 0; + +error: + if (disk) + gpt_disk_free(disk); + return -1; +} + +unsigned get_active_boot_slot() +{ + uint32_t num_slots = get_number_slots(); + if (num_slots <= 1) { + //Slot 0 is the only slot around. + return 0; + } + + for (uint32_t i = 0; i < num_slots; i++) { + if (get_boot_attr(i, ATTR_SLOT_ACTIVE)) + return i; + } + + fprintf(stderr, "%s: Failed to find the active boot slot\n", __func__); + return 0; +} + +int set_active_boot_slot(unsigned slot) +{ + map > ptn_map; + vector ptn_vec; + const char ptn_list[][MAX_GPT_NAME_SIZE] = { AB_PTN_LIST }; + uint32_t i; + int rc = -1; + map >::iterator map_iter; + + if (boot_control_check_slot_sanity(slot)) { + fprintf(stderr, "%s: Bad arguments\n", __func__); + goto error; + } + + //The partition list just contains prefixes(without the _a/_b) of the + //partitions that support A/B. In order to get the layout we need the + //actual names. To do this we append the slot suffix to every member + //in the list. + for (i = 0; i < ARRAY_SIZE(ptn_list); i++) { + //XBL is handled differrently for ufs devices so ignore it + if (!strncmp(ptn_list[i], PTN_XBL, strlen(PTN_XBL))) + continue; + //The partition list will be the list of _a partitions + string cur_ptn = ptn_list[i]; + cur_ptn.append(AB_SLOT_A_SUFFIX); + ptn_vec.push_back(cur_ptn); + } + //The partition map gives us info in the following format: + // [path_to_block_device_1]--> + // [path_to_block_device_2]--> + // ... + // ... + // eg: + // [/dev/block/sdb]---> + if (gpt_utils_get_partition_map(ptn_vec, ptn_map)) { + fprintf(stderr, "%s: Failed to get partition map\n", __func__); + goto error; + } + for (map_iter = ptn_map.begin(); map_iter != ptn_map.end(); + map_iter++) { + if (map_iter->second.size() < 1) + continue; + if (boot_ctl_set_active_slot_for_partitions(map_iter->second, + slot)) { + fprintf(stderr, + "%s: Failed to set active slot for partitions \n", + __func__); + ; + goto error; + } + } + + if (!strncmp(slot_suffix_arr[slot], AB_SLOT_A_SUFFIX, + strlen(AB_SLOT_A_SUFFIX))) { + //Set xbl_a as the boot lun + rc = gpt_utils_set_xbl_boot_partition(NORMAL_BOOT); + } else if (!strncmp(slot_suffix_arr[slot], AB_SLOT_B_SUFFIX, + strlen(AB_SLOT_B_SUFFIX))) { + //Set xbl_b as the boot lun + rc = gpt_utils_set_xbl_boot_partition(BACKUP_BOOT); + } else { + //Something has gone terribly terribly wrong + fprintf(stderr, "%s: Unknown slot suffix!\n", __func__); + goto error; + } + if (rc) { + fprintf(stderr, + "%s: Failed to switch xbl boot partition\n", + __func__); + goto error; + } + + return 0; + +error: + return -1; +} + +int set_slot_as_unbootable(unsigned slot) +{ + if (boot_control_check_slot_sanity(slot) != 0) { + fprintf(stderr, "%s: Argument check failed\n", __func__); + goto error; + } + if (update_slot_attribute(slot_suffix_arr[slot], ATTR_UNBOOTABLE)) { + goto error; + } + return 0; +error: + fprintf(stderr, "%s: Failed to mark slot unbootable\n", __func__); + return -1; +} + +int is_slot_marked_successful(unsigned slot) +{ + int attr = 0; + char bootPartition[MAX_GPT_NAME_SIZE + 1] = { 0 }; + + if (boot_control_check_slot_sanity(slot) != 0) { + fprintf(stderr, "%s: Argument check failed\n", __func__); + goto error; + } + snprintf(bootPartition, sizeof(bootPartition) - 1, "boot%s", + slot_suffix_arr[slot]); + attr = get_partition_attribute(bootPartition, ATTR_BOOT_SUCCESSFUL); + LOGD("%s: slot = %d, attr = 0x%x\n", __func__, slot, attr); + if (attr >= 0) + return attr; +error: + return -1; +} + +const struct boot_control_module bootctl = { + .getCurrentSlot = get_current_slot, + .markBootSuccessful = mark_boot_successful, + .setActiveBootSlot = set_active_boot_slot, + .setSlotAsUnbootable = set_slot_as_unbootable, + .isSlotBootable = is_slot_bootable, + .getSuffix = get_suffix, + .isSlotMarkedSuccessful = is_slot_marked_successful, + .getActiveBootSlot = get_active_boot_slot, +}; diff --git a/bootctrl_test.cpp b/bootctrl_test.cpp new file mode 100644 index 0000000..284f5cf --- /dev/null +++ b/bootctrl_test.cpp @@ -0,0 +1,96 @@ +/* + * Copyright (C) 2016 The Android Open Source Project + * Copyright (C) 2022 Caleb Connolly + * + * 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 3 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, see . + */ + +#include "bootctrl.h" + +struct test_state { + struct slot_info slots[2]; +}; + +static struct test_state state = { + .slots = { + [0] = { + .active = true, + .bootable = true, + .successful = false, + }, + [1] = { + .active = false, + .bootable = true, + .successful = false, + }, + } +}; + +unsigned test_get_current_slot() +{ + return (unsigned int)state.slots[1].active; +} + +int test_mark_boot_successful(unsigned slot) +{ + return 0; +} + +int test_set_active_boot_slot(unsigned slot) +{ + return 0; +} + +int test_set_slot_as_unbootable(unsigned slot) +{ + return 0; +} + +int test_is_slot_bootable(unsigned slot) +{ + return 1; +} + +const char *test_get_suffix(unsigned slot) +{ + switch (slot) { + case 0: + return "_x"; + case 1: + return "_z"; + default: + return "??"; + } +} + +int test_is_slot_marked_successful(unsigned slot) +{ + return 1; +} + +unsigned test_get_active_boot_slot() +{ + return 0; +} + +const struct boot_control_module bootctl_test = { + .getCurrentSlot = test_get_current_slot, + .markBootSuccessful = test_mark_boot_successful, + .setActiveBootSlot = test_set_active_boot_slot, + .setSlotAsUnbootable = test_set_slot_as_unbootable, + .isSlotBootable = test_is_slot_bootable, + .getSuffix = test_get_suffix, + .isSlotMarkedSuccessful = test_is_slot_marked_successful, + .getActiveBootSlot = test_get_active_boot_slot, +}; \ No newline at end of file diff --git a/gpt-utils.cpp b/gpt-utils.cpp index 12c6159..d16dc61 100644 --- a/gpt-utils.cpp +++ b/gpt-utils.cpp @@ -1,5 +1,6 @@ /* * Copyright (c) 2013, The Linux Foundation. All rights reserved. + * Copyright (C) 2021-2022 Caleb Connolly * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are @@ -29,9 +30,6 @@ #define _LARGEFILE64_SOURCE /* enable lseek64() */ -/****************************************************************************** - * INCLUDE SECTION - ******************************************************************************/ #include #include #include @@ -54,22 +52,17 @@ #include "utils.h" #include "gpt-utils.h" - -/****************************************************************************** - * DEFINE SECTION - ******************************************************************************/ -#define BLK_DEV_FILE "/dev/disk/mmcblk0" /* list the names of the backed-up partitions to be swapped */ /* extension used for the backup partitions - tzbak, abootbak, etc. */ -#define BAK_PTN_NAME_EXT "bak" -#define XBL_PRIMARY "/dev/disk/by-partlabel/xbl_a" // FIXME -#define XBL_BACKUP "/dev/disk/by-partlabel/xblbak" -#define XBL_AB_PRIMARY "/dev/disk/by-partlabel/xbl_a" -#define XBL_AB_SECONDARY "/dev/disk/by-partlabel/xbl_b" +#define BAK_PTN_NAME_EXT "bak" +#define XBL_PRIMARY "/dev/disk/by-partlabel/xbl_a" // FIXME +#define XBL_BACKUP "/dev/disk/by-partlabel/xblbak" +#define XBL_AB_PRIMARY "/dev/disk/by-partlabel/xbl_a" +#define XBL_AB_SECONDARY "/dev/disk/by-partlabel/xbl_b" /* GPT defines */ -#define MAX_LUNS 26 +#define MAX_LUNS 26 //Size of the buffer that needs to be passed to the UFS ioctl -#define UFS_ATTR_DATA_SIZE 32 +#define UFS_ATTR_DATA_SIZE 32 //This will allow us to get the root lun path from the path to the partition. //i.e: from /dev/disk/sdaXXX get /dev/disk/sda. The assumption here is that //the boot critical luns lie between sda to sdz which is acceptable because @@ -79,72 +72,72 @@ //From /dev/disk/sda get just sda #define LUN_NAME_START_LOC (sizeof("/dev/") - 1) -#define BOOT_LUN_A_ID 1 -#define BOOT_LUN_B_ID 2 +#define BOOT_LUN_A_ID 1 +#define BOOT_LUN_B_ID 2 /****************************************************************************** * MACROS ******************************************************************************/ - -#define GET_4_BYTES(ptr) ((uint32_t) *((uint8_t *)(ptr)) | \ - ((uint32_t) *((uint8_t *)(ptr) + 1) << 8) | \ - ((uint32_t) *((uint8_t *)(ptr) + 2) << 16) | \ - ((uint32_t) *((uint8_t *)(ptr) + 3) << 24)) - -#define GET_8_BYTES(ptr) ((uint64_t) *((uint8_t *)(ptr)) | \ - ((uint64_t) *((uint8_t *)(ptr) + 1) << 8) | \ - ((uint64_t) *((uint8_t *)(ptr) + 2) << 16) | \ - ((uint64_t) *((uint8_t *)(ptr) + 3) << 24) | \ - ((uint64_t) *((uint8_t *)(ptr) + 4) << 32) | \ - ((uint64_t) *((uint8_t *)(ptr) + 5) << 40) | \ - ((uint64_t) *((uint8_t *)(ptr) + 6) << 48) | \ - ((uint64_t) *((uint8_t *)(ptr) + 7) << 56)) - -#define PUT_4_BYTES(ptr, y) *((uint8_t *)(ptr)) = (y) & 0xff; \ - *((uint8_t *)(ptr) + 1) = ((y) >> 8) & 0xff; \ - *((uint8_t *)(ptr) + 2) = ((y) >> 16) & 0xff; \ - *((uint8_t *)(ptr) + 3) = ((y) >> 24) & 0xff; +#define GET_4_BYTES(ptr) \ + ((uint32_t) * ((uint8_t *)(ptr)) | \ + ((uint32_t) * ((uint8_t *)(ptr) + 1) << 8) | \ + ((uint32_t) * ((uint8_t *)(ptr) + 2) << 16) | \ + ((uint32_t) * ((uint8_t *)(ptr) + 3) << 24)) + +#define GET_8_BYTES(ptr) \ + ((uint64_t) * ((uint8_t *)(ptr)) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 1) << 8) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 2) << 16) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 3) << 24) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 4) << 32) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 5) << 40) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 6) << 48) | \ + ((uint64_t) * ((uint8_t *)(ptr) + 7) << 56)) + +#define PUT_4_BYTES(ptr, y) \ + *((uint8_t *)(ptr)) = (y)&0xff; \ + *((uint8_t *)(ptr) + 1) = ((y) >> 8) & 0xff; \ + *((uint8_t *)(ptr) + 2) = ((y) >> 16) & 0xff; \ + *((uint8_t *)(ptr) + 3) = ((y) >> 24) & 0xff; /****************************************************************************** * TYPES ******************************************************************************/ using namespace std; -enum gpt_state { - GPT_OK = 0, - GPT_BAD_SIGNATURE, - GPT_BAD_CRC -}; +enum gpt_state { GPT_OK = 0, GPT_BAD_SIGNATURE, GPT_BAD_CRC }; //List of LUN's containing boot critical images. //Required in the case of UFS devices struct update_data { - char lun_list[MAX_LUNS][PATH_MAX]; - uint32_t num_valid_entries; + char lun_list[MAX_LUNS][PATH_MAX]; + uint32_t num_valid_entries; }; /****************************************************************************** * FUNCTIONS ******************************************************************************/ -void DumpHex(const void* data, size_t size) { +void DumpHex(const void *data, size_t size) +{ char ascii[17]; size_t i, j; ascii[16] = '\0'; for (i = 0; i < size; ++i) { - printf("%02X ", ((unsigned char*)data)[i]); - if (((unsigned char*)data)[i] >= ' ' && ((unsigned char*)data)[i] <= '~') { - ascii[i % 16] = ((unsigned char*)data)[i]; + printf("%02X ", ((unsigned char *)data)[i]); + if (((unsigned char *)data)[i] >= ' ' && + ((unsigned char *)data)[i] <= '~') { + ascii[i % 16] = ((unsigned char *)data)[i]; } else { ascii[i % 16] = '.'; } - if ((i+1) % 8 == 0 || i+1 == size) { + if ((i + 1) % 8 == 0 || i + 1 == size) { printf(" "); - if ((i+1) % 16 == 0) { + if ((i + 1) % 16 == 0) { printf("| %s \n", ascii); - } else if (i+1 == size) { - ascii[(i+1) % 16] = '\0'; - if ((i+1) % 16 <= 8) { + } else if (i + 1 == size) { + ascii[(i + 1) % 16] = '\0'; + if ((i + 1) % 16 <= 8) { printf(" "); } - for (j = (i+1) % 16; j < 16; ++j) { + for (j = (i + 1) % 16; j < 16; ++j) { printf(" "); } printf("| %s \n", ascii); @@ -153,7 +146,6 @@ void DumpHex(const void* data, size_t size) { } } - /** * ========================================================================== * @@ -171,37 +163,36 @@ void DumpHex(const void* data, size_t size) { */ static int blk_rw(int fd, int rw, uint64_t offset, uint8_t *buf, unsigned len) { - int r; - - if (lseek64(fd, offset, SEEK_SET) < 0) { - fprintf(stderr, "block dev lseek64 %" PRIu64 " failed: %s\n", offset, - strerror(errno)); - return -1; - } + int r; - if (rw) - r = write(fd, buf, len); - else - r = read(fd, buf, len); + if (lseek64(fd, offset, SEEK_SET) < 0) { + fprintf(stderr, "block dev lseek64 %" PRIu64 " failed: %s\n", + offset, strerror(errno)); + return -1; + } - if (r < 0) { - fprintf(stderr, "block dev %s failed: %s\n", rw ? "write" : "read\n", - strerror(errno)); - } else { - if (rw) { - r = fsync(fd); - if (r < 0) - fprintf(stderr, "fsync failed: %s\n", strerror(errno)); - } else { - r = 0; - } - } + if (rw) + r = write(fd, buf, len); + else + r = read(fd, buf, len); + + if (r < 0) { + fprintf(stderr, "block dev %s failed: %s\n", + rw ? "write" : "read\n", strerror(errno)); + } else { + if (rw) { + r = fsync(fd); + if (r < 0) + fprintf(stderr, "fsync failed: %s\n", + strerror(errno)); + } else { + r = 0; + } + } - return r; + return r; } - - /** * ========================================================================== * @@ -218,344 +209,31 @@ static int blk_rw(int fd, int rw, uint64_t offset, uint8_t *buf, unsigned len) * ========================================================================== */ static uint8_t *gpt_pentry_seek(const char *ptn_name, - const uint8_t *pentries_start, - const uint8_t *pentries_end, - uint32_t pentry_size) -{ - char *pentry_name; - unsigned len = strlen(ptn_name); - - for (pentry_name = (char *) (pentries_start + PARTITION_NAME_OFFSET); - pentry_name < (char *) pentries_end; pentry_name += pentry_size) { - char name8[MAX_GPT_NAME_SIZE / 2]; - unsigned i; - - /* Partition names in GPT are UTF-16 - ignoring UTF-16 2nd byte */ - for (i = 0; i < sizeof(name8); i++) - name8[i] = pentry_name[i * 2]; - if (!strncmp(ptn_name, name8, len)) - if (name8[len] == 0 || !strcmp(&name8[len], BAK_PTN_NAME_EXT)) - return (uint8_t *) (pentry_name - PARTITION_NAME_OFFSET); - } - - return NULL; -} - - - -/** - * ========================================================================== - * - * \brief Swaps boot chain in GPT partition entries array - * - * \param [in] pentries_start Partition entries array start - * \param [in] pentries_end Partition entries array end - * \param [in] pentry_size Single partition entry size - * - * \return 0 on success, 1 if no backup partitions found - * - * ========================================================================== - */ -static int gpt_boot_chain_swap(const uint8_t *pentries_start, - const uint8_t *pentries_end, - uint32_t pentry_size) -{ - const char ptn_swap_list[][MAX_GPT_NAME_SIZE] = { PTN_SWAP_LIST }; - - int backup_not_found = 1; - unsigned i; - - for (i = 0; i < ARRAY_SIZE(ptn_swap_list); i++) { - uint8_t *ptn_entry; - uint8_t *ptn_bak_entry; - uint8_t ptn_swap[PTN_ENTRY_SIZE]; - //Skip the xbl partition on UFS devices. That is handled - //seperately. - if (gpt_utils_is_ufs_device() && !strncmp(ptn_swap_list[i], - PTN_XBL, - strlen(PTN_XBL))) - continue; - - ptn_entry = gpt_pentry_seek(ptn_swap_list[i], pentries_start, - pentries_end, pentry_size); - if (ptn_entry == NULL) - continue; - - ptn_bak_entry = gpt_pentry_seek(ptn_swap_list[i], - ptn_entry + pentry_size, pentries_end, pentry_size); - if (ptn_bak_entry == NULL) { - fprintf(stderr, "'%s' partition not backup - skip safe update\n", - ptn_swap_list[i]); - continue; - } - - /* swap primary <-> backup partition entries */ - memcpy(ptn_swap, ptn_entry, PTN_ENTRY_SIZE); - memcpy(ptn_entry, ptn_bak_entry, PTN_ENTRY_SIZE); - memcpy(ptn_bak_entry, ptn_swap, PTN_ENTRY_SIZE); - backup_not_found = 0; - } - - return backup_not_found; -} - - - -/** - * ========================================================================== - * - * \brief Sets secondary GPT boot chain - * - * \param [in] fd block dev file descriptor - * \param [in] boot Boot chain to switch to - * - * \return 0 on success - * - * ========================================================================== - */ -static int gpt2_set_boot_chain(int fd, enum boot_chain boot) + const uint8_t *pentries_start, + const uint8_t *pentries_end, + uint32_t pentry_size) { - int64_t gpt2_header_offset; - uint64_t pentries_start_offset; - uint32_t gpt_header_size; - uint32_t pentry_size; - uint32_t pentries_array_size; - - uint8_t *gpt_header = NULL; - uint8_t *pentries = NULL; - uint32_t crc; - uint32_t blk_size = 0; - int r; - - if (ioctl(fd, BLKSSZGET, &blk_size) != 0) { - fprintf(stderr, "Failed to get GPT device block size: %s\n", - strerror(errno)); - r = -1; - goto EXIT; - } - gpt_header = (uint8_t*)malloc(blk_size); - if (!gpt_header) { - fprintf(stderr, "Failed to allocate memory to hold GPT block\n"); - r = -1; - goto EXIT; - } - gpt2_header_offset = lseek64(fd, 0, SEEK_END) - blk_size; - if (gpt2_header_offset < 0) { - fprintf(stderr, "Getting secondary GPT header offset failed: %s\n", - strerror(errno)); - r = -1; - goto EXIT; - } - - /* Read primary GPT header from block dev */ - r = blk_rw(fd, 0, (uint64_t)blk_size, gpt_header, blk_size); - - if (r) { - fprintf(stderr, "Failed to read primary GPT header from blk dev\n"); - goto EXIT; - } - pentries_start_offset = - GET_8_BYTES(gpt_header + PENTRIES_OFFSET) * blk_size; - pentry_size = GET_4_BYTES(gpt_header + PENTRY_SIZE_OFFSET); - pentries_array_size = - GET_4_BYTES(gpt_header + PARTITION_COUNT_OFFSET) * pentry_size; - - pentries = (uint8_t *) calloc(1, pentries_array_size); - if (pentries == NULL) { - fprintf(stderr, - "Failed to alloc memory for GPT partition entries array\n"); - r = -1; - goto EXIT; - } - /* Read primary GPT partititon entries array from block dev */ - r = blk_rw(fd, 0, pentries_start_offset, pentries, pentries_array_size); - if (r) - goto EXIT; - - crc = crc32(0, pentries, pentries_array_size); - if (GET_4_BYTES(gpt_header + PARTITION_CRC_OFFSET) != crc) { - fprintf(stderr, "Primary GPT partition entries array CRC invalid\n"); - r = -1; - goto EXIT; - } - - /* Read secondary GPT header from block dev */ - r = blk_rw(fd, 0, gpt2_header_offset, gpt_header, blk_size); - if (r) - goto EXIT; - - gpt_header_size = GET_4_BYTES(gpt_header + HEADER_SIZE_OFFSET); - pentries_start_offset = - GET_8_BYTES(gpt_header + PENTRIES_OFFSET) * blk_size; - - if (boot == BACKUP_BOOT) { - r = gpt_boot_chain_swap(pentries, pentries + pentries_array_size, - pentry_size); - if (r) - goto EXIT; - } - - crc = crc32(0, pentries, pentries_array_size); - PUT_4_BYTES(gpt_header + PARTITION_CRC_OFFSET, crc); - - /* header CRC is calculated with this field cleared */ - PUT_4_BYTES(gpt_header + HEADER_CRC_OFFSET, 0); - crc = crc32(0, gpt_header, gpt_header_size); - PUT_4_BYTES(gpt_header + HEADER_CRC_OFFSET, crc); - - /* Write the modified GPT header back to block dev */ - r = blk_rw(fd, 1, gpt2_header_offset, gpt_header, blk_size); - if (!r) - /* Write the modified GPT partititon entries array back to block dev */ - r = blk_rw(fd, 1, pentries_start_offset, pentries, - pentries_array_size); - -EXIT: - if(gpt_header) - free(gpt_header); - if (pentries) - free(pentries); - return r; -} - -/** - * ========================================================================== - * - * \brief Checks GPT state (header signature and CRC) - * - * \param [in] fd block dev file descriptor - * \param [in] gpt GPT header to be checked - * \param [out] state GPT header state - * - * \return 0 on success - * - * ========================================================================== - */ -static int gpt_get_state(int fd, enum gpt_instance gpt, enum gpt_state *state) -{ - int64_t gpt_header_offset; - uint32_t gpt_header_size; - uint8_t *gpt_header = NULL; - uint32_t crc; - uint32_t blk_size = 0; - - *state = GPT_OK; - - if (ioctl(fd, BLKSSZGET, &blk_size) != 0) { - fprintf(stderr, "Failed to get GPT device block size: %s\n", - strerror(errno)); - goto error; - } - gpt_header = (uint8_t*)malloc(blk_size); - if (!gpt_header) { - fprintf(stderr, "gpt_get_state:Failed to alloc memory for header\n"); - goto error; - } - if (gpt == PRIMARY_GPT) - gpt_header_offset = blk_size; - else { - gpt_header_offset = lseek64(fd, 0, SEEK_END) - blk_size; - if (gpt_header_offset < 0) { - fprintf(stderr, "gpt_get_state:Seek to end of GPT part fail\n"); - goto error; - } - } - - if (blk_rw(fd, 0, gpt_header_offset, gpt_header, blk_size)) { - fprintf(stderr, "gpt_get_state: blk_rw failed\n"); - goto error; - } - if (memcmp(gpt_header, GPT_SIGNATURE, sizeof(GPT_SIGNATURE))) - *state = GPT_BAD_SIGNATURE; - gpt_header_size = GET_4_BYTES(gpt_header + HEADER_SIZE_OFFSET); - - crc = GET_4_BYTES(gpt_header + HEADER_CRC_OFFSET); - /* header CRC is calculated with this field cleared */ - PUT_4_BYTES(gpt_header + HEADER_CRC_OFFSET, 0); - if (crc32(0, gpt_header, gpt_header_size) != crc) - *state = GPT_BAD_CRC; - free(gpt_header); - return 0; -error: - if (gpt_header) - free(gpt_header); - return -1; -} - - - -/** - * ========================================================================== - * - * \brief Sets GPT header state (used to corrupt and fix GPT signature) - * - * \param [in] fd block dev file descriptor - * \param [in] gpt GPT header to be checked - * \param [in] state GPT header state to set (GPT_OK or GPT_BAD_SIGNATURE) - * - * \return 0 on success - * - * ========================================================================== - */ -static int gpt_set_state(int fd, enum gpt_instance gpt, enum gpt_state state) -{ - int64_t gpt_header_offset; - uint32_t gpt_header_size; - uint8_t *gpt_header = NULL; - uint32_t crc; - uint32_t blk_size = 0; - - if (ioctl(fd, BLKSSZGET, &blk_size) != 0) { - fprintf(stderr, "Failed to get GPT device block size: %s\n", - strerror(errno)); - goto error; - } - gpt_header = (uint8_t*)malloc(blk_size); - if (!gpt_header) { - fprintf(stderr, "Failed to alloc memory for gpt header\n"); - goto error; - } - if (gpt == PRIMARY_GPT) - gpt_header_offset = blk_size; - else { - gpt_header_offset = lseek64(fd, 0, SEEK_END) - blk_size; - if (gpt_header_offset < 0) { - fprintf(stderr, "Failed to seek to end of GPT device\n"); - goto error; - } - } - if (blk_rw(fd, 0, gpt_header_offset, gpt_header, blk_size)) { - fprintf(stderr, "Failed to r/w gpt header\n"); - goto error; - } - if (state == GPT_OK) - memcpy(gpt_header, GPT_SIGNATURE, sizeof(GPT_SIGNATURE)); - else if (state == GPT_BAD_SIGNATURE) - *gpt_header = 0; - else { - fprintf(stderr, "gpt_set_state: Invalid state\n"); - goto error; - } - - gpt_header_size = GET_4_BYTES(gpt_header + HEADER_SIZE_OFFSET); - - /* header CRC is calculated with this field cleared */ - PUT_4_BYTES(gpt_header + HEADER_CRC_OFFSET, 0); - crc = crc32(0, gpt_header, gpt_header_size); - PUT_4_BYTES(gpt_header + HEADER_CRC_OFFSET, crc); + char *pentry_name; + unsigned len = strlen(ptn_name); + + for (pentry_name = (char *)(pentries_start + PARTITION_NAME_OFFSET); + pentry_name < (char *)pentries_end; pentry_name += pentry_size) { + char name8[MAX_GPT_NAME_SIZE / 2]; + unsigned i; + + /* Partition names in GPT are UTF-16 - ignoring UTF-16 2nd byte */ + for (i = 0; i < sizeof(name8); i++) + name8[i] = pentry_name[i * 2]; + if (!strncmp(ptn_name, name8, len)) + if (name8[len] == 0 || + !strcmp(&name8[len], BAK_PTN_NAME_EXT)) + return (uint8_t *)(pentry_name - + PARTITION_NAME_OFFSET); + } - if (blk_rw(fd, 1, gpt_header_offset, gpt_header, blk_size)) { - fprintf(stderr, "gpt_set_state: blk write failed\n"); - goto error; - } - return 0; -error: - if(gpt_header) - free(gpt_header); - return -1; + return NULL; } - // Defined in ufs-bsg.cpp int32_t set_boot_lun(uint8_t lun_id); @@ -578,388 +256,98 @@ int32_t set_boot_lun(uint8_t lun_id); //the boot lun to either LUNA or LUNB int gpt_utils_set_xbl_boot_partition(enum boot_chain chain) { - struct stat st; - uint8_t boot_lun_id = 0; - const char *boot_dev = NULL; - - (void)st; - (void)boot_dev; - - if (chain == BACKUP_BOOT) { - boot_lun_id = BOOT_LUN_B_ID; - if (!stat(XBL_BACKUP, &st)) - boot_dev = XBL_BACKUP; - else if (!stat(XBL_AB_SECONDARY, &st)) - boot_dev = XBL_AB_SECONDARY; - else { - fprintf(stderr, "%s: Failed to locate secondary xbl\n", - __func__); - goto error; - } - } else if (chain == NORMAL_BOOT) { - boot_lun_id = BOOT_LUN_A_ID; - if (!stat(XBL_PRIMARY, &st)) - boot_dev = XBL_PRIMARY; - else if (!stat(XBL_AB_PRIMARY, &st)) - boot_dev = XBL_AB_PRIMARY; - else { - fprintf(stderr, "%s: Failed to locate primary xbl\n", - __func__); - goto error; - } - } else { - fprintf(stderr, "%s: Invalid boot chain id\n", __func__); - goto error; - } - //We need either both xbl and xblbak or both xbl_a and xbl_b to exist at - //the same time. If not the current configuration is invalid. - if((stat(XBL_PRIMARY, &st) || - stat(XBL_BACKUP, &st)) && - (stat(XBL_AB_PRIMARY, &st) || - stat(XBL_AB_SECONDARY, &st))) { - fprintf(stderr, "%s:primary/secondary XBL prt not found(%s)\n", - __func__, - strerror(errno)); - goto error; - } - LOGD("%s: setting %s lun as boot lun\n", __func__, - boot_dev); + struct stat st; + uint8_t boot_lun_id = 0; + const char *boot_dev = NULL; + + (void)st; + (void)boot_dev; + + if (chain == BACKUP_BOOT) { + boot_lun_id = BOOT_LUN_B_ID; + if (!stat(XBL_BACKUP, &st)) + boot_dev = XBL_BACKUP; + else if (!stat(XBL_AB_SECONDARY, &st)) + boot_dev = XBL_AB_SECONDARY; + else { + fprintf(stderr, "%s: Failed to locate secondary xbl\n", + __func__); + goto error; + } + } else if (chain == NORMAL_BOOT) { + boot_lun_id = BOOT_LUN_A_ID; + if (!stat(XBL_PRIMARY, &st)) + boot_dev = XBL_PRIMARY; + else if (!stat(XBL_AB_PRIMARY, &st)) + boot_dev = XBL_AB_PRIMARY; + else { + fprintf(stderr, "%s: Failed to locate primary xbl\n", + __func__); + goto error; + } + } else { + fprintf(stderr, "%s: Invalid boot chain id\n", __func__); + goto error; + } + //We need either both xbl and xblbak or both xbl_a and xbl_b to exist at + //the same time. If not the current configuration is invalid. + if ((stat(XBL_PRIMARY, &st) || stat(XBL_BACKUP, &st)) && + (stat(XBL_AB_PRIMARY, &st) || stat(XBL_AB_SECONDARY, &st))) { + fprintf(stderr, "%s:primary/secondary XBL prt not found(%s)\n", + __func__, strerror(errno)); + goto error; + } + LOGD("%s: setting %s lun as boot lun\n", __func__, boot_dev); - if (set_boot_lun(boot_lun_id)) { - fprintf(stderr, "%s: Failed to set xblbak as boot partition\n", - __func__); - goto error; - } - return 0; + if (set_boot_lun(boot_lun_id)) { + fprintf(stderr, "%s: Failed to set xblbak as boot partition\n", + __func__); + goto error; + } + return 0; error: - return -1; -} - -int gpt_utils_is_ufs_device() -{ - return 1; // Stubbed to "true" because we dont' support emmc for now -// char bootdevice[PROPERTY_VALUE_MAX] = {0}; -// property_get("ro.boot.bootdevice\n", bootdevice, "N/A"); -// if (strlen(bootdevice) < strlen(".ufshc") + 1) -// return 0; -// return (!strncmp(&bootdevice[strlen(bootdevice) - strlen(".ufshc")], -// ".ufshc\n", -// sizeof(".ufshc"))); -} -//dev_path is the path to the block device that contains the GPT image that -//needs to be updated. This would be the device which holds one or more critical -//boot partitions and their backups. In the case of EMMC this function would -//be invoked only once on /dev/disk/mmcblk1 since it holds the GPT image -//containing all the partitions For UFS devices it could potentially be -//invoked multiple times, once for each LUN containing critical image(s) and -//their backups -int prepare_partitions(enum boot_update_stage stage, const char *dev_path) -{ - int r = 0; - int fd = -1; - int is_ufs = gpt_utils_is_ufs_device(); - enum gpt_state gpt_prim, gpt_second = GPT_OK; - enum boot_update_stage internal_stage; - struct stat xbl_partition_stat; - - if (!dev_path) { - fprintf(stderr, "%s: Invalid dev_path\n", - __func__); - r = -1; - goto EXIT; - } - fd = open(dev_path, O_RDWR); - if (fd < 0) { - fprintf(stderr, "%s: Opening '%s' failed: %s\n", - __func__, - BLK_DEV_FILE, - strerror(errno)); - r = -1; - goto EXIT; - } - r = gpt_get_state(fd, PRIMARY_GPT, &gpt_prim) || - gpt_get_state(fd, SECONDARY_GPT, &gpt_second); - if (r) { - fprintf(stderr, "%s: Getting GPT headers state failed\n", - __func__); - goto EXIT; - } - - /* These 2 combinations are unexpected and unacceptable */ - if (gpt_prim == GPT_BAD_CRC || gpt_second == GPT_BAD_CRC) { - fprintf(stderr, "%s: GPT headers CRC corruption detected, aborting\n", - __func__); - r = -1; - goto EXIT; - } - if (gpt_prim == GPT_BAD_SIGNATURE && gpt_second == GPT_BAD_SIGNATURE) { - fprintf(stderr, "%s: Both GPT headers corrupted, aborting\n", - __func__); - r = -1; - goto EXIT; - } - - /* Check internal update stage according GPT headers' state */ - if (gpt_prim == GPT_OK && gpt_second == GPT_OK) - internal_stage = UPDATE_MAIN; - else if (gpt_prim == GPT_BAD_SIGNATURE) - internal_stage = UPDATE_BACKUP; - else if (gpt_second == GPT_BAD_SIGNATURE) - internal_stage = UPDATE_FINALIZE; - else { - fprintf(stderr, "%s: Abnormal GPTs state: primary (%d), secondary (%d), " - "aborting\n", __func__, gpt_prim, gpt_second); - r = -1; - goto EXIT; - } - - /* Stage already set - ready for update, exitting */ - if ((int) stage == (int) internal_stage - 1) - goto EXIT; - /* Unexpected stage given */ - if (stage != internal_stage) { - r = -1; - goto EXIT; - } - - switch (stage) { - case UPDATE_MAIN: - if (is_ufs) { - if(stat(XBL_PRIMARY, &xbl_partition_stat)|| - stat(XBL_BACKUP, &xbl_partition_stat)){ - //Non fatal error. Just means this target does not - //use XBL but relies on sbl whose update is handled - //by the normal methods. - fprintf(stderr, "%s: xbl part not found(%s).Assuming sbl in use\n", - __func__, - strerror(errno)); - } else { - //Switch the boot lun so that backup boot LUN is used - r = gpt_utils_set_xbl_boot_partition(BACKUP_BOOT); - if(r){ - fprintf(stderr, "%s: Failed to set xbl backup partition as boot\n", - __func__); - goto EXIT; - } - } - } - //Fix up the backup GPT table so that it actually points to - //the backup copy of the boot critical images - fprintf(stderr, "%s: Preparing for primary partition update\n", - __func__); - r = gpt2_set_boot_chain(fd, BACKUP_BOOT); - if (r) { - if (r < 0) - fprintf(stderr, - "%s: Setting secondary GPT to backup boot failed\n", - __func__); - /* No backup partitions - do not corrupt GPT, do not flag error */ - else - r = 0; - goto EXIT; - } - //corrupt the primary GPT so that the backup(which now points to - //the backup boot partitions is used) - r = gpt_set_state(fd, PRIMARY_GPT, GPT_BAD_SIGNATURE); - if (r) { - fprintf(stderr, "%s: Corrupting primary GPT header failed\n", - __func__); - goto EXIT; - } - break; - case UPDATE_BACKUP: - if (is_ufs) { - if(stat(XBL_PRIMARY, &xbl_partition_stat)|| - stat(XBL_BACKUP, &xbl_partition_stat)){ - //Non fatal error. Just means this target does not - //use XBL but relies on sbl whose update is handled - //by the normal methods. - fprintf(stderr, "%s: xbl part not found(%s).Assuming sbl in use\n", - __func__, - strerror(errno)); - } else { - //Switch the boot lun so that backup boot LUN is used - r = gpt_utils_set_xbl_boot_partition(NORMAL_BOOT); - if(r) { - fprintf(stderr, "%s: Failed to set xbl backup partition as boot\n", - __func__); - goto EXIT; - } - } - } - //Fix the primary GPT header so that is used - fprintf(stderr, "%s: Preparing for backup partition update\n", - __func__); - r = gpt_set_state(fd, PRIMARY_GPT, GPT_OK); - if (r) { - fprintf(stderr, "%s: Fixing primary GPT header failed\n", - __func__); - goto EXIT; - } - //Corrupt the scondary GPT header - r = gpt_set_state(fd, SECONDARY_GPT, GPT_BAD_SIGNATURE); - if (r) { - fprintf(stderr, "%s: Corrupting secondary GPT header failed\n", - __func__); - goto EXIT; - } - break; - case UPDATE_FINALIZE: - //Undo the changes we had made in the UPDATE_MAIN stage so that the - //primary/backup GPT headers once again point to the same set of - //partitions - fprintf(stderr, "%s: Finalizing partitions\n", - __func__); - r = gpt2_set_boot_chain(fd, NORMAL_BOOT); - if (r < 0) { - fprintf(stderr, "%s: Setting secondary GPT to normal boot failed\n", - __func__); - goto EXIT; - } - - r = gpt_set_state(fd, SECONDARY_GPT, GPT_OK); - if (r) { - fprintf(stderr, "%s: Fixing secondary GPT header failed\n", - __func__); - goto EXIT; - } - break; - default:; - } - -EXIT: - if (fd >= 0) { - fsync(fd); - close(fd); - } - return r; + return -1; } int add_lun_to_update_list(char *lun_path, struct update_data *dat) { - uint32_t i = 0; - struct stat st; - if (!lun_path || !dat){ - fprintf(stderr, "%s: Invalid data\n", - __func__); - return -1; - } - if (stat(lun_path, &st)) { - fprintf(stderr, "%s: Unable to access %s. Skipping adding to list\n", - __func__, - lun_path); - return -1; - } - if (dat->num_valid_entries == 0) { - fprintf(stderr, "%s: Copying %s into lun_list[%d]\n", - __func__, - lun_path, - i); - strlcpy(dat->lun_list[0], lun_path, - PATH_MAX * sizeof(char)); - dat->num_valid_entries = 1; - } else { - for (i = 0; (i < dat->num_valid_entries) && - (dat->num_valid_entries < MAX_LUNS - 1); i++) { - //Check if the current LUN is not already part - //of the lun list - if (!strncmp(lun_path,dat->lun_list[i], - strlen(dat->lun_list[i]))) { - //LUN already in list..Return - return 0; - } - } - fprintf(stderr, "%s: Copying %s into lun_list[%d]\n", - __func__, - lun_path, - dat->num_valid_entries); - //Add LUN path lun list - strlcpy(dat->lun_list[dat->num_valid_entries], lun_path, - PATH_MAX * sizeof(char)); - dat->num_valid_entries++; - } - return 0; -} - -int prepare_boot_update(enum boot_update_stage stage) -{ - int is_ufs = gpt_utils_is_ufs_device(); - struct stat ufs_dir_stat; - struct update_data data; - int rcode = 0; - uint32_t i = 0; - int is_error = 0; - const char ptn_swap_list[][MAX_GPT_NAME_SIZE] = { PTN_SWAP_LIST }; - //Holds /dev/disk/bootdevice/by-name/*bak entry - char buf[PATH_MAX] = {0}; - //Holds the resolved path of the symlink stored in buf - char real_path[PATH_MAX] = {0}; - - if (!is_ufs) { - //emmc device. Just pass in path to mmcblk0 - return prepare_partitions(stage, BLK_DEV_FILE); - } else { - //Now we need to find the list of LUNs over - //which the boot critical images are spread - //and set them up for failsafe updates.To do - //this we find out where the symlinks for the - //each of the paths under - ///dev/disk/bootdevice/by-name/PTN_SWAP_LIST - //actually point to. - fprintf(stderr, "%s: Running on a UFS device\n", - __func__); - memset(&data, '\0', sizeof(struct update_data)); - for (i=0; i < ARRAY_SIZE(ptn_swap_list); i++) { - //XBL on UFS does not follow the convention - //of being loaded based on well known GUID'S. - //We take care of switching the UFS boot LUN - //explicitly later on. - if (!strncmp(ptn_swap_list[i], - PTN_XBL, - strlen(PTN_XBL))) - continue; - snprintf(buf, sizeof(buf), - "%s/%sbak\n", - BOOT_DEV_DIR, - ptn_swap_list[i]); - if (stat(buf, &ufs_dir_stat)) { - continue; - } - if (!realpath(buf, real_path)) - { - fprintf(stderr, "%s: realpath error. Skipping %s\n", - __func__, - strerror(errno)); - } else { - if(strlen(real_path) < PATH_TRUNCATE_LOC + 1){ - fprintf(stderr, "Unknown path.Skipping :%s:\n", - real_path); - } else { - real_path[PATH_TRUNCATE_LOC] = '\0'; - add_lun_to_update_list(real_path, &data); - } - } - memset(buf, '\0', sizeof(buf)); - memset(real_path, '\0', sizeof(real_path)); - } - for (i=0; i < data.num_valid_entries; i++) { - fprintf(stderr, "%s: Preparing %s for update stage %d\n", - __func__, - data.lun_list[i], - stage); - rcode = prepare_partitions(stage, data.lun_list[i]); - if (rcode != 0) - { - fprintf(stderr, "%s: Failed to prepare %s.Continuing..\n", - __func__, - data.lun_list[i]); - is_error = 1; - } - } - } - if (is_error) - return -1; - return 0; + uint32_t i = 0; + struct stat st; + if (!lun_path || !dat) { + fprintf(stderr, "%s: Invalid data\n", __func__); + return -1; + } + if (stat(lun_path, &st)) { + fprintf(stderr, + "%s: Unable to access %s. Skipping adding to list\n", + __func__, lun_path); + return -1; + } + if (dat->num_valid_entries == 0) { + fprintf(stderr, "%s: Copying %s into lun_list[%d]\n", __func__, + lun_path, i); + strlcpy(dat->lun_list[0], lun_path, PATH_MAX * sizeof(char)); + dat->num_valid_entries = 1; + } else { + for (i = 0; (i < dat->num_valid_entries) && + (dat->num_valid_entries < MAX_LUNS - 1); + i++) { + //Check if the current LUN is not already part + //of the lun list + if (!strncmp(lun_path, dat->lun_list[i], + strlen(dat->lun_list[i]))) { + //LUN already in list..Return + return 0; + } + } + fprintf(stderr, "%s: Copying %s into lun_list[%d]\n", __func__, + lun_path, dat->num_valid_entries); + //Add LUN path lun list + strlcpy(dat->lun_list[dat->num_valid_entries], lun_path, + PATH_MAX * sizeof(char)); + dat->num_valid_entries++; + } + return 0; } //Given a parttion name(eg: rpm) get the path to the block device that @@ -967,419 +355,392 @@ int prepare_boot_update(enum boot_update_stage stage) //would be the default emmc dev(/dev/mmcblk0). In the case of UFS we look //through the /dev/disk/bootdevice/by-name/ tree for partname, and resolve //the path to the LUN from there. -static int get_dev_path_from_partition_name(const char *partname, - char *buf, - size_t buflen) +static int get_dev_path_from_partition_name(const char *partname, char *buf, + size_t buflen) { - struct stat st; - char path[PATH_MAX] = {0}; + struct stat st; + char path[PATH_MAX] = { 0 }; - (void)st; + (void)st; - if (!partname || !buf || buflen < ((PATH_TRUNCATE_LOC) + 1)) { - fprintf(stderr, "%s: Invalid argument\n", __func__); - return -1; - } - if (gpt_utils_is_ufs_device()) { - //Need to find the lun that holds partition partname - snprintf(path, sizeof(path), - "%s/%s", - BOOT_DEV_DIR, - partname); - // if (rc = stat(path, &st)) { - // LOGD("stat failed: errno=%d\n", errno); - // goto error; - // } - buf = realpath(path, buf); - if (!buf) - { - return -1; - } else { - buf[PATH_TRUNCATE_LOC] = '\0'; - } - } else { - snprintf(buf, buflen, "/dev/mmcblk0"); - } - return 0; + if (!partname || !buf || buflen < ((PATH_TRUNCATE_LOC) + 1)) { + fprintf(stderr, "%s: Invalid argument\n", __func__); + return -1; + } + //Need to find the lun that holds partition partname + snprintf(path, sizeof(path), "%s/%s", BOOT_DEV_DIR, partname); + // if (rc = stat(path, &st)) { + // LOGD("stat failed: errno=%d\n", errno); + // goto error; + // } + buf = realpath(path, buf); + if (!buf) { + return -1; + } else { + buf[PATH_TRUNCATE_LOC] = '\0'; + } + return 0; } -int gpt_utils_get_partition_map(vector& ptn_list, - map>& partition_map) { - char devpath[PATH_MAX] = {'\0'}; - map>::iterator it; - if (ptn_list.size() < 1) { - fprintf(stderr, "%s: Invalid ptn list\n", __func__); - return -1; - } - //Go through the passed in list - for (uint32_t i = 0; i < ptn_list.size(); i++) - { - //Key in the map is the path to the device that holds the - //partition - if (get_dev_path_from_partition_name(ptn_list[i].c_str(), - devpath, - sizeof(devpath))) { - //Not necessarily an error. The partition may just - //not be present. - continue; - } - string path = devpath; - it = partition_map.find(path); - if (it != partition_map.end()) { - it->second.push_back(ptn_list[i]); - } else { - vector str_vec; - str_vec.push_back( ptn_list[i]); - partition_map.insert(pair> - (path, str_vec)); - } - memset(devpath, '\0', sizeof(devpath)); - } - return 0; +int gpt_utils_get_partition_map(vector &ptn_list, + map > &partition_map) +{ + char devpath[PATH_MAX] = { '\0' }; + map >::iterator it; + if (ptn_list.size() < 1) { + fprintf(stderr, "%s: Invalid ptn list\n", __func__); + return -1; + } + //Go through the passed in list + for (uint32_t i = 0; i < ptn_list.size(); i++) { + //Key in the map is the path to the device that holds the + //partition + if (get_dev_path_from_partition_name( + ptn_list[i].c_str(), devpath, sizeof(devpath))) { + //Not necessarily an error. The partition may just + //not be present. + continue; + } + string path = devpath; + it = partition_map.find(path); + if (it != partition_map.end()) { + it->second.push_back(ptn_list[i]); + } else { + vector str_vec; + str_vec.push_back(ptn_list[i]); + partition_map.insert( + pair >(path, str_vec)); + } + memset(devpath, '\0', sizeof(devpath)); + } + return 0; } //Get the block size of the disk represented by decsriptor fd static uint32_t gpt_get_block_size(int fd) { - uint32_t block_size = 0; - if (fd < 0) { - fprintf(stderr, "%s: invalid descriptor\n", - __func__); - goto error; - } - if (ioctl(fd, BLKSSZGET, &block_size) != 0) { - fprintf(stderr, "%s: Failed to get GPT dev block size : %s\n", - __func__, - strerror(errno)); - goto error; - } - return block_size; + uint32_t block_size = 0; + if (fd < 0) { + fprintf(stderr, "%s: invalid descriptor\n", __func__); + goto error; + } + if (ioctl(fd, BLKSSZGET, &block_size) != 0) { + fprintf(stderr, "%s: Failed to get GPT dev block size : %s\n", + __func__, strerror(errno)); + goto error; + } + return block_size; error: - return 0; + return 0; } //Write the GPT header present in the passed in buffer back to the //disk represented by fd static int gpt_set_header(uint8_t *gpt_header, int fd, - enum gpt_instance instance) + enum gpt_instance instance) { - uint32_t block_size = 0; - off_t gpt_header_offset = 0; - if (!gpt_header || fd < 0) { - fprintf(stderr, "%s: Invalid arguments\n", - __func__); - goto error; - } - block_size = gpt_get_block_size(fd); - LOGD("%s: Block size is : %d\n", __func__, block_size); - if (block_size == 0) { - fprintf(stderr, "%s: Failed to get block size\n", __func__); - goto error; - } - if (instance == PRIMARY_GPT) - gpt_header_offset = block_size; - else - gpt_header_offset = lseek64(fd, 0, SEEK_END) - block_size; - if (gpt_header_offset <= 0) { - fprintf(stderr, "%s: Failed to get gpt header offset\n",__func__); - goto error; - } - LOGD("%s: Writing back header to offset %ld\n", __func__, - gpt_header_offset); - if (blk_rw(fd, 1, gpt_header_offset, gpt_header, block_size)) { - fprintf(stderr, "%s: Failed to write back GPT header\n", __func__); - goto error; - } - return 0; + uint32_t block_size = 0; + off_t gpt_header_offset = 0; + if (!gpt_header || fd < 0) { + fprintf(stderr, "%s: Invalid arguments\n", __func__); + goto error; + } + block_size = gpt_get_block_size(fd); + LOGD("%s: Block size is : %d\n", __func__, block_size); + if (block_size == 0) { + fprintf(stderr, "%s: Failed to get block size\n", __func__); + goto error; + } + if (instance == PRIMARY_GPT) + gpt_header_offset = block_size; + else + gpt_header_offset = lseek64(fd, 0, SEEK_END) - block_size; + if (gpt_header_offset <= 0) { + fprintf(stderr, "%s: Failed to get gpt header offset\n", + __func__); + goto error; + } + LOGD("%s: Writing back header to offset %ld\n", __func__, + gpt_header_offset); + if (blk_rw(fd, 1, gpt_header_offset, gpt_header, block_size)) { + fprintf(stderr, "%s: Failed to write back GPT header\n", + __func__); + goto error; + } + return 0; error: - return -1; + return -1; } //Read out the GPT header for the disk that contains the partition partname -static uint8_t* gpt_get_header(const char *partname, enum gpt_instance instance) +static uint8_t *gpt_get_header(const char *partname, enum gpt_instance instance) { - uint8_t* hdr = NULL; - char devpath[PATH_MAX] = {0}; - uint64_t hdr_offset = 0; - uint32_t block_size = 0; - int fd = -1; - if (!partname) { - fprintf(stderr, "%s: Invalid partition name\n", __func__); - goto error; - } - if (get_dev_path_from_partition_name(partname, devpath, sizeof(devpath)) - != 0) { - fprintf(stderr, "%s: Failed to resolve path for %s\n", - __func__, - partname); - goto error; - } - fd = open(devpath, O_RDWR); - if (fd < 0) { - fprintf(stderr, "%s: Failed to open %s : %s\n", - __func__, - devpath, - strerror(errno)); - goto error; - } - block_size = gpt_get_block_size(fd); - if (block_size == 0) - { - fprintf(stderr, "%s: Failed to get gpt block size for %s\n", - __func__, - partname); - goto error; - } + uint8_t *hdr = NULL; + char devpath[PATH_MAX] = { 0 }; + uint64_t hdr_offset = 0; + uint32_t block_size = 0; + int fd = -1; + if (!partname) { + fprintf(stderr, "%s: Invalid partition name\n", __func__); + goto error; + } + if (get_dev_path_from_partition_name(partname, devpath, + sizeof(devpath)) != 0) { + fprintf(stderr, "%s: Failed to resolve path for %s\n", __func__, + partname); + goto error; + } + fd = open(devpath, O_RDWR); + if (fd < 0) { + fprintf(stderr, "%s: Failed to open %s : %s\n", __func__, + devpath, strerror(errno)); + goto error; + } + block_size = gpt_get_block_size(fd); + if (block_size == 0) { + fprintf(stderr, "%s: Failed to get gpt block size for %s\n", + __func__, partname); + goto error; + } - hdr = (uint8_t*)calloc(block_size, 1); - if (!hdr) { - fprintf(stderr, "%s: Failed to allocate memory for gpt header\n", - __func__); - } - if (instance == PRIMARY_GPT) - hdr_offset = block_size; - else { - hdr_offset = lseek64(fd, 0, SEEK_END) - block_size; - } - if (hdr_offset < 0) { - fprintf(stderr, "%s: Failed to get gpt header offset\n", - __func__); - goto error; - } - if (blk_rw(fd, 0, hdr_offset, hdr, block_size)) { - fprintf(stderr, "%s: Failed to read GPT header from device\n", - __func__); - goto error; - } - //DumpHex(hdr, block_size); - close(fd); - return hdr; + hdr = (uint8_t *)calloc(block_size, 1); + if (!hdr) { + fprintf(stderr, + "%s: Failed to allocate memory for gpt header\n", + __func__); + } + if (instance == PRIMARY_GPT) + hdr_offset = block_size; + else { + hdr_offset = lseek64(fd, 0, SEEK_END) - block_size; + } + if (hdr_offset < 0) { + fprintf(stderr, "%s: Failed to get gpt header offset\n", + __func__); + goto error; + } + if (blk_rw(fd, 0, hdr_offset, hdr, block_size)) { + fprintf(stderr, "%s: Failed to read GPT header from device\n", + __func__); + goto error; + } + //DumpHex(hdr, block_size); + close(fd); + return hdr; error: - if (fd >= 0) - close(fd); - if (hdr) - free(hdr); - return NULL; + if (fd >= 0) + close(fd); + if (hdr) + free(hdr); + return NULL; } //Returns the partition entry array based on the //passed in buffer which contains the gpt header. //The fd here is the descriptor for the 'disk' which //holds the partition -static uint8_t* gpt_get_pentry_arr(uint8_t *hdr, int fd) +static uint8_t *gpt_get_pentry_arr(uint8_t *hdr, int fd) { - uint64_t pentries_start = 0; - uint32_t pentry_size = 0; - uint32_t block_size = 0; - uint32_t pentries_arr_size = 0; - uint8_t *pentry_arr = NULL; - int rc = 0; - if (!hdr) { - fprintf(stderr, "%s: Invalid header\n", __func__); - goto error; - } - if (fd < 0) { - fprintf(stderr, "%s: Invalid fd\n", __func__); - goto error; - } - block_size = gpt_get_block_size(fd); - if (!block_size) { - fprintf(stderr, "%s: Failed to get gpt block size for\n", - __func__); - goto error; - } - pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; - pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); - pentries_arr_size = - GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; - pentry_arr = (uint8_t*)calloc(1, pentries_arr_size); - if (!pentry_arr) { - fprintf(stderr, "%s: Failed to allocate memory for partition array\n", - __func__); - goto error; - } - rc = blk_rw(fd, 0, - pentries_start, - pentry_arr, - pentries_arr_size); - if (rc) { - fprintf(stderr, "%s: Failed to read partition entry array\n", - __func__); - goto error; - } - return pentry_arr; + uint64_t pentries_start = 0; + uint32_t pentry_size = 0; + uint32_t block_size = 0; + uint32_t pentries_arr_size = 0; + uint8_t *pentry_arr = NULL; + int rc = 0; + if (!hdr) { + fprintf(stderr, "%s: Invalid header\n", __func__); + goto error; + } + if (fd < 0) { + fprintf(stderr, "%s: Invalid fd\n", __func__); + goto error; + } + block_size = gpt_get_block_size(fd); + if (!block_size) { + fprintf(stderr, "%s: Failed to get gpt block size for\n", + __func__); + goto error; + } + pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; + pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); + pentries_arr_size = + GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; + pentry_arr = (uint8_t *)calloc(1, pentries_arr_size); + if (!pentry_arr) { + fprintf(stderr, + "%s: Failed to allocate memory for partition array\n", + __func__); + goto error; + } + rc = blk_rw(fd, 0, pentries_start, pentry_arr, pentries_arr_size); + if (rc) { + fprintf(stderr, "%s: Failed to read partition entry array\n", + __func__); + goto error; + } + return pentry_arr; error: - if (pentry_arr) - free(pentry_arr); - return NULL; + if (pentry_arr) + free(pentry_arr); + return NULL; } -static int gpt_set_pentry_arr(uint8_t *hdr, int fd, uint8_t* arr) +static int gpt_set_pentry_arr(uint8_t *hdr, int fd, uint8_t *arr) { - uint32_t block_size = 0; - uint64_t pentries_start = 0; - uint32_t pentry_size = 0; - uint32_t pentries_arr_size = 0; - int rc = 0; - if (!hdr || fd < 0 || !arr) { - fprintf(stderr, "%s: Invalid argument\n", __func__); - goto error; - } - block_size = gpt_get_block_size(fd); - if (!block_size) { - fprintf(stderr, "%s: Failed to get gpt block size for\n", - __func__); - goto error; - } - LOGD("%s : Block size is %d\n", __func__, block_size); - pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; - pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); - pentries_arr_size = - GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; - LOGD("%s: Writing partition entry array of size %d to offset %" PRIu64 "\n", - __func__, - pentries_arr_size, - pentries_start); - LOGD("pentries_start: %lu\n", pentries_start); - rc = blk_rw(fd, 1, - pentries_start, - arr, - pentries_arr_size); - if (rc) { - fprintf(stderr, "%s: Failed to read partition entry array\n", - __func__); - goto error; - } - return 0; + uint32_t block_size = 0; + uint64_t pentries_start = 0; + uint32_t pentry_size = 0; + uint32_t pentries_arr_size = 0; + int rc = 0; + if (!hdr || fd < 0 || !arr) { + fprintf(stderr, "%s: Invalid argument\n", __func__); + goto error; + } + block_size = gpt_get_block_size(fd); + if (!block_size) { + fprintf(stderr, "%s: Failed to get gpt block size for\n", + __func__); + goto error; + } + LOGD("%s : Block size is %d\n", __func__, block_size); + pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; + pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); + pentries_arr_size = + GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; + LOGD("%s: Writing partition entry array of size %d to offset %" PRIu64 + "\n", + __func__, pentries_arr_size, pentries_start); + LOGD("pentries_start: %lu\n", pentries_start); + rc = blk_rw(fd, 1, pentries_start, arr, pentries_arr_size); + if (rc) { + fprintf(stderr, "%s: Failed to read partition entry array\n", + __func__); + goto error; + } + return 0; error: - return -1; + return -1; } - - //Allocate a handle used by calls to the "gpt_disk" api's -struct gpt_disk * gpt_disk_alloc() +struct gpt_disk *gpt_disk_alloc() { - struct gpt_disk *disk; - disk = (struct gpt_disk *)malloc(sizeof(struct gpt_disk)); - if (!disk) { - fprintf(stderr, "%s: Failed to allocate memory\n", __func__); - goto end; - } - memset(disk, 0, sizeof(struct gpt_disk)); + struct gpt_disk *disk; + disk = (struct gpt_disk *)malloc(sizeof(struct gpt_disk)); + if (!disk) { + fprintf(stderr, "%s: Failed to allocate memory\n", __func__); + goto end; + } + memset(disk, 0, sizeof(struct gpt_disk)); end: - return disk; + return disk; } //Free previously allocated/initialized handle void gpt_disk_free(struct gpt_disk *disk) { - if (!disk) - return; - if (disk->hdr) - free(disk->hdr); - if (disk->hdr_bak) - free(disk->hdr_bak); - if (disk->pentry_arr) - free(disk->pentry_arr); - if (disk->pentry_arr_bak) - free(disk->pentry_arr_bak); - free(disk); - return; + if (!disk) + return; + if (disk->hdr) + free(disk->hdr); + if (disk->hdr_bak) + free(disk->hdr_bak); + if (disk->pentry_arr) + free(disk->pentry_arr); + if (disk->pentry_arr_bak) + free(disk->pentry_arr_bak); + free(disk); + return; } //fills up the passed in gpt_disk struct with information about the //disk represented by path dev. Returns 0 on success and -1 on error. int gpt_disk_get_disk_info(const char *dev, struct gpt_disk *dsk) { - struct gpt_disk *disk = NULL; - int fd = -1; - uint32_t gpt_header_size = 0; - - if (!dsk || !dev) { - fprintf(stderr, "%s: Invalid arguments\n", __func__); - goto error; - } - disk = dsk; - disk->hdr = gpt_get_header(dev, PRIMARY_GPT); - if (!disk->hdr) { - fprintf(stderr, "%s: Failed to get primary header\n", __func__); - goto error; - } - gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); - // FIXME: pointer offsets crc bleh - disk->hdr_crc = crc32(0, disk->hdr, gpt_header_size); - disk->hdr_bak = gpt_get_header(dev, PRIMARY_GPT); - if (!disk->hdr_bak) { - fprintf(stderr, "%s: Failed to get backup header\n", __func__); - goto error; - } - disk->hdr_bak_crc = crc32(0, disk->hdr_bak, gpt_header_size); + struct gpt_disk *disk = NULL; + int fd = -1; + uint32_t gpt_header_size = 0; - //Descriptor for the block device. We will use this for further - //modifications to the partition table - if (get_dev_path_from_partition_name(dev, - disk->devpath, - sizeof(disk->devpath)) != 0) { - fprintf(stderr, "%s: Failed to resolve path for %s\n", - __func__, - dev); - goto error; - } - fd = open(disk->devpath, O_RDWR); - if (fd < 0) { - fprintf(stderr, "%s: Failed to open %s: %s\n", - __func__, - disk->devpath, - strerror(errno)); - goto error; - } - disk->pentry_arr = gpt_get_pentry_arr(disk->hdr, fd); - if (!disk->pentry_arr) { - fprintf(stderr, "%s: Failed to obtain partition entry array\n", - __func__); - goto error; - } - disk->pentry_arr_bak = gpt_get_pentry_arr(disk->hdr_bak, fd); - if (!disk->pentry_arr_bak) { - fprintf(stderr, "%s: Failed to obtain backup partition entry array\n", - __func__); - goto error; - } - disk->pentry_size = GET_4_BYTES(disk->hdr + PENTRY_SIZE_OFFSET); - disk->pentry_arr_size = - GET_4_BYTES(disk->hdr + PARTITION_COUNT_OFFSET) * - disk->pentry_size; - disk->pentry_arr_crc = GET_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET); - disk->pentry_arr_bak_crc = GET_4_BYTES(disk->hdr_bak + - PARTITION_CRC_OFFSET); - disk->block_size = gpt_get_block_size(fd); - close(fd); - disk->is_initialized = GPT_DISK_INIT_MAGIC; - return 0; + if (!dsk || !dev) { + fprintf(stderr, "%s: Invalid arguments\n", __func__); + goto error; + } + disk = dsk; + disk->hdr = gpt_get_header(dev, PRIMARY_GPT); + if (!disk->hdr) { + fprintf(stderr, "%s: Failed to get primary header\n", __func__); + goto error; + } + gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); + // FIXME: pointer offsets crc bleh + disk->hdr_crc = crc32(0, disk->hdr, gpt_header_size); + disk->hdr_bak = gpt_get_header(dev, PRIMARY_GPT); + if (!disk->hdr_bak) { + fprintf(stderr, "%s: Failed to get backup header\n", __func__); + goto error; + } + disk->hdr_bak_crc = crc32(0, disk->hdr_bak, gpt_header_size); + + //Descriptor for the block device. We will use this for further + //modifications to the partition table + if (get_dev_path_from_partition_name(dev, disk->devpath, + sizeof(disk->devpath)) != 0) { + fprintf(stderr, "%s: Failed to resolve path for %s\n", __func__, + dev); + goto error; + } + fd = open(disk->devpath, O_RDWR); + if (fd < 0) { + fprintf(stderr, "%s: Failed to open %s: %s\n", __func__, + disk->devpath, strerror(errno)); + goto error; + } + disk->pentry_arr = gpt_get_pentry_arr(disk->hdr, fd); + if (!disk->pentry_arr) { + fprintf(stderr, "%s: Failed to obtain partition entry array\n", + __func__); + goto error; + } + disk->pentry_arr_bak = gpt_get_pentry_arr(disk->hdr_bak, fd); + if (!disk->pentry_arr_bak) { + fprintf(stderr, + "%s: Failed to obtain backup partition entry array\n", + __func__); + goto error; + } + disk->pentry_size = GET_4_BYTES(disk->hdr + PENTRY_SIZE_OFFSET); + disk->pentry_arr_size = + GET_4_BYTES(disk->hdr + PARTITION_COUNT_OFFSET) * + disk->pentry_size; + disk->pentry_arr_crc = GET_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET); + disk->pentry_arr_bak_crc = + GET_4_BYTES(disk->hdr_bak + PARTITION_CRC_OFFSET); + disk->block_size = gpt_get_block_size(fd); + close(fd); + disk->is_initialized = GPT_DISK_INIT_MAGIC; + return 0; error: - if (fd >= 0) - close(fd); - return -1; + if (fd >= 0) + close(fd); + return -1; } //Get pointer to partition entry from a allocated gpt_disk structure -uint8_t* gpt_disk_get_pentry(struct gpt_disk *disk, - const char *partname, - enum gpt_instance instance) +uint8_t *gpt_disk_get_pentry(struct gpt_disk *disk, const char *partname, + enum gpt_instance instance) { - uint8_t *ptn_arr = NULL; - if (!disk || !partname || disk->is_initialized != GPT_DISK_INIT_MAGIC) { - fprintf(stderr, "%s: Invalid argument\n",__func__); - goto error; - } - ptn_arr = (instance == PRIMARY_GPT) ? - disk->pentry_arr : disk->pentry_arr_bak; - return (gpt_pentry_seek(partname, ptn_arr, - ptn_arr + disk->pentry_arr_size , - disk->pentry_size)); + uint8_t *ptn_arr = NULL; + if (!disk || !partname || disk->is_initialized != GPT_DISK_INIT_MAGIC) { + fprintf(stderr, "%s: Invalid argument\n", __func__); + goto error; + } + ptn_arr = (instance == PRIMARY_GPT) ? disk->pentry_arr : + disk->pentry_arr_bak; + return (gpt_pentry_seek(partname, ptn_arr, + ptn_arr + disk->pentry_arr_size, + disk->pentry_size)); error: - return NULL; + return NULL; } //Update CRC values for the various components of the gpt_disk @@ -1388,73 +749,70 @@ error: //disk. int gpt_disk_update_crc(struct gpt_disk *disk) { - uint32_t gpt_header_size = 0; - if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)) { - fprintf(stderr, "%s: invalid argument\n", __func__); - goto error; - } - //Recalculate the CRC of the primary partiton array - disk->pentry_arr_crc = crc32(0, - disk->pentry_arr, - disk->pentry_arr_size); - //Recalculate the CRC of the backup partition array - disk->pentry_arr_bak_crc = crc32(0, - disk->pentry_arr_bak, - disk->pentry_arr_size); - //Update the partition CRC value in the primary GPT header - PUT_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET, disk->pentry_arr_crc); - //Update the partition CRC value in the backup GPT header - PUT_4_BYTES(disk->hdr_bak + PARTITION_CRC_OFFSET, - disk->pentry_arr_bak_crc); - //Update the CRC value of the primary header - gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); - //Header CRC is calculated with its own CRC field set to 0 - PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, 0); - PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, 0); - disk->hdr_crc = crc32(0, disk->hdr, gpt_header_size); - disk->hdr_bak_crc = crc32(0, disk->hdr_bak, gpt_header_size); - PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, disk->hdr_crc); - PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, disk->hdr_bak_crc); - return 0; + uint32_t gpt_header_size = 0; + if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)) { + fprintf(stderr, "%s: invalid argument\n", __func__); + goto error; + } + //Recalculate the CRC of the primary partiton array + disk->pentry_arr_crc = + crc32(0, disk->pentry_arr, disk->pentry_arr_size); + //Recalculate the CRC of the backup partition array + disk->pentry_arr_bak_crc = + crc32(0, disk->pentry_arr_bak, disk->pentry_arr_size); + //Update the partition CRC value in the primary GPT header + PUT_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET, disk->pentry_arr_crc); + //Update the partition CRC value in the backup GPT header + PUT_4_BYTES(disk->hdr_bak + PARTITION_CRC_OFFSET, + disk->pentry_arr_bak_crc); + //Update the CRC value of the primary header + gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); + //Header CRC is calculated with its own CRC field set to 0 + PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, 0); + PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, 0); + disk->hdr_crc = crc32(0, disk->hdr, gpt_header_size); + disk->hdr_bak_crc = crc32(0, disk->hdr_bak, gpt_header_size); + PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, disk->hdr_crc); + PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, disk->hdr_bak_crc); + return 0; error: - return -1; + return -1; } //Write the contents of struct gpt_disk back to the actual disk int gpt_disk_commit(struct gpt_disk *disk) { - int fd = -1; - if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)){ - fprintf(stderr, "%s: Invalid args\n", __func__); - goto error; - } - fd = open(disk->devpath, O_RDWR); - if (fd < 0) { - fprintf(stderr, "%s: Failed to open %s: %s\n", - __func__, - disk->devpath, - strerror(errno)); - goto error; - } - LOGD("%s: Writing back primary GPT header\n", __func__); - //Write the primary header - if(gpt_set_header(disk->hdr, fd, PRIMARY_GPT) != 0) { - fprintf(stderr, "%s: Failed to update primary GPT header\n", - __func__); - goto error; - } - LOGD("%s: Writing back primary partition array\n", __func__); - //Write back the primary partition array - if (gpt_set_pentry_arr(disk->hdr, fd, disk->pentry_arr)) { - fprintf(stderr, "%s: Failed to write primary GPT partition arr\n", - __func__); - goto error; - } - fsync(fd); - close(fd); - return 0; + int fd = -1; + if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)) { + fprintf(stderr, "%s: Invalid args\n", __func__); + goto error; + } + fd = open(disk->devpath, O_RDWR); + if (fd < 0) { + fprintf(stderr, "%s: Failed to open %s: %s\n", __func__, + disk->devpath, strerror(errno)); + goto error; + } + LOGD("%s: Writing back primary GPT header\n", __func__); + //Write the primary header + if (gpt_set_header(disk->hdr, fd, PRIMARY_GPT) != 0) { + fprintf(stderr, "%s: Failed to update primary GPT header\n", + __func__); + goto error; + } + LOGD("%s: Writing back primary partition array\n", __func__); + //Write back the primary partition array + if (gpt_set_pentry_arr(disk->hdr, fd, disk->pentry_arr)) { + fprintf(stderr, + "%s: Failed to write primary GPT partition arr\n", + __func__); + goto error; + } + fsync(fd); + close(fd); + return 0; error: - if (fd >= 0) - close(fd); - return -1; + if (fd >= 0) + close(fd); + return -1; } diff --git a/gpt-utils.h b/gpt-utils.h index 7f296a6..4f7596f 100644 --- a/gpt-utils.h +++ b/gpt-utils.h @@ -37,78 +37,58 @@ extern "C" { #endif #include #include -/****************************************************************************** - * GPT HEADER DEFINES - ******************************************************************************/ -#define GPT_SIGNATURE "EFI PART" -#define HEADER_SIZE_OFFSET 12 -#define HEADER_CRC_OFFSET 16 -#define PRIMARY_HEADER_OFFSET 24 -#define BACKUP_HEADER_OFFSET 32 -#define FIRST_USABLE_LBA_OFFSET 40 -#define LAST_USABLE_LBA_OFFSET 48 -#define PENTRIES_OFFSET 72 -#define PARTITION_COUNT_OFFSET 80 -#define PENTRY_SIZE_OFFSET 84 -#define PARTITION_CRC_OFFSET 88 -#define TYPE_GUID_OFFSET 0 -#define TYPE_GUID_SIZE 16 -#define PTN_ENTRY_SIZE 128 -#define UNIQUE_GUID_OFFSET 16 -#define FIRST_LBA_OFFSET 32 -#define LAST_LBA_OFFSET 40 -#define ATTRIBUTE_FLAG_OFFSET 48 -#define PARTITION_NAME_OFFSET 56 -#define MAX_GPT_NAME_SIZE 72 +#define GPT_SIGNATURE "EFI PART" +#define HEADER_SIZE_OFFSET 12 +#define HEADER_CRC_OFFSET 16 +#define PRIMARY_HEADER_OFFSET 24 +#define BACKUP_HEADER_OFFSET 32 +#define FIRST_USABLE_LBA_OFFSET 40 +#define LAST_USABLE_LBA_OFFSET 48 +#define PENTRIES_OFFSET 72 +#define PARTITION_COUNT_OFFSET 80 +#define PENTRY_SIZE_OFFSET 84 +#define PARTITION_CRC_OFFSET 88 + +#define TYPE_GUID_OFFSET 0 +#define TYPE_GUID_SIZE 16 +#define PTN_ENTRY_SIZE 128 +#define UNIQUE_GUID_OFFSET 16 +#define FIRST_LBA_OFFSET 32 +#define LAST_LBA_OFFSET 40 +#define ATTRIBUTE_FLAG_OFFSET 48 +#define PARTITION_NAME_OFFSET 56 +#define MAX_GPT_NAME_SIZE 72 -/****************************************************************************** - * AB RELATED DEFINES - ******************************************************************************/ //Bit 48 onwords in the attribute field are the ones where we are allowed to //store our AB attributes. -#define AB_FLAG_OFFSET (ATTRIBUTE_FLAG_OFFSET + 6) -#define GPT_DISK_INIT_MAGIC 0xABCD -#define AB_PARTITION_ATTR_SLOT_ACTIVE (0x1<<2) -#define AB_PARTITION_ATTR_BOOT_SUCCESSFUL (0x1<<6) -#define AB_PARTITION_ATTR_UNBOOTABLE (0x1<<7) -#define AB_SLOT_ACTIVE_VAL 0xF -#define AB_SLOT_INACTIVE_VAL 0x0 -#define AB_SLOT_ACTIVE 1 -#define AB_SLOT_INACTIVE 0 -#define AB_SLOT_A_SUFFIX "_a" -#define AB_SLOT_B_SUFFIX "_b" -#define PTN_XBL "xbl" -#define PTN_SWAP_LIST PTN_XBL, \ - "abl", "aop", "apdp", "cmnlib", "cmnlib64", \ - "devcfg", "dtbo", "hyp", "keymaster", "msadp", \ - "qupfw", "storsec", "tz", "vbmeta", "vbmeta_system", "xbl_config" +#define AB_FLAG_OFFSET (ATTRIBUTE_FLAG_OFFSET + 6) +#define GPT_DISK_INIT_MAGIC 0xABCD +#define AB_PARTITION_ATTR_SLOT_ACTIVE (0x1 << 2) +#define AB_PARTITION_ATTR_BOOT_SUCCESSFUL (0x1 << 6) +#define AB_PARTITION_ATTR_UNBOOTABLE (0x1 << 7) +#define AB_SLOT_ACTIVE_VAL 0xF +#define AB_SLOT_INACTIVE_VAL 0x0 +#define AB_SLOT_ACTIVE 1 +#define AB_SLOT_INACTIVE 0 +#define AB_SLOT_A_SUFFIX "_a" +#define AB_SLOT_B_SUFFIX "_b" +#define PTN_XBL "xbl" +#define PTN_SWAP_LIST \ + PTN_XBL, "abl", "aop", "apdp", "cmnlib", "cmnlib64", "devcfg", "dtbo", \ + "hyp", "keymaster", "msadp", "qupfw", "storsec", "tz", \ + "vbmeta", "vbmeta_system", "xbl_config" -#define AB_PTN_LIST PTN_SWAP_LIST, "boot", "system", "vendor", "modem", "system_ext", "product" -#define BOOT_DEV_DIR "/dev/disk/by-partlabel" +#define AB_PTN_LIST \ + PTN_SWAP_LIST, "boot", "system", "vendor", "modem", "system_ext", \ + "product" +#define BOOT_DEV_DIR "/dev/disk/by-partlabel" -/****************************************************************************** - * HELPER MACROS - ******************************************************************************/ #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) -/****************************************************************************** - * TYPES - ******************************************************************************/ -enum boot_update_stage { - UPDATE_MAIN = 1, - UPDATE_BACKUP, - UPDATE_FINALIZE -}; -enum gpt_instance { - PRIMARY_GPT = 0, - SECONDARY_GPT -}; +enum gpt_instance { PRIMARY_GPT = 0, SECONDARY_GPT }; -enum boot_chain { - NORMAL_BOOT = 0, - BACKUP_BOOT -}; +enum boot_chain { NORMAL_BOOT = 0, BACKUP_BOOT }; struct gpt_disk { //GPT primary header @@ -138,12 +118,8 @@ struct gpt_disk { uint32_t is_initialized; }; -/****************************************************************************** - * FUNCTION PROTOTYPES - ******************************************************************************/ -int prepare_boot_update(enum boot_update_stage stage); //GPT disk methods -struct gpt_disk* gpt_disk_alloc(); +struct gpt_disk *gpt_disk_alloc(); //Free previously allocated gpt_disk struct void gpt_disk_free(struct gpt_disk *disk); //Get the details of the disk holding the partition whose name @@ -151,9 +127,8 @@ void gpt_disk_free(struct gpt_disk *disk); int gpt_disk_get_disk_info(const char *dev, struct gpt_disk *disk); //Get pointer to partition entry from a allocated gpt_disk structure -uint8_t* gpt_disk_get_pentry(struct gpt_disk *disk, - const char *partname, - enum gpt_instance instance); +uint8_t *gpt_disk_get_pentry(struct gpt_disk *disk, const char *partname, + enum gpt_instance instance); //Update the crc fields of the modified disk structure int gpt_disk_update_crc(struct gpt_disk *disk); @@ -161,9 +136,6 @@ int gpt_disk_update_crc(struct gpt_disk *disk); //Write the contents of struct gpt_disk back to the actual disk int gpt_disk_commit(struct gpt_disk *disk); -//Return if the current device is UFS based or not -int gpt_utils_is_ufs_device(); - //Swtich betwieen using either the primary or the backup //boot LUN for boot. This is required since UFS boot partitions //cannot have a backup GPT which is what we use for failsafe @@ -188,8 +160,9 @@ int gpt_utils_set_xbl_boot_partition(enum boot_chain chain); //sits on. The key in the map is the path to the block device where the //partition lies and the value is a vector of strings indicating which of //the passed in partition names sits on that device. -int gpt_utils_get_partition_map(std::vector& partition_list, - std::map>& partition_map); +int gpt_utils_get_partition_map( + std::vector &partition_list, + std::map > &partition_map); #ifdef __cplusplus } #endif diff --git a/meson.build b/meson.build index a7db403..3d3761d 100644 --- a/meson.build +++ b/meson.build @@ -6,6 +6,8 @@ deps = [ src = [ 'qbootctl.cpp', + 'bootctrl_impl.cpp', + 'bootctrl_test.cpp', 'gpt-utils.cpp', 'ufs-bsg.cpp', ] diff --git a/qbootctl.cpp b/qbootctl.cpp index 12f0895..90cf695 100644 --- a/qbootctl.cpp +++ b/qbootctl.cpp @@ -1,32 +1,20 @@ /* - * Copyright (c) 2016, The Linux Foundation. All rights reserved. - * Copyright (C) 2021-2022 Caleb Connolly + * Copyright (C) 2022 Caleb Connolly * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * 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. - * * Neither the name of The Linux Foundation 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 "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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. + * 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 3 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, see . */ + #include #include #include @@ -35,755 +23,95 @@ #include #include #include +#include #include -#include -#include -#include -#include -#include - -#include "utils.h" -#include "gpt-utils.h" - -#define BOOTDEV_DIR "/dev/disk/by-partlabel" -#define BOOT_IMG_PTN_NAME "boot_" -#define LUN_NAME_END_LOC 14 -#define BOOT_SLOT_PROP "slot_suffix" - -#define MAX_CMDLINE_SIZE 4096 -#define SLOT_ACTIVE 1 -#define SLOT_INACTIVE 2 -#define UPDATE_SLOT(pentry, guid, slot_state) ({ \ - memcpy(pentry, guid, TYPE_GUID_SIZE); \ - if (slot_state == SLOT_ACTIVE)\ - *(pentry + AB_FLAG_OFFSET) = AB_SLOT_ACTIVE_VAL; \ - else if (slot_state == SLOT_INACTIVE) \ - *(pentry + AB_FLAG_OFFSET) = (*(pentry + AB_FLAG_OFFSET)& \ - ~AB_PARTITION_ATTR_SLOT_ACTIVE); \ - }) +#include "bootctrl.h" -using namespace std; -const char *slot_suffix_arr[] = { - AB_SLOT_A_SUFFIX, - AB_SLOT_B_SUFFIX, - NULL}; +const struct boot_control_module *impl = &bootctl; -enum part_attr_type { - ATTR_SLOT_ACTIVE = 0, - ATTR_BOOT_SUCCESSFUL, - ATTR_UNBOOTABLE, - ATTR_BOOTABLE, -}; - -void get_kernel_cmdline_arg(const char * arg, char* buf, const char* def) +bool isslot(const char* str) { - int fd; - char pcmd[MAX_CMDLINE_SIZE]; - char *val, *found, *ptr = buf; - fd = open("/proc/cmdline", O_RDONLY); - int rc = read(fd, pcmd, MAX_CMDLINE_SIZE); - if (rc < 0) { - fprintf(stderr, "Couldn't open /proc/cmdline: %d (%s)\n", rc, strerror(errno)); - goto error; - } - close(fd); - found = strstr(pcmd, arg); - if (!found || !(val = strstr(found, "="))) { - fprintf(stderr, "Couldn't find cmdline arg: '%s'\n", arg); - goto error; - } - - val++; - // no this doesn't handle quotes lol - while (*val != ' ') { - *ptr++ = *val++; - } - - return; - -error: - strcpy(buf, def); + return strspn(str, "01abAB") == strlen(str); } -void boot_control_init() +bool isslotnum(const char* str) { - return; + return strspn(str, "01") == strlen(str); } -//Get the value of one of the attribute fields for a partition. -static int get_partition_attribute(char *partname, - enum part_attr_type part_attr) +unsigned parseSlot(const char* arg) { - struct gpt_disk *disk = NULL; - uint8_t *pentry = NULL; - int retval = -1; - uint8_t *attr = NULL; - if (!partname) - goto error; - disk = gpt_disk_alloc(); - if (!disk) { - fprintf(stderr, "%s: Failed to alloc disk struct\n", __func__); - goto error; - } - if (gpt_disk_get_disk_info(partname, disk)) { - fprintf(stderr, "%s: Failed to get disk info\n", __func__); - goto error; - } - pentry = gpt_disk_get_pentry(disk, partname, PRIMARY_GPT); - - if (!pentry) { - fprintf(stderr, "%s: pentry does not exist in disk struct\n", - __func__); - goto error; - } - attr = pentry + AB_FLAG_OFFSET; - LOGD("get_partition_attribute() partname = %s, attr = 0x%x\n", partname, *attr); - if (part_attr == ATTR_SLOT_ACTIVE) { - retval = !!(*attr & AB_PARTITION_ATTR_SLOT_ACTIVE); - LOGD("ATTR_SLOT_ACTIVE, retval = %d\n", retval); - } else if (part_attr == ATTR_BOOT_SUCCESSFUL) { - retval = !!(*attr & AB_PARTITION_ATTR_BOOT_SUCCESSFUL); - LOGD("AB_PARTITION_ATTR_BOOT_SUCCESSFUL, retval = %d\n", retval); - } else if (part_attr == ATTR_UNBOOTABLE) { - retval = !!(*attr & AB_PARTITION_ATTR_UNBOOTABLE); - LOGD("AB_PARTITION_ATTR_UNBOOTABLE, retval = %d\n", retval); + char *end; + int slot; + if (!isslot(arg)) { + goto fail; + } + if (isslotnum(arg)) { + slot = (int)strtol(arg, &end, 10); + if (end == arg) + goto fail; } else { - retval = -1; - } - gpt_disk_free(disk); - return retval; -error: - if (disk) - gpt_disk_free(disk); - return retval; -} - -//Set a particular attribute for all the partitions in a -//slot -static int update_slot_attribute(const char *slot, - enum part_attr_type ab_attr) -{ - unsigned int i = 0; - char buf[PATH_MAX]; - struct stat st; - struct gpt_disk *disk = NULL; - uint8_t *pentry = NULL; - uint8_t *pentry_bak = NULL; - int rc = -1; - uint8_t *attr = NULL; - uint8_t *attr_bak = NULL; - char partName[MAX_GPT_NAME_SIZE + 1] = {0}; - const char ptn_list[][MAX_GPT_NAME_SIZE - 1] = { AB_PTN_LIST }; - int slot_name_valid = 0; - if (!slot) { - fprintf(stderr, "%s: Invalid argument\n", __func__); - goto error; - } - for (i = 0; slot_suffix_arr[i] != NULL; i++) - { - if (!strncmp(slot, slot_suffix_arr[i], - strlen(slot_suffix_arr[i]))) - slot_name_valid = 1; - } - if (!slot_name_valid) { - fprintf(stderr, "%s: Invalid slot name\n", __func__); - goto error; - } - for (i=0; i < ARRAY_SIZE(ptn_list); i++) { - memset(buf, '\0', sizeof(buf)); - //Check if A/B versions of this ptn exist - snprintf(buf, sizeof(buf) - 1, - "%s/%s%s", - BOOT_DEV_DIR, - ptn_list[i], - AB_SLOT_A_SUFFIX - ); - if (stat(buf, &st) < 0) { - //partition does not have _a version - continue; - } - memset(buf, '\0', sizeof(buf)); - snprintf(buf, sizeof(buf) - 1, - "%s/%s%s", - BOOT_DEV_DIR, - ptn_list[i], - AB_SLOT_B_SUFFIX - ); - if (stat(buf, &st) < 0) { - //partition does not have _b version - continue; - } - memset(partName, '\0', sizeof(partName)); - snprintf(partName, - sizeof(partName) - 1, - "%s%s", - ptn_list[i], - slot); - disk = gpt_disk_alloc(); - if (!disk) { - fprintf(stderr, "%s: Failed to alloc disk struct\n", - __func__); - goto error; - } - rc = gpt_disk_get_disk_info(partName, disk); - if (rc != 0) { - fprintf(stderr, "%s: Failed to get disk info for %s\n", - __func__, - partName); - goto error; - } - pentry = gpt_disk_get_pentry(disk, partName, PRIMARY_GPT); - pentry_bak = gpt_disk_get_pentry(disk, partName, SECONDARY_GPT); - if (!pentry || !pentry_bak) { - fprintf(stderr, "%s: Failed to get pentry/pentry_bak for %s\n", - __func__, - partName); - goto error; - } - attr = pentry + AB_FLAG_OFFSET; - LOGD("%s: got pentry for part '%s': 0x%lx (at flags: 0x%x)\n", __func__, partName, *(uint64_t*)pentry, *attr); - attr_bak = pentry_bak + AB_FLAG_OFFSET; - switch(ab_attr) { - case ATTR_BOOT_SUCCESSFUL: - *attr = (*attr) | AB_PARTITION_ATTR_BOOT_SUCCESSFUL; - *attr_bak = (*attr_bak) | - AB_PARTITION_ATTR_BOOT_SUCCESSFUL; - break; - case ATTR_UNBOOTABLE: - *attr = (*attr) | AB_PARTITION_ATTR_UNBOOTABLE; - *attr_bak = (*attr_bak) | AB_PARTITION_ATTR_UNBOOTABLE; - break; - case ATTR_BOOTABLE: - *attr = (*attr) ^ AB_PARTITION_ATTR_UNBOOTABLE; - *attr_bak = (*attr_bak) ^ AB_PARTITION_ATTR_UNBOOTABLE; + switch (arg[0]) { + case 'a': + case 'A': + slot = 0; break; - case ATTR_SLOT_ACTIVE: - *attr = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; - *attr_bak = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; + case 'b': + case 'B': + slot = 1; break; default: - fprintf(stderr, "%s: Unrecognized attr\n", __func__); - goto error; - } - if (gpt_disk_update_crc(disk)) { - fprintf(stderr, "%s: Failed to update crc for %s\n", - __func__, - partName); - goto error; - } - if (gpt_disk_commit(disk)) { - fprintf(stderr, "%s: Failed to write back entry for %s\n", - __func__, - partName); - goto error; - } - gpt_disk_free(disk); - disk = NULL; - } - return 0; -error: - if (disk) - gpt_disk_free(disk); - return -1; -} - -unsigned get_number_slots() -{ - struct dirent *de = NULL; - DIR *dir_bootdev = NULL; - unsigned slot_count = 0; - - dir_bootdev = opendir(BOOTDEV_DIR); - if (!dir_bootdev) { - fprintf(stderr, "%s: Failed to open bootdev dir (%s)\n", - __func__, - strerror(errno)); - goto error; - } - while ((de = readdir(dir_bootdev))) { - if (de->d_name[0] == '.') - continue; - static_assert(AB_SLOT_A_SUFFIX[0] == '_', "Breaking change to slot A suffix"); - static_assert(AB_SLOT_B_SUFFIX[0] == '_', "Breaking change to slot B suffix"); - if (!strncmp(de->d_name, BOOT_IMG_PTN_NAME, - strlen(BOOT_IMG_PTN_NAME)) && !!strncmp(de->d_name, "boot_aging\n", strlen("boot_aging"))) { - slot_count++; - } - } - closedir(dir_bootdev); - return slot_count; -error: - if (dir_bootdev) - closedir(dir_bootdev); - return 0; -} - -static unsigned int get_current_slot() -{ - uint32_t num_slots = 0; - char bootSlotProp[MAX_CMDLINE_SIZE] = {'\0'}; - unsigned i = 0; - num_slots = get_number_slots(); - if (num_slots <= 1) { - //Slot 0 is the only slot around. - return 0; - } - get_kernel_cmdline_arg(BOOT_SLOT_PROP, bootSlotProp, "_a"); - if (!strncmp(bootSlotProp, "N/A\n", strlen("N/A"))) { - fprintf(stderr, "%s: Unable to read boot slot property\n", - __func__); - goto error; - } - //Iterate through a list of partitons named as boot+suffix - //and see which one is currently active. - for (i = 0; slot_suffix_arr[i] != NULL ; i++) { - if (!strncmp(bootSlotProp, - slot_suffix_arr[i], - strlen(slot_suffix_arr[i]))) { - //printf("%s current_slot = %d\n", __func__, i); - return i; - } - } -error: - //The HAL spec requires that we return a number between - //0 to num_slots - 1. Since something went wrong here we - //are just going to return the default slot. - return 0; -} - -static int boot_control_check_slot_sanity(unsigned slot) -{ - uint32_t num_slots = get_number_slots(); - if ((num_slots < 1) || (slot > num_slots - 1)) { - fprintf(stderr, "Invalid slot number"); - return -1; - } - return 0; - -} - -int get_boot_attr(unsigned slot, enum part_attr_type attr) -{ - char bootPartition[MAX_GPT_NAME_SIZE + 1] = {0}; - - if (boot_control_check_slot_sanity(slot) != 0) { - fprintf(stderr, "%s: Argument check failed\n", __func__); - return -1; - } - snprintf(bootPartition, - sizeof(bootPartition) - 1, "boot%s", - slot_suffix_arr[slot]); - - return get_partition_attribute(bootPartition, attr); -} - -int is_slot_bootable(unsigned slot) -{ - int attr = 0; - attr = get_boot_attr(slot, ATTR_UNBOOTABLE); - if (attr >= 0) - return !attr; - - return -1; -} - -int mark_boot_successful(unsigned slot) -{ - int successful = get_boot_attr(slot, ATTR_BOOT_SUCCESSFUL); - - if (!is_slot_bootable(slot)) { - printf("SLOT %s: was marked unbootable, fixing this" - " (I hope you know what you're doing...)\n", slot_suffix_arr[slot]); - update_slot_attribute(slot_suffix_arr[slot], - ATTR_BOOTABLE); - } - - if (successful) { - fprintf(stderr, "SLOT %s: already marked successful\n", slot_suffix_arr[slot]); - return -1; - } - - if (update_slot_attribute(slot_suffix_arr[slot], - ATTR_BOOT_SUCCESSFUL)) { - goto error; - } - return 0; -error: - fprintf(stderr, "SLOT %s: Failed to mark boot successful\n", slot_suffix_arr[slot]); - return -1; -} - -const char *get_suffix(unsigned slot) -{ - if (boot_control_check_slot_sanity(slot) != 0) - return NULL; - else - return slot_suffix_arr[slot]; -} - - -//Return a gpt disk structure representing the disk that holds -//partition. -static struct gpt_disk* boot_ctl_get_disk_info(char *partition) -{ - struct gpt_disk *disk = NULL; - if (!partition) - return NULL; - disk = gpt_disk_alloc(); - if (!disk) { - fprintf(stderr, "%s: Failed to alloc disk\n", - __func__); - goto error; - } - if (gpt_disk_get_disk_info(partition, disk)) { - fprintf(stderr, "failed to get disk info for %s\n", - partition); - goto error; - } - return disk; -error: - if (disk) - gpt_disk_free(disk); - return NULL; -} - -//The argument here is a vector of partition names(including the slot suffix) -//that lie on a single disk -static int boot_ctl_set_active_slot_for_partitions(vector part_list, - unsigned slot) -{ - char buf[PATH_MAX] = {0}; - struct gpt_disk *disk = NULL; - char slotA[MAX_GPT_NAME_SIZE + 1] = {0}; - char slotB[MAX_GPT_NAME_SIZE + 1] = {0}; - char active_guid[TYPE_GUID_SIZE + 1] = {0}; - char inactive_guid[TYPE_GUID_SIZE + 1] = {0}; - int rc; - //Pointer to the partition entry of current 'A' partition - uint8_t *pentryA = NULL; - uint8_t *pentryA_bak = NULL; - //Pointer to partition entry of current 'B' partition - uint8_t *pentryB = NULL; - uint8_t *pentryB_bak = NULL; - struct stat st; - vector::iterator partition_iterator; - - LOGD("Marking slot %s as active:\n", slot_suffix_arr[slot]); - - for (partition_iterator = part_list.begin(); - partition_iterator != part_list.end(); - partition_iterator++) { - //Chop off the slot suffix from the partition name to - //make the string easier to work with. - string prefix = *partition_iterator; - LOGD("Part: %s\n", prefix.c_str()); - if (prefix.size() < (strlen(AB_SLOT_A_SUFFIX) + 1)) { - fprintf(stderr, "Invalid partition name: %s\n", prefix.c_str()); - goto error; - } - prefix.resize(prefix.size() - strlen(AB_SLOT_A_SUFFIX)); - //Check if A/B versions of this ptn exist - snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, - prefix.c_str(), - AB_SLOT_A_SUFFIX); - LOGD("\t_a Path: '%s'\n", buf); - rc = stat(buf, &st); - if (rc < 0) { - fprintf(stderr, "Failed to stat() path: %d: %s\n", rc, strerror(errno)); - continue; - } - memset(buf, '\0', sizeof(buf)); - snprintf(buf, sizeof(buf) - 1, "%s/%s%s", BOOT_DEV_DIR, - prefix.c_str(), - AB_SLOT_B_SUFFIX); - LOGD("\t_b Path: '%s'\n", buf); - rc = stat(buf, &st); - if (rc < 0) { - fprintf(stderr, "Failed to stat() path: %d: %s\n", rc, strerror(errno)); - continue; - } - memset(slotA, 0, sizeof(slotA)); - memset(slotB, 0, sizeof(slotA)); - snprintf(slotA, sizeof(slotA) - 1, "%s%s", prefix.c_str(), - AB_SLOT_A_SUFFIX); - snprintf(slotB, sizeof(slotB) - 1,"%s%s", prefix.c_str(), - AB_SLOT_B_SUFFIX); - //Get the disk containing the partitions that were passed in. - //All partitions passed in must lie on the same disk. - if (!disk) { - disk = boot_ctl_get_disk_info(slotA); - if (!disk) - goto error; - } - //Get partition entry for slot A & B from the primary - //and backup tables. - pentryA = gpt_disk_get_pentry(disk, slotA, PRIMARY_GPT); - pentryA_bak = gpt_disk_get_pentry(disk, slotA, SECONDARY_GPT); - pentryB = gpt_disk_get_pentry(disk, slotB, PRIMARY_GPT); - pentryB_bak = gpt_disk_get_pentry(disk, slotB, SECONDARY_GPT); - if ( !pentryA || !pentryA_bak || !pentryB || !pentryB_bak) { - //None of these should be NULL since we have already - //checked for A & B versions earlier. - fprintf(stderr, "Slot pentries for %s not found.\n", - prefix.c_str()); - goto error; - } - LOGD("\tAB attr (A): 0x%x (backup: 0x%x)\n", - *(uint16_t*)(pentryA + AB_FLAG_OFFSET), - *(uint16_t*)(pentryA_bak + AB_FLAG_OFFSET)); - LOGD("\tAB attr (B): 0x%x (backup: 0x%x)\n", - *(uint16_t*)(pentryB + AB_FLAG_OFFSET), - *(uint16_t*)(pentryB_bak + AB_FLAG_OFFSET)); - memset(active_guid, '\0', sizeof(active_guid)); - memset(inactive_guid, '\0', sizeof(inactive_guid)); - if (get_partition_attribute(slotA, ATTR_SLOT_ACTIVE) == 1) { - //A is the current active slot - memcpy((void*)active_guid, (const void*)pentryA, - TYPE_GUID_SIZE); - memcpy((void*)inactive_guid,(const void*)pentryB, - TYPE_GUID_SIZE); - } else if (get_partition_attribute(slotB, - ATTR_SLOT_ACTIVE) == 1) { - //B is the current active slot - memcpy((void*)active_guid, (const void*)pentryB, - TYPE_GUID_SIZE); - memcpy((void*)inactive_guid, (const void*)pentryA, - TYPE_GUID_SIZE); - } else { - fprintf(stderr, "Both A & B are inactive..Aborting"); - goto error; - } - // printf("\tActive GUID: %s\n", active_guid); - // printf("\tInactive GUID: %s\n", active_guid); - if (!strncmp(slot_suffix_arr[slot], AB_SLOT_A_SUFFIX, - strlen(AB_SLOT_A_SUFFIX))){ - //Mark A as active in primary table - UPDATE_SLOT(pentryA, active_guid, SLOT_ACTIVE); - //Mark A as active in backup table - UPDATE_SLOT(pentryA_bak, active_guid, SLOT_ACTIVE); - //Mark B as inactive in primary table - UPDATE_SLOT(pentryB, inactive_guid, SLOT_INACTIVE); - //Mark B as inactive in backup table - UPDATE_SLOT(pentryB_bak, inactive_guid, SLOT_INACTIVE); - } else if (!strncmp(slot_suffix_arr[slot], AB_SLOT_B_SUFFIX, - strlen(AB_SLOT_B_SUFFIX))){ - //Mark B as active in primary table - UPDATE_SLOT(pentryB, active_guid, SLOT_ACTIVE); - //Mark B as active in backup table - UPDATE_SLOT(pentryB_bak, active_guid, SLOT_ACTIVE); - //Mark A as inavtive in primary table - UPDATE_SLOT(pentryA, inactive_guid, SLOT_INACTIVE); - //Mark A as inactive in backup table - UPDATE_SLOT(pentryA_bak, inactive_guid, SLOT_INACTIVE); - } else { - //Something has gone terribly terribly wrong - fprintf(stderr, "%s: Unknown slot suffix!\n", __func__); - goto error; - } - if (gpt_disk_update_crc(disk) != 0) { - fprintf(stderr, "%s: Failed to update gpt_disk crc\n", - __func__); - goto error; - } - } - //write updated content to disk - if (disk) { - if (gpt_disk_commit(disk)) { - fprintf(stderr, "Failed to commit disk entry"); - goto error; - } - gpt_disk_free(disk); - } - return 0; - -error: - if (disk) - gpt_disk_free(disk); - return -1; -} - -unsigned get_active_boot_slot() -{ - - uint32_t num_slots = get_number_slots(); - if (num_slots <= 1) { - //Slot 0 is the only slot around. - return 0; - } - - for (uint32_t i = 0; i < num_slots; i++) { - if (get_boot_attr(i, ATTR_SLOT_ACTIVE)) - return i; - } - - fprintf(stderr, "%s: Failed to find the active boot slot\n", __func__); - return 0; -} - -int set_active_boot_slot(unsigned slot) -{ - map> ptn_map; - vector ptn_vec; - const char ptn_list[][MAX_GPT_NAME_SIZE] = { AB_PTN_LIST }; - uint32_t i; - int rc = -1; - int is_ufs = gpt_utils_is_ufs_device(); - map>::iterator map_iter; - - if (boot_control_check_slot_sanity(slot)) { - fprintf(stderr, "%s: Bad arguments\n", __func__); - goto error; - } - - //The partition list just contains prefixes(without the _a/_b) of the - //partitions that support A/B. In order to get the layout we need the - //actual names. To do this we append the slot suffix to every member - //in the list. - for (i = 0; i < ARRAY_SIZE(ptn_list); i++) { - //XBL is handled differrently for ufs devices so ignore it - if (is_ufs && !strncmp(ptn_list[i], PTN_XBL, strlen(PTN_XBL))) - continue; - //The partition list will be the list of _a partitions - string cur_ptn = ptn_list[i]; - cur_ptn.append(AB_SLOT_A_SUFFIX); - ptn_vec.push_back(cur_ptn); - - } - //The partition map gives us info in the following format: - // [path_to_block_device_1]--> - // [path_to_block_device_2]--> - // ... - // ... - // eg: - // [/dev/block/sdb]---> - if (gpt_utils_get_partition_map(ptn_vec, ptn_map)) { - fprintf(stderr, "%s: Failed to get partition map\n", - __func__); - goto error; - } - for (map_iter = ptn_map.begin(); map_iter != ptn_map.end(); map_iter++){ - if (map_iter->second.size() < 1) - continue; - if (boot_ctl_set_active_slot_for_partitions(map_iter->second, slot)) { - fprintf(stderr, "%s: Failed to set active slot for partitions \n", __func__);; - goto error; - } - } - if (is_ufs) { - if (!strncmp(slot_suffix_arr[slot], AB_SLOT_A_SUFFIX, - strlen(AB_SLOT_A_SUFFIX))){ - //Set xbl_a as the boot lun - rc = gpt_utils_set_xbl_boot_partition(NORMAL_BOOT); - } else if (!strncmp(slot_suffix_arr[slot], AB_SLOT_B_SUFFIX, - strlen(AB_SLOT_B_SUFFIX))){ - //Set xbl_b as the boot lun - rc = gpt_utils_set_xbl_boot_partition(BACKUP_BOOT); - } else { - //Something has gone terribly terribly wrong - fprintf(stderr, "%s: Unknown slot suffix!\n", __func__); - goto error; - } - if (rc) { - fprintf(stderr, "%s: Failed to switch xbl boot partition\n", - __func__); - goto error; + goto fail; } } - return 0; -error: - return -1; -} -int set_slot_as_unbootable(unsigned slot) -{ - if (boot_control_check_slot_sanity(slot) != 0) { - fprintf(stderr, "%s: Argument check failed\n", __func__); - goto error; - } - if (update_slot_attribute(slot_suffix_arr[slot], - ATTR_UNBOOTABLE)) { - goto error; - } - return 0; -error: - fprintf(stderr, "%s: Failed to mark slot unbootable\n", __func__); - return -1; -} + return (unsigned)slot; -int is_slot_marked_successful(unsigned slot) -{ - int attr = 0; - char bootPartition[MAX_GPT_NAME_SIZE + 1] = {0}; - - if (boot_control_check_slot_sanity(slot) != 0) { - fprintf(stderr, "%s: Argument check failed\n", __func__); - goto error; - } - snprintf(bootPartition, - sizeof(bootPartition) - 1, - "boot%s", slot_suffix_arr[slot]); - attr = get_partition_attribute(bootPartition, ATTR_BOOT_SUCCESSFUL); - LOGD("%s: slot = %d, attr = 0x%x\n", __func__, slot, attr); - if (attr >= 0) - return attr; -error: - return -1; +fail: + fprintf(stderr, + "Expected slot not '%s'\n", + arg); + exit(1); } -/* -const struct boot_control_module HAL_MODULE_INFO_SYM = { - .init = boot_control_init, - .getNumberSlots = get_number_slots, - .getCurrentSlot = get_current_slot, - .markBootSuccessful = mark_boot_successful, - .setActiveBootSlot = set_active_boot_slot, - .setSlotAsUnbootable = set_slot_as_unbootable, - .isSlotBootable = is_slot_bootable, - .getSuffix = get_suffix, - .isSlotMarkedSuccessful = is_slot_marked_successful, - .getActiveBootSlot = get_active_boot_slot, -}; -*/ - -struct slot_info { - bool active; - bool successful; - bool bootable; -}; - int usage() { - fprintf(stderr, "qbootctl: qcom bootctrl HAL port for Linux\n"); - fprintf(stderr, "-------------------------------------------\n"); - fprintf(stderr, "qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT]\n\n"); - fprintf(stderr, " dump slot info (default)\n"); - fprintf(stderr, " -h this help text\n"); - fprintf(stderr, " -c get the current slot\n"); - fprintf(stderr, " -a get the active slot\n"); - fprintf(stderr, " -b SLOT check if SLOT is marked as bootable\n"); - fprintf(stderr, " -n SLOT check if SLOT is marked as successful\n"); - fprintf(stderr, " -x [SLOT] get the slot suffix for SLOT (default: current)\n"); - fprintf(stderr, " -s SLOT set to active slot to SLOT\n"); - fprintf(stderr, " -m [SLOT] mark a boot as successful (default: current)\n"); - fprintf(stderr, " -u [SLOT] mark SLOT as unbootable (default: current)\n"); - - return 1; -} - -int get_slot_info(struct slot_info *slots) { + fprintf(stderr, "qbootctl: qcom bootctrl HAL port for Linux\n"); + fprintf(stderr, "-------------------------------------------\n"); + fprintf(stderr, "qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT]\n\n"); + fprintf(stderr, " dump slot info (default)\n"); + fprintf(stderr, " -h this help text\n"); + fprintf(stderr, " -c get the current slot\n"); + fprintf(stderr, " -a get the active slot\n"); + fprintf(stderr, + " -b SLOT check if SLOT is marked as bootable\n"); + fprintf(stderr, + " -n SLOT check if SLOT is marked as successful\n"); + fprintf(stderr, + " -x [SLOT] get the slot suffix for SLOT (default: current)\n"); + fprintf(stderr, " -s SLOT set to active slot to SLOT\n"); + fprintf(stderr, + " -m [SLOT] mark a boot as successful (default: current)\n"); + fprintf(stderr, + " -u [SLOT] mark SLOT as unbootable (default: current)\n"); + + return 1; +} + +int get_slot_info(struct slot_info *slots) +{ int rc; - uint32_t active_slot = get_active_boot_slot(); + uint32_t active_slot = impl->getActiveBootSlot(); slots[active_slot].active = true; - for (size_t i = 0; i < 2; i++) - { - rc = is_slot_marked_successful(i); + for (size_t i = 0; i < 2; i++) { + rc = impl->isSlotMarkedSuccessful(i); if (rc < 0) return rc; slots[i].successful = rc; - rc = is_slot_bootable(i); + rc = impl->isSlotBootable(i); if (rc < 0) return rc; slots[i].bootable = rc; @@ -792,110 +120,104 @@ int get_slot_info(struct slot_info *slots) { return 0; } -void dump_info() { - struct slot_info slots[2] = {{0}}; - int current_slot = get_current_slot(); - +void dump_info() +{ + struct slot_info slots[2] = { { 0 } }; + int current_slot = impl->getCurrentSlot(); + get_slot_info(slots); - printf("Current slot: %s\n", current_slot >= 0 ? slot_suffix_arr[current_slot] : "N/A"); - for (size_t i = 0; i < 2; i++) - { - printf("SLOT %s:\n", slot_suffix_arr[i]); + printf("Current slot: %s\n", + current_slot >= 0 ? impl->getSuffix(current_slot) : "N/A"); + for (size_t i = 0; i < 2; i++) { + printf("SLOT %s:\n", impl->getSuffix(i)); printf("\tActive : %d\n", slots[i].active); printf("\tSuccessful : %d\n", slots[i].successful); printf("\tBootable : %d\n", slots[i].bootable); } } -int main (int argc, char **argv) { +int main(int argc, char **argv) +{ int optflag; int slot = -1; int rc; - char *end; - switch(argc) { + const char* IS_TEST = getenv("QBOOTCTL_TEST"); + if (IS_TEST) { + impl = &bootctl_test; + } + + switch (argc) { case 1: dump_info(); return 0; case 2: break; case 3: - slot = (int)strtol(argv[2], &end, 10); - printf("Using slot %d\n", slot); - if (end == argv[2] || slot < 0 || slot > 1) { - fprintf(stderr, "Expected slot to be '0' or '1' not '%s'\n", argv[2]); - return 1; - } + slot = parseSlot(argv[2]); break; default: return usage(); } if (slot < 0) - slot = get_current_slot(); + slot = impl->getCurrentSlot(); optflag = getopt(argc, argv, "hcmas:ub:n:x"); - switch(optflag) { + switch (optflag) { case 'c': - slot = get_current_slot(); - printf("Current slot: %s\n", slot_suffix_arr[slot]); + slot = impl->getCurrentSlot(); + printf("Current slot: %s\n", impl->getSuffix(slot)); return 0; case 'a': - slot = get_active_boot_slot(); - printf("Active slot: %s\n", slot_suffix_arr[slot]); + slot = impl->getActiveBootSlot(); + printf("Active slot: %s\n", impl->getSuffix(slot)); return 0; case 'b': - printf("SLOT %s: is %smarked bootable\n", slot_suffix_arr[slot], - is_slot_bootable(slot) == 1 ? "" : "not "); + printf("SLOT %s: is %smarked bootable\n", impl->getSuffix(slot), + impl->isSlotBootable(slot) == 1 ? "" : "not "); return 0; case 'n': - printf("SLOT %s: is %smarked successful\n", slot_suffix_arr[slot], - is_slot_marked_successful(slot) == 1 ? "" : "not "); + printf("SLOT %s: is %smarked successful\n", + impl->getSuffix(slot), + impl->isSlotMarkedSuccessful(slot) == 1 ? "" : "not "); return 0; case 'x': - printf("%s\n", slot_suffix_arr[slot]); + printf("%s\n", impl->getSuffix(slot)); return 0; case 's': - rc = set_active_boot_slot(slot); + rc = impl->setActiveBootSlot(slot); if (rc < 0) { fprintf(stderr, "SLOT %s: Failed to set active\n", - slot_suffix_arr[slot]); + impl->getSuffix(slot)); return 1; } printf("SLOT %d: Set as active slot\n", slot); return 0; case 'm': - rc = mark_boot_successful(slot); + rc = impl->markBootSuccessful(slot); if (rc < 0) return 1; - printf("SLOT %s: Marked boot successful\n", slot_suffix_arr[slot]); + printf("SLOT %s: Marked boot successful\n", + impl->getSuffix(slot)); return 0; case 'u': - rc = set_slot_as_unbootable(slot); + rc = impl->setSlotAsUnbootable(slot); if (rc < 0) { - fprintf(stderr, "SLOT %s: Failed to set as unbootable\n", - slot_suffix_arr[slot]); + fprintf(stderr, + "SLOT %s: Failed to set as unbootable\n", + impl->getSuffix(slot)); return 1; } - printf("SLOT %s: Set as unbootable\n", slot_suffix_arr[slot]); + printf("SLOT %s: Set as unbootable\n", impl->getSuffix(slot)); return 0; case 'h': default: usage(); return 0; } -// printf("======= Current slot: %d\n", get_current_slot()); -// printf("======= isslotbootable: a = %d, b = %d\n", is_slot_bootable(0), -// is_slot_bootable(1)); -// printf("======= markBootSuccessful: %d\n", bootctl->markBootSuccessful()); -// printf("======= isSlotMarkedSuccessful: a = %d, b = %d\n", bootctl->isSlotMarkedSuccessful(0), -// bootctl->isSlotMarkedSuccessful(1)); -// printf("\n\n\n trying to switch to slot b: %d\n", -// bootctl->setActiveBootSlot(1)); return 0; } - - diff --git a/ufs-bsg.cpp b/ufs-bsg.cpp index dd9de6a..592f803 100644 --- a/ufs-bsg.cpp +++ b/ufs-bsg.cpp @@ -76,131 +76,138 @@ int ufs_bsg_dev_open(void) { - int ret; - if (!fd_ufs_bsg) { - fd_ufs_bsg = open(ufs_bsg_dev, O_RDWR); - ret = errno; - if (fd_ufs_bsg < 0) { - fprintf(stderr, "Unable to open %s (error no: %d)", - ufs_bsg_dev, errno); - fd_ufs_bsg = 0; - return ret; - } - } - return 0; + int ret; + if (!fd_ufs_bsg) { + fd_ufs_bsg = open(ufs_bsg_dev, O_RDWR); + ret = errno; + if (fd_ufs_bsg < 0) { + fprintf(stderr, "Unable to open %s (error no: %d)", + ufs_bsg_dev, errno); + fd_ufs_bsg = 0; + return ret; + } + } + return 0; } void ufs_bsg_dev_close(void) { - if (fd_ufs_bsg) { - close(fd_ufs_bsg); - fd_ufs_bsg = 0; - } + if (fd_ufs_bsg) { + close(fd_ufs_bsg); + fd_ufs_bsg = 0; + } } static int ufs_bsg_ioctl(int fd, struct ufs_bsg_request *req, - struct ufs_bsg_reply *rsp, __u8 *buf, __u32 buf_len, - enum bsg_ioctl_dir dir) + struct ufs_bsg_reply *rsp, __u8 *buf, __u32 buf_len, + enum bsg_ioctl_dir dir) { - int ret; - struct sg_io_v4 sg_io{}; - - sg_io.guard = 'Q'; - sg_io.protocol = BSG_PROTOCOL_SCSI; - sg_io.subprotocol = BSG_SUB_PROTOCOL_SCSI_TRANSPORT; - sg_io.request_len = sizeof(*req); - sg_io.request = (__u64)req; - sg_io.response = (__u64)rsp; - sg_io.max_response_len = sizeof(*rsp); - if (dir == BSG_IOCTL_DIR_FROM_DEV) { - sg_io.din_xfer_len = buf_len; - sg_io.din_xferp = (__u64)(buf); - } else { - sg_io.dout_xfer_len = buf_len; - sg_io.dout_xferp = (__u64)(buf); - } - - ret = ioctl(fd, SG_IO, &sg_io); - if (ret) - fprintf(stderr, "%s: Error from sg_io ioctl (return value: %d, error no: %d, reply result from LLD: %d\n)", - __func__, ret, errno, rsp->result); - - if (sg_io.info || rsp->result) { - fprintf(stderr, "%s: Error from sg_io info (check sg info: device_status: 0x%x, transport_status: 0x%x, driver_status: 0x%x, reply result from LLD: %d\n)", - __func__, sg_io.device_status, sg_io.transport_status, - sg_io.driver_status, rsp->result); - ret = -EAGAIN; - } - - return ret; + int ret; + struct sg_io_v4 sg_io { + }; + + sg_io.guard = 'Q'; + sg_io.protocol = BSG_PROTOCOL_SCSI; + sg_io.subprotocol = BSG_SUB_PROTOCOL_SCSI_TRANSPORT; + sg_io.request_len = sizeof(*req); + sg_io.request = (__u64)req; + sg_io.response = (__u64)rsp; + sg_io.max_response_len = sizeof(*rsp); + if (dir == BSG_IOCTL_DIR_FROM_DEV) { + sg_io.din_xfer_len = buf_len; + sg_io.din_xferp = (__u64)(buf); + } else { + sg_io.dout_xfer_len = buf_len; + sg_io.dout_xferp = (__u64)(buf); + } + + ret = ioctl(fd, SG_IO, &sg_io); + if (ret) + fprintf(stderr, + "%s: Error from sg_io ioctl (return value: %d, error no: %d, reply result from LLD: %d\n)", + __func__, ret, errno, rsp->result); + + if (sg_io.info || rsp->result) { + fprintf(stderr, + "%s: Error from sg_io info (check sg info: device_status: 0x%x, transport_status: 0x%x, driver_status: 0x%x, reply result from LLD: %d\n)", + __func__, sg_io.device_status, sg_io.transport_status, + sg_io.driver_status, rsp->result); + ret = -EAGAIN; + } + + return ret; } static void compose_ufs_bsg_query_req(struct ufs_bsg_request *req, __u8 func, - __u8 opcode, __u8 idn, __u8 index, __u8 sel, - __u16 length) + __u8 opcode, __u8 idn, __u8 index, + __u8 sel, __u16 length) { - struct utp_upiu_header *hdr = &req->upiu_req.header; - struct utp_upiu_query *qr = &req->upiu_req.qr; - - req->msgcode = UTP_UPIU_QUERY_REQ; - hdr->dword_0 = DWORD(UTP_UPIU_QUERY_REQ, 0, 0, 0); - hdr->dword_1 = DWORD(0, func, 0, 0); - hdr->dword_2 = DWORD(0, 0, length >> 8, (__u8)length); - qr->opcode = opcode; - qr->idn = idn; - qr->index = index; - qr->selector = sel; - qr->length = htobe16(length); + struct utp_upiu_header *hdr = &req->upiu_req.header; + struct utp_upiu_query *qr = &req->upiu_req.qr; + + req->msgcode = UTP_UPIU_QUERY_REQ; + hdr->dword_0 = DWORD(UTP_UPIU_QUERY_REQ, 0, 0, 0); + hdr->dword_1 = DWORD(0, func, 0, 0); + hdr->dword_2 = DWORD(0, 0, length >> 8, (__u8)length); + qr->opcode = opcode; + qr->idn = idn; + qr->index = index; + qr->selector = sel; + qr->length = htobe16(length); } - -static int ufs_query_attr(int fd, __u32 value, - __u8 func, __u8 opcode, __u8 idn, - __u8 index, __u8 sel) +static int ufs_query_attr(int fd, __u32 value, __u8 func, __u8 opcode, __u8 idn, + __u8 index, __u8 sel) { - struct ufs_bsg_request req{}; - struct ufs_bsg_reply rsp{}; - enum bsg_ioctl_dir dir = BSG_IOCTL_DIR_FROM_DEV; - int ret = 0; + struct ufs_bsg_request req { + }; + struct ufs_bsg_reply rsp { + }; + enum bsg_ioctl_dir dir = BSG_IOCTL_DIR_FROM_DEV; + int ret = 0; - if (opcode == QUERY_REQ_OP_WRITE_DESC || opcode == QUERY_REQ_OP_WRITE_ATTR) - dir = BSG_IOCTL_DIR_TO_DEV; + if (opcode == QUERY_REQ_OP_WRITE_DESC || + opcode == QUERY_REQ_OP_WRITE_ATTR) + dir = BSG_IOCTL_DIR_TO_DEV; - req.upiu_req.qr.value = htobe32(value); + req.upiu_req.qr.value = htobe32(value); - compose_ufs_bsg_query_req(&req, func, opcode, idn, index, sel, 0); + compose_ufs_bsg_query_req(&req, func, opcode, idn, index, sel, 0); - ret = ufs_bsg_ioctl(fd, &req, &rsp, 0, 0, dir); - if (ret) - fprintf(stderr, "%s: Error from ufs_bsg_ioctl (return value: %d, error no: %d\n)", - __func__, ret, errno); + ret = ufs_bsg_ioctl(fd, &req, &rsp, 0, 0, dir); + if (ret) + fprintf(stderr, + "%s: Error from ufs_bsg_ioctl (return value: %d, error no: %d\n)", + __func__, ret, errno); - return ret; + return ret; } int32_t set_boot_lun(__u8 lun_id) { - int32_t ret; - __u32 boot_lun_id = lun_id; - -// ret = get_ufs_bsg_dev(); -// if (ret) -// return ret; - LOGD("Using UFS bsg device: %s\n", ufs_bsg_dev); - - ret = ufs_bsg_dev_open(); - if (ret) - return ret; - LOGD("Opened ufs bsg dev: %s\n", ufs_bsg_dev); - - ret = ufs_query_attr(fd_ufs_bsg, boot_lun_id, QUERY_REQ_FUNC_STD_WRITE, - QUERY_REQ_OP_WRITE_ATTR, QUERY_ATTR_IDN_BOOT_LU_EN, 0, 0); - if (ret) { - fprintf(stderr, "Error requesting ufs attr idn %d via query ioctl (return value: %d, error no: %d)", - QUERY_ATTR_IDN_BOOT_LU_EN, ret, errno); - goto out; - } + int32_t ret; + __u32 boot_lun_id = lun_id; + + // ret = get_ufs_bsg_dev(); + // if (ret) + // return ret; + LOGD("Using UFS bsg device: %s\n", ufs_bsg_dev); + + ret = ufs_bsg_dev_open(); + if (ret) + return ret; + LOGD("Opened ufs bsg dev: %s\n", ufs_bsg_dev); + + ret = ufs_query_attr(fd_ufs_bsg, boot_lun_id, QUERY_REQ_FUNC_STD_WRITE, + QUERY_REQ_OP_WRITE_ATTR, QUERY_ATTR_IDN_BOOT_LU_EN, + 0, 0); + if (ret) { + fprintf(stderr, + "Error requesting ufs attr idn %d via query ioctl (return value: %d, error no: %d)", + QUERY_ATTR_IDN_BOOT_LU_EN, ret, errno); + goto out; + } out: - ufs_bsg_dev_close(); - return ret; + ufs_bsg_dev_close(); + return ret; } diff --git a/ufs-bsg.h b/ufs-bsg.h index a581b31..d96e814 100644 --- a/ufs-bsg.h +++ b/ufs-bsg.h @@ -30,12 +30,11 @@ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -#define FNAME_SZ 64 +#define FNAME_SZ 64 -#define SG_IO 0x2285 +#define SG_IO 0x2285 -#define DWORD(b3, b2, b1, b0) htobe32((b3 << 24) | (b2 << 16) |\ - (b1 << 8) | b0) +#define DWORD(b3, b2, b1, b0) htobe32((b3 << 24) | (b2 << 16) | (b1 << 8) | b0) /* UFS BSG device node */ char ufs_bsg_dev[FNAME_SZ] = "/dev/bsg/ufs-bsg0"; @@ -44,52 +43,52 @@ int fd_ufs_bsg; /* UPIU Transaction Codes */ enum { - UTP_UPIU_NOP_OUT = 0x00, - UTP_UPIU_COMMAND = 0x01, - UTP_UPIU_DATA_OUT = 0x02, - UTP_UPIU_TASK_REQ = 0x04, - UTP_UPIU_QUERY_REQ = 0x16, + UTP_UPIU_NOP_OUT = 0x00, + UTP_UPIU_COMMAND = 0x01, + UTP_UPIU_DATA_OUT = 0x02, + UTP_UPIU_TASK_REQ = 0x04, + UTP_UPIU_QUERY_REQ = 0x16, }; /* UPIU Query Function field */ enum { - QUERY_REQ_FUNC_STD_READ = 0x01, - QUERY_REQ_FUNC_STD_WRITE = 0x81, + QUERY_REQ_FUNC_STD_READ = 0x01, + QUERY_REQ_FUNC_STD_WRITE = 0x81, }; enum query_req_opcode { - QUERY_REQ_OP_READ_DESC = 0x1, - QUERY_REQ_OP_WRITE_DESC = 0x2, - QUERY_REQ_OP_READ_ATTR = 0x3, - QUERY_REQ_OP_WRITE_ATTR = 0x4, - QUERY_REQ_OP_READ_FLAG = 0x5, - QUERY_REQ_OP_SET_FLAG = 0x6, - QUERY_REQ_OP_CLEAR_FLAG = 0x7, - QUERY_REQ_OP_TOGGLE_FLAG = 0x8, + QUERY_REQ_OP_READ_DESC = 0x1, + QUERY_REQ_OP_WRITE_DESC = 0x2, + QUERY_REQ_OP_READ_ATTR = 0x3, + QUERY_REQ_OP_WRITE_ATTR = 0x4, + QUERY_REQ_OP_READ_FLAG = 0x5, + QUERY_REQ_OP_SET_FLAG = 0x6, + QUERY_REQ_OP_CLEAR_FLAG = 0x7, + QUERY_REQ_OP_TOGGLE_FLAG = 0x8, }; enum query_desc_idn { - QUERY_DESC_IDN_DEVICE = 0x0, - QUERY_DESC_IDN_UNIT = 0x2, - QUERY_DESC_IDN_GEOMETRY = 0x7, + QUERY_DESC_IDN_DEVICE = 0x0, + QUERY_DESC_IDN_UNIT = 0x2, + QUERY_DESC_IDN_GEOMETRY = 0x7, }; enum query_desc_size { - QUERY_DESC_SIZE_DEVICE = 0x40, - QUERY_DESC_SIZE_GEOMETRY = 0x48, - QUERY_DESC_SIZE_UNIT = 0x23, + QUERY_DESC_SIZE_DEVICE = 0x40, + QUERY_DESC_SIZE_GEOMETRY = 0x48, + QUERY_DESC_SIZE_UNIT = 0x23, }; enum bsg_ioctl_dir { - BSG_IOCTL_DIR_TO_DEV, - BSG_IOCTL_DIR_FROM_DEV, + BSG_IOCTL_DIR_TO_DEV, + BSG_IOCTL_DIR_FROM_DEV, }; enum query_attr_idn { - QUERY_ATTR_IDN_BOOT_LU_EN = 0x00, - QUERY_ATTR_IDN_RESERVED = 0x01, - QUERY_ATTR_IDN_POWER_MODE = 0x02, - QUERY_ATTR_IDN_ACTIVE_ICC_LVL = 0x03, + QUERY_ATTR_IDN_BOOT_LU_EN = 0x00, + QUERY_ATTR_IDN_RESERVED = 0x01, + QUERY_ATTR_IDN_POWER_MODE = 0x02, + QUERY_ATTR_IDN_ACTIVE_ICC_LVL = 0x03, }; #endif /* __RECOVERY_UFS_BSG_H__ */