summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitri Pal <dpal@redhat.com>2009-04-06 09:30:01 -0400
committerStephen Gallagher <sgallagh@redhat.com>2009-04-06 15:59:21 -0400
commitde6d6fb21bf367a94c7d292f2c3decd24cf42868 (patch)
tree3eb3a5347eb9b39ede80984a3b2caade1cfa40c4
parent2ec952c6db27db1d5a21154e2683d1e862643ac8 (diff)
downloadsssd-de6d6fb21bf367a94c7d292f2c3decd24cf42868.tar.gz
sssd-de6d6fb21bf367a94c7d292f2c3decd24cf42868.tar.bz2
sssd-de6d6fb21bf367a94c7d292f2c3decd24cf42868.zip
First commit of basic collection API.
-rw-r--r--common/COPYING674
-rw-r--r--common/COPYING.LESSER165
-rw-r--r--common/Makefile.am1
-rw-r--r--common/README6
-rw-r--r--common/collection/Makefile.am17
-rw-r--r--common/collection/collection.c2481
-rw-r--r--common/collection/collection.h426
-rw-r--r--common/collection/collection_priv.h70
-rw-r--r--common/collection/collection_tools.c587
-rw-r--r--common/collection/collection_tools.h98
-rw-r--r--common/collection/collection_ut.c712
-rw-r--r--common/configure.ac25
-rw-r--r--common/trace/trace.h87
13 files changed, 5349 insertions, 0 deletions
diff --git a/common/COPYING b/common/COPYING
new file mode 100644
index 00000000..94a9ed02
--- /dev/null
+++ b/common/COPYING
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/common/COPYING.LESSER b/common/COPYING.LESSER
new file mode 100644
index 00000000..755013bb
--- /dev/null
+++ b/common/COPYING.LESSER
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/common/Makefile.am b/common/Makefile.am
new file mode 100644
index 00000000..5d39b42b
--- /dev/null
+++ b/common/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = collection
diff --git a/common/README b/common/README
new file mode 100644
index 00000000..a7db004a
--- /dev/null
+++ b/common/README
@@ -0,0 +1,6 @@
+TO BUILD EXECUTE:
+
+autoreconf
+./configure
+make
+
diff --git a/common/collection/Makefile.am b/common/collection/Makefile.am
new file mode 100644
index 00000000..06cf953b
--- /dev/null
+++ b/common/collection/Makefile.am
@@ -0,0 +1,17 @@
+#DEBUG_FLAGS=@DEBUG_VAR@
+TRACE_LEVEL=@TRACE_VAR@
+
+topdir=..
+AM_CPPFLAGS = -I$(topdir) -I$(topdir)/trace $(TRACE_LEVEL)
+
+# Build static libraty
+noinst_LIBRARIES = libcollection.a
+libcollection_a_SOURCES = collection.c collection_tools.c collection.h trace.h collection_tools.h collection_class.h
+
+# Build shared library - reserved for future
+# lib_LTLIBRARIES = libcollection.la
+# libcollection_la_SOURCES = collection.c collection_tools.c collection.h trace.h collection_tools.h collection_class.h
+
+noinst_PROGRAMS = collection_ut
+collection_ut_SOURCES = collection_ut.c
+collection_ut_LDADD = libcollection.a -lm -lz
diff --git a/common/collection/collection.c b/common/collection/collection.c
new file mode 100644
index 00000000..e393ae3d
--- /dev/null
+++ b/common/collection/collection.c
@@ -0,0 +1,2481 @@
+/*
+ COLLECTION LIBRARY
+
+ Implemenation of the collection library interface.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#define _GNU_SOURCE
+#include <string.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <ctype.h>
+#include <time.h>
+#include "trace.h"
+
+/* The collection should use the teal structures */
+#include "collection_priv.h"
+#include "collection.h"
+
+
+/* Internal constants defined to denote actions that can be performed by find handler */
+#define COLLECTION_ACTION_FIND 1
+#define COLLECTION_ACTION_DEL 2
+#define COLLECTION_ACTION_UPDATE 3
+#define COLLECTION_ACTION_GET 4
+
+
+/* Special internal error code to indicate that collection search was interrupted */
+#define EINTR_INTERNAL 10000
+
+
+/* Potential subjest for management with libtools */
+#define DATE_FORMAT "%c"
+
+#define TIME_ARRAY_SIZE 100
+
+
+/* Struct used for passing parameter for update operation */
+struct update_property {
+ int type;
+ void *data;
+ int length;
+ int found;
+};
+
+/* Dummy structure */
+struct collection_item dummy = { NULL, "", 0, COL_TYPE_END, 0, NULL };
+
+/******************** FUNCTION DECLARATIONS ****************************/
+
+/* Have to declare those due to function cross referencing */
+static int find_item_and_do(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data,
+ int action);
+
+/* Traverse callback for find & delete function */
+static int act_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop);
+
+/* Traverse callback signature */
+typedef int (*internal_item_fn)(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop);
+
+/******************** SUPPLIMENTARY FUNCTIONS ****************************/
+
+
+/* BASIC OPERATIONS */
+/* Function that checks if property can be added */
+static int validate_property(char *property)
+{
+ TRACE_FLOW_STRING("validate_property","Entry point.");
+ /* Only alpha numeric characters are allowed in names of the properties */
+ int invalid = 0;
+ char *check;
+
+ check = property;
+ while(*check != '\0') {
+ if((!isalnum((int)(*check))) && (!ispunct((int)(*check)))) {
+ invalid = 1;
+ break;
+ }
+ check++;
+ }
+ TRACE_FLOW_NUMBER("validate_property. Returning ",invalid);
+ return invalid;
+}
+
+
+
+/* Function that cleans the item */
+static void delete_item(struct collection_item *item)
+{
+ TRACE_FLOW_STRING("delete_item","Entry point.");
+
+ if(item == (struct collection_item *)NULL) return;
+
+ if(item->property != NULL) free(item->property);
+ if(item->data != NULL) free(item->data);
+
+ free(item);
+
+ TRACE_FLOW_STRING("delete_item","Exit.");
+}
+
+/* A generic function to allocate a property item */
+static int allocate_item(struct collection_item **ci,char *property,void *item_data,int length, int type)
+{
+ struct collection_item *item = NULL;
+ int error = 0;
+ errno = 0;
+
+ TRACE_FLOW_STRING("allocate_item","Entry point.");
+ TRACE_INFO_NUMBER("Will be using type:",type);
+
+ /* Check the length */
+ if(length >= COL_MAX_DATA) {
+ TRACE_ERROR_STRING("allocate_item","Data to long.");
+ return EMSGSIZE;
+ }
+
+ if(validate_property(property)) {
+ TRACE_ERROR_STRING("Invalid chracters in the property name",property);
+ return EINVAL;
+ }
+
+ /* Allocate memory for the structure */
+ item = (struct collection_item *)(malloc(sizeof(struct collection_item)));
+ if(item == (struct collection_item *)(NULL)) {
+ error = errno;
+ TRACE_ERROR_STRING("allocate_item","Malloc failed.");
+ return error;
+ }
+
+ /* After we initialize "next" we can use delete_item() in case of error */
+ item->next = (struct collection_item *)(NULL);
+
+ /* Copy property */
+ item->property = strdup(property);
+ if(item->property == NULL) {
+ error = errno;
+ TRACE_ERROR_STRING("allocate_item","Failed to dup property.");
+ delete_item(item);
+ return error;
+ }
+
+ item->property_len = strlen(item->property);
+
+ /* Deal with data */
+ item->data = malloc(length);
+ if(item->data == NULL) {
+ TRACE_ERROR_STRING("allocate_item","Failed to dup data.");
+ delete_item(item);
+ return errno;
+ }
+ memcpy(item->data,item_data,length);
+
+ /* Deal with other properties of the item */
+ TRACE_INFO_NUMBER("About to set type to:",type);
+ item->type = type;
+ item->length = length;
+
+ /* Make sure that data is NULL terminated in case of string */
+ if(type == COL_TYPE_STRING) *(((char *)(item->data))+length-1) = '\0';
+
+ *ci = item;
+
+ TRACE_INFO_STRING("Item property",item->property);
+ TRACE_INFO_NUMBER("Item property type",item->type);
+ TRACE_INFO_NUMBER("Item data length",item->length);
+ TRACE_FLOW_STRING("allocate_item","Success exit.");
+ return 0;
+}
+
+/* Add item to the end of collection */
+/* Can add itself to itself - nice...*/
+static int add_item_to_collection(struct collection_item *collection,struct collection_item *item)
+{
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("add_item_to_collection","Entry point.");
+
+ if(collection == (struct collection_item *)(NULL)) {
+ TRACE_INFO_STRING("add_item_to_collection","Collection accepting is NULL");
+ if((item != (struct collection_item *)(NULL)) &&
+ (item->type == COL_TYPE_COLLECTION)) {
+ /* This is a special case of self creation */
+ TRACE_INFO_STRING("add_item_to_collection","Adding header item to new collection.");
+ collection = item;
+ }
+ }
+
+ /* We can add items only to collections */
+ if(collection->type != COL_TYPE_COLLECTION) {
+ TRACE_ERROR_STRING("add_item_to_collection","Attempt to add item to non collection.");
+ TRACE_ERROR_STRING("Collection name:",collection->property);
+ TRACE_ERROR_NUMBER("Collection type:",collection->type);
+ return EINVAL;
+ }
+
+ header = (struct collection_header *)(collection->data);
+
+ /* Link new item to the last item in the list if there any */
+ if(header->last != (struct collection_item *)(NULL)) (header->last)->next = item;
+
+ /* Make sure we save a new last element */
+ header->last = item;
+ header->count++;
+
+ TRACE_INFO_STRING("Collection:",collection->property);
+ TRACE_INFO_STRING("Just added item is:",item->property);
+ TRACE_INFO_NUMBER("Item type.",item->type);
+ TRACE_INFO_NUMBER("Number of items in collection now is.",header->count);
+
+ TRACE_FLOW_STRING("add_item_to_collection","Success exit.");
+ return EOK;
+}
+
+
+/* TRAVERSE HANDLERS */
+
+/* Special handler to just set a flag if the item is found */
+inline static int is_in_item_handler(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *found,
+ int *dummy)
+{
+ TRACE_FLOW_STRING("is_in_item_handler","Entry.");
+ TRACE_INFO_STRING("Property:",property);
+ TRACE_INFO_NUMBER("Property length:",property_len);
+ TRACE_INFO_NUMBER("Type:",type);
+ TRACE_INFO_NUMBER("Length:",length);
+
+ *((int *)(found)) = COL_MATCH;
+
+ TRACE_FLOW_STRING("is_in_item_handler","Success Exit.");
+
+ return EOK;
+}
+
+/* Special handler to retrieve the sub collection */
+inline static int get_subcollection(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *found,
+ int *dummy)
+{
+ TRACE_FLOW_STRING("get_subcollection","Entry.");
+ TRACE_INFO_STRING("Property:",property);
+ TRACE_INFO_NUMBER("Property length:",property_len);
+ TRACE_INFO_NUMBER("Type:",type);
+ TRACE_INFO_NUMBER("Length:",length);
+
+ *((struct collection_item **)(found)) = *((struct collection_item **)(data));
+
+ TRACE_FLOW_STRING("get_subcollection","Success Exit.");
+
+ return EOK;
+
+}
+
+
+/* ADD PROPERTY */
+
+/* Add a single property to a collection. Returns a pointer to a newly allocated property */
+static struct collection_item *add_property(struct collection_item *collection,
+ char *subcollection,
+ char *property,
+ void *item_data,
+ int length,
+ int type,
+ int *error)
+{
+ struct collection_item *item;
+ struct collection_item *acceptor = (struct collection_item *)(NULL);
+
+ TRACE_FLOW_STRING("add_property","Entry.");
+ /* Allocate item */
+
+ TRACE_INFO_NUMBER("Property type to add",type);
+ *error = allocate_item(&item,property,item_data,length, type);
+ if(*error) return (struct collection_item *)(NULL);
+
+ TRACE_INFO_STRING("Created item:",item->property);
+ TRACE_INFO_NUMBER("Item has type:",item->type);
+
+ /* Add item to collection */
+ if(subcollection == NULL) acceptor = collection;
+ else {
+ TRACE_INFO_STRING("Subcollection id not null, searching",subcollection);
+ *error = find_item_and_do(collection, subcollection, COL_TYPE_COLLECTIONREF,
+ COL_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&acceptor),COLLECTION_ACTION_FIND);
+ if(*error) {
+ TRACE_ERROR_NUMBER("Search for subcollection returned error:",*error);
+ delete_item(item);
+ return (struct collection_item *)(NULL);
+ }
+
+ if(acceptor == (struct collection_item *)(NULL)) {
+ TRACE_ERROR_STRING("Search for subcollection returned NULL pointer","");
+ delete_item(item);
+ *error=ENOENT;
+ return (struct collection_item *)(NULL);
+ }
+
+ }
+ *error = add_item_to_collection(acceptor,item);
+ if(*error) {
+ TRACE_ERROR_NUMBER("Failed to add item to collection error:",*error);
+ delete_item(item);
+ return (struct collection_item *)(NULL);
+ }
+
+ TRACE_FLOW_STRING("add_property","Success Exit.");
+ return item;
+}
+
+/* CLEANUP */
+
+/* Cleans the collection tree including current item. */
+/* After the execution passed in variable should not be used - memory is gone!!! */
+static void delete_collection(struct collection_item *ci)
+{
+ struct collection_item *other_collection;
+
+ TRACE_FLOW_STRING("delete_collection","Entry.");
+
+ if(ci == (struct collection_item *)(NULL)) {
+ TRACE_FLOW_STRING("delete_collection","Nothing to do Exit.");
+ return;
+ }
+
+ TRACE_INFO_STRING("Real work to do","");
+
+ delete_collection(ci->next);
+
+ /* Handle external or embedded collection */
+ if(ci->type == COL_TYPE_COLLECTIONREF) {
+ /* Our data is a pointer to a whole external collection so dereference it or delete */
+ other_collection = *((struct collection_item **)(ci->data));
+ destroy_collection(other_collection);
+ }
+
+ /* Delete this item */
+ delete_item(ci);
+ TRACE_FLOW_STRING("delete_collection","Exit.");
+}
+
+
+/* NAME MANAGEMENT - used by search */
+
+/* Internal data structures used for search */
+
+struct path_data {
+ char *name;
+ int length;
+ struct path_data *previous_path;
+};
+
+struct find_name {
+ char *name_to_find;
+ int name_len_to_find;
+ int type_to_match;
+ char *given_name;
+ int given_len;
+ struct path_data *current_path;
+ int action;
+};
+
+/* Create a new name */
+static int create_path_data(struct path_data **name_path,
+ char *name, int length,
+ char *property, int property_len)
+{
+ int error = EOK;
+ struct path_data *new_name_path;
+
+ TRACE_FLOW_STRING("create_path_data","Entry.");
+
+ TRACE_INFO_STRING("Constructing path from name:",name);
+ TRACE_INFO_STRING("Constructing path from property:",property);
+
+ /* Allocate structure */
+ errno = 0;
+ new_name_path = (struct path_data *)(malloc(sizeof(struct path_data)));
+ if(new_name_path == (struct path_data *)(NULL)) return errno;
+
+ new_name_path->name=malloc(length+property_len+2);
+ if(new_name_path->name == NULL) {
+ error = errno;
+ TRACE_ERROR_NUMBER("Failed to allocate memory for new path name. Errno",error);
+ free((void *)(new_name_path));
+ return error;
+ }
+
+ /* Construct the new name */
+ new_name_path->length = 0;
+
+ if(length > 0) {
+ memcpy(new_name_path->name,name,length);
+ new_name_path->length = length;
+ *(new_name_path->name+new_name_path->length) = '.';
+ new_name_path->length++;
+ *(new_name_path->name+new_name_path->length) = '\0';
+ TRACE_INFO_STRING("Name so far:",new_name_path->name);
+ TRACE_INFO_NUMBER("Len so far:",new_name_path->length);
+ }
+ memcpy(new_name_path->name+new_name_path->length,property,property_len);
+ new_name_path->length += property_len;
+ *(new_name_path->name + new_name_path->length) = '\0';
+
+ /* Link to the chain */
+ new_name_path->previous_path = *name_path;
+ *name_path = new_name_path;
+
+ TRACE_INFO_STRING("Constructed path",new_name_path->name);
+
+
+ TRACE_FLOW_NUMBER("create_path_data. Returning:",error);
+ return error;
+}
+
+/* Matching item name and type */
+static int match_item(struct collection_item *current,
+ struct find_name *traverse_data)
+{
+
+ char *find_str;
+ char *start;
+ char *data_str;
+
+ TRACE_FLOW_STRING("match_item","Entry");
+
+ if(traverse_data->type_to_match & current->type) {
+ /* Check if there is any value to match */
+ if((traverse_data->name_to_find == NULL) ||
+ (*(traverse_data->name_to_find) == '\0')) {
+ TRACE_INFO_STRING("match_item","Returning MATCH because there is no search criteria!");
+ return COL_MATCH;
+ }
+
+ /* Start comparing the two strings from the end */
+ find_str = traverse_data->name_to_find + traverse_data->name_len_to_find;
+ start = current->property;
+ data_str = start + current->property_len;
+
+ TRACE_INFO_STRING("Searching for:",traverse_data->name_to_find);
+ TRACE_INFO_STRING("Item name:",current->property);
+ TRACE_INFO_STRING("Current path:",traverse_data->current_path->name);
+ TRACE_INFO_NUMBER("Searching:",toupper(*find_str));
+ TRACE_INFO_NUMBER("Have:",toupper(*data_str));
+
+ /* We start pointing to 0 so the loop will be executed at least once */
+ while(toupper(*data_str) == toupper(*find_str)) {
+
+ TRACE_INFO_STRING("Loop iteration:","");
+
+ if(data_str == start) {
+ if(find_str > traverse_data->name_to_find) {
+ if(*(find_str-1) == '.') {
+ /* We matched the property but the search string is longer */
+ /* so we need to continue matching */
+ TRACE_INFO_STRING("match_item","Need to continue matching");
+ start = traverse_data->current_path->name;
+ data_str = start + traverse_data->current_path->length - 1;
+ find_str-=2;
+ continue;
+ }
+ else {
+ TRACE_INFO_STRING("match_item","Returning NO match!");
+ return COL_NOMATCH;
+ }
+ }
+ else {
+ TRACE_INFO_STRING("match_item","Returning MATCH!");
+ return COL_MATCH;
+ }
+ }
+ else if((find_str == traverse_data->name_to_find) &&
+ (*(data_str-1) == '.')) return COL_MATCH;
+
+ data_str--;
+ find_str--;
+ TRACE_INFO_NUMBER("Searching:",toupper(*find_str));
+ TRACE_INFO_NUMBER("Have:",toupper(*data_str));
+
+ }
+ }
+
+ TRACE_FLOW_STRING("match_item","Returning NO match!");
+ return COL_NOMATCH;
+
+}
+
+/* Function to delete the data that contains search path */
+static void delete_path_data(struct path_data *path)
+{
+ TRACE_FLOW_STRING("delete_path_data","Entry.");
+
+ if(path!= (struct path_data *)(NULL)) {
+ TRACE_INFO_STRING("delete_path_data","Item to delete exits.");
+ if(path->previous_path != (struct path_data *)(NULL)) {
+ TRACE_INFO_STRING("delete_path_data","But previous item to delete exits to. Nesting.");
+ delete_path_data(path->previous_path);
+ }
+ if(path->name != NULL) {
+ TRACE_INFO_STRING("delete_path_data Deleting path:",path->name);
+ free(path->name);
+ }
+ TRACE_INFO_STRING("delete_path_data","Deleting path element");
+ free((void *)(path));
+ }
+ TRACE_FLOW_STRING("delete_path_data","Exit");
+}
+
+
+/* MAIN TRAVERSAL FUNCTION */
+
+/* Internal function to walk collection */
+/* For each item walked it will call traverse handler.
+ Traverse handler accepts: current item,
+ user provided item handler and user provided custom data. */
+/* See below defferent traverse handlers for different cases */
+static int walk_items(struct collection_item *ci,
+ int mode_flags,
+ internal_item_fn traverse_handler,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data) {
+
+ struct collection_item *current;
+ struct collection_item *parent;
+ struct collection_item *sub;
+ int stop = 0;
+ int error = EOK;
+
+ TRACE_FLOW_STRING("walk_items","Entry.");
+ TRACE_INFO_NUMBER("Mode flags:",mode_flags);
+
+ current = ci;
+
+ while(current != (struct collection_item *)(NULL)) {
+
+ TRACE_INFO_STRING("Processing item:",current->property);
+ TRACE_INFO_NUMBER("Item type:",current->type);
+
+ if(current->type == COL_TYPE_COLLECTIONREF) {
+
+ TRACE_INFO_STRING("Subcollection:",current->property);
+
+ if((mode_flags & COL_TRAVERSE_IGNORE) == 0) {
+
+ TRACE_INFO_STRING("Subcollection is not ignored.","");
+
+ /* We are not ignoring sub collections */
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+ if(stop != 0) {
+ TRACE_INFO_STRING("Traverse handler returned STOP.","");
+ error = EINTR_INTERNAL;
+ }
+ /* Check what error we got */
+ if(error == EINTR_INTERNAL) {
+ TRACE_FLOW_NUMBER("Internal error - means we are stopping.",error);
+ return error;
+ }
+ else if(error) {
+ TRACE_ERROR_NUMBER("Traverse handler returned error.",error);
+ return error;
+ }
+
+ if((mode_flags & COL_TRAVERSE_ONELEVEL) == 0) {
+ TRACE_INFO_STRING("Before diving into sub collection","");
+ sub = *((struct collection_item **)(current->data));
+ TRACE_INFO_STRING("Sub collection name",sub->property);
+ TRACE_INFO_NUMBER("Header type",sub->type);
+ /* We need to go into sub collections */
+ error = walk_items(sub, mode_flags,traverse_handler,traverse_data,
+ user_item_handler, custom_data);
+ TRACE_INFO_STRING("Returned from sub collection processing","");
+ TRACE_INFO_STRING("Done processing item:",current->property);
+ TRACE_INFO_NUMBER("Done processing item type:",current->type);
+
+ }
+ }
+ }
+ else
+ /* Call handler then move on */
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+
+ /* If we are stopped - return EINTR_INTERNAL */
+ if(stop != 0) {
+ TRACE_INFO_STRING("Traverse handler returned STOP.","");
+ error = EINTR_INTERNAL;
+ }
+ /* Check what error we got */
+ if(error == EINTR_INTERNAL) {
+ TRACE_FLOW_NUMBER("Internal error - means we are stopping.",error);
+ return error;
+ }
+ else if(error) {
+ TRACE_ERROR_NUMBER("Traverse handler returned error.",error);
+ return error;
+ }
+
+ parent = current;
+ current = current->next;
+
+ }
+
+ TRACE_INFO_STRING("Out of loop","");
+
+ if((mode_flags & COL_TRAVERSE_END) != 0) {
+ TRACE_INFO_STRING("About to do the special end collection invocation of handler","");
+ error = traverse_handler(ci,parent,current,traverse_data,user_item_handler,custom_data,&stop);
+ }
+
+ TRACE_FLOW_NUMBER("walk_items. Returns: ",error);
+ return error;
+}
+
+
+/* ACTION */
+
+/* Find an item by property name and perform an action on it. */
+/* No pattern matching supported in the first implementation. */
+/* To refer to child properties use dotted notatation like this: */
+/* parent.child.subchild.subsubchild etc. */
+static int find_item_and_do(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data,
+ int action)
+{
+
+ int error = EOK;
+ struct find_name *traverse_data = NULL;
+
+ TRACE_FLOW_STRING("find_item_and_do","Entry.");
+
+ /* Item handler is always required */
+ if((item_handler == (item_fn)(NULL)) && (action ==COLLECTION_ACTION_FIND)) {
+ TRACE_ERROR_NUMBER("No item handler - returning error!",EINVAL);
+ return EINVAL;
+ }
+
+ /* Make sure that there is anything to search */
+ type &= COL_TYPE_ANY;
+ if((ci == (struct collection_item *)(NULL)) ||
+ ((property_to_find == NULL) && (type == 0)) ||
+ ((*property_to_find == '\0') && (type == 0))) {
+ TRACE_ERROR_NUMBER("No item search criteria specified - returning error!",ENOKEY);
+ return ENOKEY;
+ }
+ /* Prepare data for traversal */
+ errno = 0;
+ traverse_data= (struct find_name *)(malloc(sizeof(struct find_name)));
+ if(traverse_data == (struct find_name *)(NULL)) {
+ error = errno;
+ TRACE_ERROR_NUMBER("Failed to allocate traverse data memory - returning error!",errno);
+ return error;
+ }
+
+ TRACE_INFO_STRING("find_item_and_do","Filling in traverse data.");
+
+ traverse_data->name_to_find = property_to_find;
+ traverse_data->name_len_to_find = strlen(property_to_find);
+ traverse_data->type_to_match = type;
+ traverse_data->given_name = NULL;
+ traverse_data->given_len = 0;
+ traverse_data->current_path = (struct path_data *)(NULL);
+ traverse_data->action = action;
+
+ mode_flags |= COL_TRAVERSE_END;
+
+ TRACE_INFO_STRING("find_item_and_do","About to walk the tree.");
+ TRACE_INFO_NUMBER("Traverse flags",mode_flags);
+
+ error = walk_items(ci, mode_flags, act_traverse_handler,
+ (void *)traverse_data, item_handler, custom_data);
+
+ if(traverse_data->current_path != (struct path_data *)(NULL)) {
+ TRACE_INFO_STRING("find_item_and_do","Path was not cleared - deleting");
+ delete_path_data(traverse_data->current_path);
+ }
+
+ free((void *)(traverse_data));
+
+ if((error) && (error != EINTR_INTERNAL)) {
+ TRACE_ERROR_NUMBER("Walk items returned error. Returning: ",error);
+ return error;
+ }
+ else {
+ TRACE_FLOW_STRING("Walk items returned SUCCESS.","");
+ return EOK;
+ }
+}
+
+/* Function to replace data in the item */
+static int update_current_item(struct collection_item *current,
+ struct update_property *update_data)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_current_item","Entry");
+
+ /* If type is different or same but it is string or binary we need to replace the storage */
+ if((current->type != update_data->type) ||
+ ((current->type == update_data->type) &&
+ ((current->type == COL_TYPE_STRING) || (current->type == COL_TYPE_BINARY)))) {
+ TRACE_INFO_STRING("Replacing item data buffer","");
+ free(current->data);
+ current->data = malloc(update_data->length);
+ if(current->data == NULL) {
+ TRACE_ERROR_STRING("Failed to allocate memory","");
+ current->length = 0;
+ return ENOMEM;
+ }
+ current->length = update_data->length;
+ }
+
+ TRACE_INFO_STRING("Overwriting item data","");
+ memcpy(current->data,update_data->data,current->length);
+ current->type = update_data->type;
+
+ if(current->type == COL_TYPE_STRING) *(((char *)(current->data))+current->length-1) = '\0';
+
+ TRACE_FLOW_STRING("update_current_item","Exit");
+ return EOK;
+}
+
+/* TRAVERSE CALLBACKS */
+
+/* Traverse handler for simple traverse function */
+/* Handler must be able to deal with NULL current item */
+inline static int simple_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("simple_traverse_handler","Entry.");
+
+ if(current == (struct collection_item *)(NULL)) current = &dummy;
+
+ error = user_item_handler(current->property,
+ current->property_len,
+ current->type,
+ current->data,
+ current->length,
+ custom_data,
+ stop);
+
+ TRACE_FLOW_NUMBER("simple_traverse_handler. Returning:",error);
+ return error;
+}
+
+
+/* Traverse callback for find & delete function */
+static int act_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+ struct find_name *traverse_data = NULL;
+ char *name;
+ int length;
+ struct path_data *temp;
+ struct collection_header *header;
+ struct collection_item *other;
+ char *property;
+ int property_len;
+ struct update_property *update_data;
+
+ TRACE_FLOW_STRING("act_traverse_handler","Entry.");
+
+ traverse_data = (struct find_name *)(passed_traverse_data);
+
+ /* We can be called when current points to NULL */
+ if(current==(struct collection_item *)(NULL)) {
+ TRACE_INFO_STRING("act_traverse_handler","Special call at the end of the collection.");
+ temp = traverse_data->current_path;
+ traverse_data->current_path = temp->previous_path;
+ temp->previous_path = (struct path_data *)(NULL);
+ delete_path_data(temp);
+ traverse_data->given_name = NULL;
+ traverse_data->given_len = 0;
+ TRACE_FLOW_NUMBER("Handling end of collection - removed path. Returning:", error);
+ return error;
+ }
+
+ /* Create new path at the beginning of a new sub collection */
+ if(current->type == COL_TYPE_COLLECTION) {
+
+ TRACE_INFO_STRING("act_traverse_handler","Processing collection handle.");
+
+ /* Create new path */
+ if(traverse_data->current_path != (struct path_data *)(NULL)) {
+ TRACE_INFO_STRING("Already have part of the path","");
+ name = (traverse_data->current_path)->name;
+ length = (traverse_data->current_path)->length;
+ TRACE_INFO_STRING("Path:",name);
+ TRACE_INFO_NUMBER("Path len:",length);
+ }
+ else {
+ name = NULL;
+ length = 0;
+ }
+
+ if(traverse_data->given_name != NULL) {
+ property = traverse_data->given_name;
+ property_len = traverse_data->given_len;
+ }
+ else {
+ property = current->property;
+ property_len = current->property_len;
+ }
+
+ TRACE_INFO_STRING("act_traverse_handler","About to create path data.");
+
+ error = create_path_data(&(traverse_data->current_path),
+ name, length, property,property_len);
+
+ TRACE_INFO_NUMBER("create_path_data returned:", error);
+ return error;
+ }
+
+ /* Handle the collection pointers */
+ if(current->type == COL_TYPE_COLLECTIONREF) {
+ traverse_data->given_name = current->property;
+ traverse_data->given_len = current->property_len;
+ TRACE_INFO_STRING("Saved given name:",traverse_data->given_name);
+ }
+
+ TRACE_INFO_STRING("Processing item with property:",current->property);
+
+ /* Do here what we do with items */
+ if(match_item(current,traverse_data)) {
+ TRACE_INFO_STRING("Matched item:",current->property);
+ switch(traverse_data->action) {
+ case COLLECTION_ACTION_FIND:
+ TRACE_INFO_STRING("It is a find action - calling handler.","");
+ if(user_item_handler != (item_fn)(NULL)) {
+ /* Call user handler */
+ error = user_item_handler(current->property,
+ current->property_len,
+ current->type,
+ current->data,
+ current->length,
+ custom_data,
+ stop);
+
+ TRACE_INFO_NUMBER("Handler returned:",error);
+ TRACE_INFO_NUMBER("Handler set STOP to:",*stop);
+
+ }
+ break;
+ case COLLECTION_ACTION_GET:
+ TRACE_INFO_STRING("It is a get action.","");
+ if(custom_data != NULL) *((struct collection_item **)(custom_data)) = current;
+ break;
+ case COLLECTION_ACTION_DEL:
+ TRACE_INFO_STRING("It is a delete action.","");
+ /* Make sure we tell the caller we found a match */
+ if(custom_data != NULL) *(int *)(custom_data) = COL_MATCH;
+ /* Dereference external collections */
+ if(current->type == COL_TYPE_COLLECTIONREF) {
+ TRACE_INFO_STRING("Dereferencing a referenced collection.","");
+ other = *((struct collection_item **)(current->data));
+ header = (struct collection_header *)(other->data);
+ destroy_collection(other);
+ }
+
+ /* Adjust header of the collection */
+ header = (struct collection_header *)(head->data);
+ (header->count)--;
+ if(current->next == (struct collection_item *)(NULL)) header->last = previous;
+
+ /* Unlink and delete iteam */
+ /* Previous can't be NULL here becuase we never delete header elements */
+ previous->next = current->next;
+ delete_item(current);
+ TRACE_INFO_STRING("Did the delete of the item.","");
+ break;
+ case COLLECTION_ACTION_UPDATE:
+ TRACE_INFO_STRING("It is an update action.","");
+ if((current->type == COL_TYPE_COLLECTION) ||
+ (current->type == COL_TYPE_COLLECTIONREF)) {
+ TRACE_ERROR_STRING("Can't update collections it is an error for now","");
+ return EINVAL;
+ }
+
+ /* Make sure we tell the caller we found a match */
+ if(custom_data != NULL) {
+ update_data = (struct update_property *) custom_data;
+ update_data-> found = COL_MATCH;
+ error = update_current_item(current, update_data);
+ }
+ else {
+ TRACE_ERROR_STRING("Error - update data is required","");
+ return EINVAL;
+ }
+
+ TRACE_INFO_STRING("Did the delete of the item.","");
+ break;
+ default:
+ break;
+ }
+ /* Force interrupt if we found */
+ *stop = 1;
+ }
+
+ TRACE_FLOW_NUMBER("act_traverse_handler returning",error);
+ return error;
+}
+
+
+/* Traverse handler for copy function */
+static int copy_traverse_handler(struct collection_item *head,
+ struct collection_item *previous,
+ struct collection_item *current,
+ void *passed_traverse_data,
+ item_fn user_item_handler,
+ void *custom_data,
+ int *stop)
+{
+ int error = EOK;
+ struct collection_item *parent;
+ struct collection_item *item;
+ struct collection_item *new_collection = (struct collection_item *)(NULL);
+
+ TRACE_FLOW_STRING("copy_traverse_handler","Entry.");
+
+ parent = (struct collection_item *)(passed_traverse_data);
+
+ /* Skip current element but rather work with next if it is not NULL */
+ item = current->next;
+ if(item == (struct collection_item *)(NULL)) return error;
+
+
+ /* Check if this is a special case of sub collection */
+ if(item->type == COL_TYPE_COLLECTIONREF) {
+ TRACE_INFO_STRING("Found a subcollection we need to copy. Name:",item->property);
+
+ error = copy_collection(&new_collection,
+ *((struct collection_item **)(item->data)),
+ item->property);
+ if(error) {
+ TRACE_ERROR_NUMBER("Copy subcollection returned error:",error);
+ return error;
+ }
+
+ /* Add new item to a collection - all references are now sub collections */
+ (void)add_property(parent,NULL,item->property,(void *)(&new_collection),
+ sizeof(struct collection_item **),
+ COL_TYPE_COLLECTIONREF, &error);
+ if(error) {
+ TRACE_ERROR_NUMBER("Add property returned error:",error);
+ return error;
+ }
+ }
+ else {
+ (void)add_property(parent,NULL,item->property,item->data,
+ item->length,item->type,&error);
+ if(error) {
+ TRACE_ERROR_NUMBER("Add property returned error:",error);
+ return error;
+ }
+ }
+
+ TRACE_FLOW_NUMBER("copy_traverse_handler returning",error);
+ return error;
+}
+
+
+
+/********************* MAIN INTERFACE FUNCTIONS ***********************************/
+
+
+/* CREATE */
+
+/* Function that creates an named collection of a given class*/
+int create_collection(struct collection_item **ci,char *name, unsigned class)
+{
+ struct collection_item *handle = (struct collection_item *)(NULL);
+ struct collection_header header;
+ int error=EOK;
+
+ TRACE_FLOW_STRING("create_collection","Entry.");
+
+ /* Prepare header */
+ header.last = (struct collection_item *)(NULL);
+ header.reference_count = 1;
+ header.count = 0;
+ header.class = class;
+
+ /* Create a collection type property */
+ handle = add_property((struct collection_item *)(NULL),NULL,name,&header,sizeof(header), COL_TYPE_COLLECTION, &error);
+ if(error) return error;
+
+ *ci = handle;
+
+ TRACE_FLOW_STRING("create_collection","Success Exit.");
+ return 0;
+}
+
+
+/* DESTROY */
+
+/* Function that destroys a collection */
+void destroy_collection(struct collection_item *ci)
+{
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("destroy_collection","Entry.");
+
+ /* Do not try to delete NULL */
+ if(ci == (struct collection_item *)(NULL)) return;
+
+ /* You can delete only whole collection not a part of it */
+ if(ci->type != COL_TYPE_COLLECTION) {
+ TRACE_ERROR_STRING("Attempt to delete a non collection - BAD!","");
+ TRACE_ERROR_NUMBER("Actual type is:",ci->type);
+ return;
+ }
+
+ /* Collection can be referenced by other collection */
+ header = (struct collection_header *)(ci->data);
+ if(header->reference_count>1) {
+ TRACE_INFO_STRING("Dereferencing a referenced collection.","");
+ (header->reference_count)--;
+ TRACE_INFO_NUMBER("Number after dereferencing.",header->reference_count);
+ }
+ else delete_collection(ci);
+
+ TRACE_FLOW_STRING("destroy_collection","Exit.");
+}
+
+
+/* PROPERTIES */
+
+/* Add a string property.
+ If length equals 0, the length is determined based on the string.
+ Lenght INCLUDES the terminating 0 */
+inline int add_str_property(struct collection_item *ci,char *subcollection, char *property,char *string,int length)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_str_property","Entry.");
+
+ if(length == 0) length = strlen(string) + 1;
+ (void)(add_property(ci,subcollection,property,(void *)(string),length, COL_TYPE_STRING, &error));
+
+ TRACE_FLOW_NUMBER("add_str_property returning",error);
+ return error;
+}
+
+/* Add a binary property. */
+inline int add_binary_property(struct collection_item *ci,char *subcollection, char *property,void *binary_data,int length)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_binary_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,binary_data,length, COL_TYPE_BINARY, &error));
+
+ TRACE_FLOW_NUMBER("add_binary_property returning",error);
+ return error;
+}
+
+/* Add an int property. */
+inline int add_int_property(struct collection_item *ci,char *subcollection, char *property,int number)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_int_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(int), COL_TYPE_INTEGER, &error));
+
+ TRACE_FLOW_NUMBER("add_int_property returning",error);
+ return error;
+}
+
+/* Add an unsigned int property. */
+inline int add_unsigned_property(struct collection_item *ci,char *subcollection, char *property,unsigned int number)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_unsigned_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(int), COL_TYPE_UNSIGNED, &error));
+
+ TRACE_FLOW_NUMBER("add_unsigned_property returning",error);
+ return error;
+}
+
+/* Add an long property. */
+inline int add_long_property(struct collection_item *ci,char *subcollection, char *property,long number)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_long_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(long), COL_TYPE_LONG, &error));
+
+ TRACE_FLOW_NUMBER("add_long_property returning",error);
+ return error;
+}
+
+/* Add an unsigned long property. */
+inline int add_ulong_property(struct collection_item *ci,char *subcollection, char *property,unsigned long number)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_ulong_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(long), COL_TYPE_ULONG, &error));
+
+ TRACE_FLOW_NUMBER("add_ulong_property returning",error);
+ return error;
+}
+
+/* Add a double property. */
+inline int add_double_property(struct collection_item *ci,char *subcollection, char *property,double number)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_double_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&number),sizeof(double), COL_TYPE_DOUBLE, &error));
+
+ TRACE_FLOW_NUMBER("add_double_property returning",error);
+ return error;
+}
+
+/* Add a bool property. */
+inline int add_bool_property(struct collection_item *ci,char *subcollection, char *property,unsigned char logical)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_bool_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,(void *)(&logical),sizeof(unsigned char), COL_TYPE_BOOL, &error));
+
+ TRACE_FLOW_NUMBER("add_bool_property returning",error);
+ return error;
+}
+
+/* A function to add a property */
+inline int add_any_property(struct collection_item *ci,
+ char *subcollection,
+ char *property,
+ int type,
+ void *data,
+ int length)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_any_property","Entry.");
+
+ (void)(add_property(ci,subcollection,property,data,length, type, &error));
+
+ TRACE_FLOW_NUMBER("add_any_property returning",error);
+ return error;
+}
+
+/* Add a string property.
+ If length equals 0, the length is determined based on the string.
+ Lenght INCLUDES the terminating 0 */
+inline int add_str_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,char *string,int length,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_str_property_with_ref","Entry.");
+
+ if(length == 0) length = strlen(string) + 1;
+ item = add_property(ci,subcollection,property,(void *)(string),length, COL_TYPE_STRING, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_str_property_with_ref returning",error);
+ return error;
+}
+
+/* Add a binary property. */
+inline int add_binary_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,void *binary_data,int length,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_binary_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,binary_data,length, COL_TYPE_BINARY, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_binary_property_with_ref returning",error);
+ return error;
+}
+
+/* Add an int property. */
+inline int add_int_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,int number,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_int_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&number),sizeof(int), COL_TYPE_INTEGER, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_int_property_with_ref returning",error);
+ return error;
+}
+
+/* Add an unsigned int property. */
+inline int add_unsigned_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,unsigned int number,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_unsigned_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&number),sizeof(int), COL_TYPE_UNSIGNED, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_unsigned_property_with_ref returning",error);
+ return error;
+}
+
+/* Add an long property. */
+inline int add_long_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,long number,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_long_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&number),sizeof(long), COL_TYPE_LONG, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_long_property_with_ref returning",error);
+ return error;
+}
+
+/* Add an unsigned long property. */
+inline int add_ulong_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,unsigned long number,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_ulong_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&number),sizeof(long), COL_TYPE_ULONG, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_ulong_property_with_ref returning",error);
+ return error;
+}
+
+/* Add a double property. */
+inline int add_double_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,double number,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_double_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&number),sizeof(double), COL_TYPE_DOUBLE, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_double_property_with_ref returning",error);
+ return error;
+}
+
+/* Add a bool property. */
+inline int add_bool_property_with_ref(struct collection_item *ci,char *subcollection,
+ char *property,unsigned char logical,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_bool_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,(void *)(&logical),sizeof(unsigned char), COL_TYPE_BOOL, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_bool_property_with_ref returning",error);
+ return error;
+}
+
+/* A function to add a property */
+inline int add_any_property_with_ref(struct collection_item *ci,
+ char *subcollection,
+ char *property,
+ int type,
+ void *data,
+ int length,
+ struct collection_item **ref_ret)
+{
+ int error = EOK;
+ struct collection_item *item;
+
+ TRACE_FLOW_STRING("add_any_property_with_ref","Entry.");
+
+ item = add_property(ci,subcollection,property,data,length, type, &error);
+
+ if(ref_ret != (struct collection_item **)(NULL)) *ref_ret = item;
+
+ TRACE_FLOW_NUMBER("add_any_property_with_ref returning",error);
+ return error;
+}
+
+
+
+/* COPY */
+
+/* Create a deep copy of the current collection. */
+/* Referenced collections of the donor are copied as sub collections. */
+int copy_collection(struct collection_item **collection_copy,
+ struct collection_item *collection_to_copy,
+ char *name_to_use) {
+
+ int error = EOK;
+ struct collection_item *new_collection = (struct collection_item *)(NULL);
+ char *name;
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("copy_collection","Entry.");
+
+ /* Determine what name to use */
+ if(name_to_use != NULL) name = name_to_use;
+ else name = collection_to_copy->property;
+
+ header = (struct collection_header *)(collection_to_copy->data);
+
+ /* Create a new collection */
+ error = create_collection(&new_collection,name,header->class);
+ if(error) {
+ TRACE_ERROR_NUMBER("Create_cllection failed returning",error);
+ return error;
+ }
+
+ error = walk_items(collection_to_copy, COL_TRAVERSE_ONELEVEL, copy_traverse_handler,
+ new_collection, NULL, NULL);
+
+ if(!error) *collection_copy = new_collection;
+ else destroy_collection(new_collection);
+
+ TRACE_FLOW_NUMBER("copy_collection returning",error);
+ return error;
+
+}
+
+/* EXTRACTION */
+
+/* Extract collection */
+int get_collection_reference(struct collection_item *ci, /* High level collection */
+ struct collection_item **acceptor, /* The pointer that will accept extracted handle */
+ char *collection_to_find) /* Name to of the collection */
+{
+ struct collection_header *header;
+ struct collection_item *subcollection = (struct collection_item *)(NULL);
+ int error = EOK;
+
+ TRACE_FLOW_STRING("get_collection_reference","Entry.");
+
+ if((ci == (struct collection_item *)(NULL)) ||
+ (ci->type != COL_TYPE_COLLECTION) ||
+ (acceptor == (struct collection_item **)(NULL)) ||
+ (collection_to_find == NULL)) {
+ TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL);
+ return EINVAL;
+ }
+
+ /* Find a sub collection */
+ TRACE_INFO_STRING("We are given subcollection name - search it:",collection_to_find);
+ error = find_item_and_do(ci,collection_to_find,COL_TYPE_COLLECTIONREF,
+ COL_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&subcollection),COLLECTION_ACTION_FIND);
+ if(error) {
+ TRACE_ERROR_NUMBER("Search failed returning error",error);
+ return error;
+ }
+
+ if(subcollection == (struct collection_item *)(NULL)) {
+ TRACE_ERROR_STRING("Search for subcollection returned NULL pointer","");
+ return ENOENT;
+ }
+
+ header = (struct collection_header *)(subcollection->data);
+ TRACE_INFO_NUMBER("Count:",header->count);
+ TRACE_INFO_NUMBER("Ref count:",header->reference_count);
+ (header->reference_count)++;
+ TRACE_INFO_NUMBER("Ref count after increment:",header->reference_count);
+ *acceptor = subcollection;
+
+ TRACE_FLOW_STRING("get_collection_reference","Success Exit.");
+ return EOK;
+}
+
+/* Get collection - if current item is a reference get a real collection from it. */
+int get_reference_from_item(struct collection_item *ci,
+ struct collection_item **acceptor)
+{
+ struct collection_header *header;
+ struct collection_item *subcollection = (struct collection_item *)(NULL);
+ int error = EOK;
+
+ TRACE_FLOW_STRING("get_reference_from_item","Entry.");
+
+ if((ci == (struct collection_item *)(NULL)) ||
+ (ci->type != COL_TYPE_COLLECTIONREF) ||
+ (acceptor == (struct collection_item **)(NULL))) {
+ TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL);
+ return EINVAL;
+ }
+
+ subcollection = *((struct collection_item **)(ci->data));
+
+ header = (struct collection_header *)(subcollection->data);
+ TRACE_INFO_NUMBER("Count:",header->count);
+ TRACE_INFO_NUMBER("Ref count:",header->reference_count);
+ (header->reference_count)++;
+ TRACE_INFO_NUMBER("Ref count after increment:",header->reference_count);
+ *acceptor = subcollection;
+
+ TRACE_FLOW_STRING("get_reference_from_item","Success Exit.");
+ return EOK;
+}
+
+/* ADDITION */
+
+/* Add collection to collection */
+int add_collection_to_collection(
+ struct collection_item *ci, /* Collection handle to with we add another collection */
+ char *sub_collection_name, /* Name of the sub collection to which
+ collection needs to be added as a property.
+ If NULL high level collection is assumed. */
+ char *as_property, /* Name of the collection property.
+ If NULL, same property as the name of
+ the collection being added will be used. */
+ struct collection_item *collection_to_add, /* Collection to add */
+ int mode) /* How this collection needs to be added */
+{
+ struct collection_item *acceptor = (struct collection_item *)(NULL);
+ char *name_to_use;
+ struct collection_header *header;
+ struct collection_item *collection_copy;
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_collection_to_collection","Entry.");
+
+ if((ci == (struct collection_item *)(NULL)) ||
+ (ci->type != COL_TYPE_COLLECTION) ||
+ (collection_to_add == (struct collection_item *)(NULL)) ||
+ (collection_to_add->type != COL_TYPE_COLLECTION)) {
+ /* Need to debug here */
+ TRACE_ERROR_NUMBER("Missing parameter - returning error",EINVAL);
+ return EINVAL;
+ }
+
+ if(sub_collection_name != NULL) {
+ /* Find a sub collection */
+ TRACE_INFO_STRING("We are given subcollection name - search it:",sub_collection_name);
+ error = find_item_and_do(ci,sub_collection_name,COL_TYPE_COLLECTIONREF,
+ COL_TRAVERSE_DEFAULT,
+ get_subcollection,(void *)(&acceptor),COLLECTION_ACTION_FIND);
+ if(error) {
+ TRACE_ERROR_NUMBER("Search failed returning error",error);
+ return error;
+ }
+
+ if(acceptor == (struct collection_item *)(NULL)) {
+ TRACE_ERROR_STRING("Search for subcollection returned NULL pointer","");
+ return ENOENT;
+ }
+
+ }
+ else acceptor = ci;
+
+ if(as_property != NULL)
+ name_to_use = as_property;
+ else
+ name_to_use = collection_to_add->property;
+
+
+ TRACE_INFO_STRING("Going to use name:",name_to_use);
+
+
+ switch(mode) {
+ case COL_ADD_MODE_REFERENCE:
+ TRACE_INFO_STRING("We are adding a reference.","");
+ TRACE_INFO_NUMBER("Type of the header element:",collection_to_add->type);
+ TRACE_INFO_STRING("Header name we are adding.",collection_to_add->property);
+ /* Create a pointer to external collection */
+ /* For future thread safety: Transaction start -> */
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_to_add),
+ sizeof(struct collection_item **),
+ COL_TYPE_COLLECTIONREF, &error));
+
+ TRACE_INFO_NUMBER("Type of the header element after add_property:",collection_to_add->type);
+ TRACE_INFO_STRING("Header name we just added.",collection_to_add->property);
+ if(error) {
+ TRACE_ERROR_NUMBER("Adding property failed with error:",error);
+ return error;
+ }
+ header = (struct collection_header *)(collection_to_add->data);
+ TRACE_INFO_NUMBER("Count:",header->count);
+ TRACE_INFO_NUMBER("Ref count:",header->reference_count);
+ (header->reference_count)++;
+ TRACE_INFO_NUMBER("Ref count after increment:",header->reference_count);
+ /* -> Transaction end */
+ break;
+ case COL_ADD_MODE_EMBED:
+ TRACE_INFO_STRING("We are embedding the collection.","");
+ /* First check if the passed in collection is referenced more than once */
+ TRACE_INFO_NUMBER("Type of the header element we are adding:",collection_to_add->type);
+ TRACE_INFO_STRING("Header name we are adding.",collection_to_add->property);
+ TRACE_INFO_NUMBER("Type of the header element we are adding to:",acceptor->type);
+ TRACE_INFO_STRING("Header name we are adding to.",acceptor->property);
+
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_to_add),
+ sizeof(struct collection_item **),
+ COL_TYPE_COLLECTIONREF, &error));
+
+ TRACE_INFO_NUMBER("Adding property returned:",error);
+ break;
+
+ case COL_ADD_MODE_CLONE:
+ TRACE_INFO_STRING("We are cloning the collection.","");
+ TRACE_INFO_STRING("Name we will use.",name_to_use);
+
+ /* For future thread safety: Transaction start -> */
+ error = copy_collection(&collection_copy, collection_to_add, name_to_use);
+ if(error) return error;
+
+ TRACE_INFO_STRING("We have a collection copy.", collection_copy->property);
+ TRACE_INFO_NUMBER("Collection type.", collection_copy->type);
+ TRACE_INFO_STRING("Acceptor collection.", acceptor->property);
+ TRACE_INFO_NUMBER("Acceptor collection type.", acceptor->type);
+
+ (void)(add_property(acceptor,NULL,name_to_use,(void *)(&collection_copy),
+ sizeof(struct collection_item **),
+ COL_TYPE_COLLECTIONREF, &error));
+
+ /* -> Transaction end */
+ TRACE_INFO_NUMBER("Adding property returned:",error);
+ break;
+
+ default: error = EINVAL;
+ }
+
+ TRACE_FLOW_NUMBER("add_collection_to_collection returning:",error);
+ return error;
+}
+
+/* TRAVERSING */
+
+/* Function to traverse the entire collection including optionally sub collections */
+inline int traverse_collection(struct collection_item *ci,
+ int mode_flags,
+ item_fn item_handler,
+ void *custom_data)
+{
+
+ int error = EOK;
+ TRACE_FLOW_STRING("traverse_collection","Entry.");
+
+ error = walk_items(ci, mode_flags, simple_traverse_handler,
+ NULL, item_handler, custom_data);
+
+ if((error != 0) && (error != EINTR_INTERNAL)) {
+ TRACE_ERROR_NUMBER("Error walking tree",error);
+ return error;
+ }
+
+ TRACE_FLOW_STRING("traverse_collection","Success exit.");
+ return EOK;
+}
+
+/* CHECK */
+
+/* Convenience function to check if specific property is in the collection */
+inline int is_item_in_collection(struct collection_item *ci,
+ char *property_to_find,
+ int type,
+ int mode_flags,
+ int *found)
+{
+ int error;
+
+ TRACE_FLOW_STRING("is_item_in_collection","Entry.");
+
+ *found = COL_NOMATCH;
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,
+ is_in_item_handler,(void *)found,COLLECTION_ACTION_FIND);
+
+ TRACE_FLOW_NUMBER("is_item_in_collection returning",error);
+ return error;
+}
+
+/* SEARCH */
+/* Search function. Looks up an item in the collection based on the property.
+ Essentually it is a traverse function with spacial traversing logic.
+ */
+inline int get_item_and_do(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ item_fn item_handler, /* Function to call when the item is found */
+ void *custom_data) /* Custom data passed around */
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("get_item_and_do","Entry.");
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,item_handler,custom_data,COLLECTION_ACTION_FIND);
+
+ TRACE_FLOW_NUMBER("get_item_and_do returning",error);
+ return error;
+}
+
+
+/* Get raw item */
+inline int get_item(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ struct collection_item **item) /* Found item */
+{
+
+ int error = EOK;
+
+ TRACE_FLOW_STRING("get_item","Entry.");
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,NULL,(void *)(item),COLLECTION_ACTION_GET);
+
+ TRACE_FLOW_NUMBER("get_item returning",error);
+ return error;
+}
+
+/* DELETE */
+/* Delete property from the collection */
+inline int delete_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags) /* How to traverse the collection */
+{
+ int error = EOK;
+ int found;
+
+ TRACE_FLOW_STRING("delete_property","Entry.");
+ found = COL_NOMATCH;
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,NULL,(void *)(&found),COLLECTION_ACTION_DEL);
+
+ if((error == EOK) && (found == COL_NOMATCH)) error = ENOENT;
+ TRACE_FLOW_NUMBER("delete_property returning",error);
+ return error;
+}
+
+/* UPDATE */
+/* Update property in the collection */
+int update_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type of the passed in data */
+ void *new_data, /* Pointer to the new data */
+ int length, /* Length of the data. For strings should include trailing 0 */
+ int mode_flags) /* How to traverse the collection */
+
+{
+ int error = EOK;
+ struct update_property update_data;
+
+ TRACE_FLOW_STRING("update_property","Entry.");
+ update_data.type = type;
+ update_data.data = new_data;
+ update_data.length = length;
+ update_data.found = COL_NOMATCH;
+
+ error = find_item_and_do(ci,property_to_find,type,mode_flags,NULL,(void *)(&update_data),COLLECTION_ACTION_UPDATE);
+
+ if((error == EOK) && (update_data.found == COL_NOMATCH)) error = ENOENT;
+ TRACE_FLOW_NUMBER("update_property returning",error);
+ return error;
+}
+
+/* Update a string property in the collection. Length should include the null terminating 0 */
+inline int update_str_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ char *string,
+ int length)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_str_property","Entry.");
+
+ if(length == 0) length = strlen(string) + 1;
+ error = update_property(ci,property, COL_TYPE_STRING, (void *)(string),length,mode_flags);
+
+ TRACE_FLOW_NUMBER("update_str_property Returning",error);
+ return error;
+}
+
+/* Update a binary property in the collection. */
+inline int update_binary_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ void *binary_data,
+ int length)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_binary_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_BINARY, binary_data, length, mode_flags);
+
+ TRACE_FLOW_NUMBER("update_binary_property Returning",error);
+ return error;
+}
+
+/* Update an int property in the collection. */
+inline int update_int_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ int number)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_int_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_INTEGER, (void *)(&number), sizeof(int), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_int_property Returning",error);
+ return error;
+}
+
+/* Update an unsigned int property. */
+inline int update_unsigned_property(struct collection_item *ci,
+ char *property,int mode_flags,
+ unsigned int number)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_unsigned_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_UNSIGNED, (void *)(&number), sizeof(unsigned int), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_unsigned_property Returning",error);
+ return error;
+}
+/* Update a long property. */
+inline int update_long_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ long number)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_long_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_LONG, (void *)(&number), sizeof(long), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_long_property Returning",error);
+ return error;
+
+}
+
+/* Update an unsigned long property. */
+inline int update_ulong_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ unsigned long number)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_ulong_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_ULONG, (void *)(&number), sizeof(unsigned long), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_ulong_property Returning",error);
+ return error;
+}
+
+/* Update a double property. */
+inline int update_double_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ double number)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_double_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_DOUBLE, (void *)(&number), sizeof(double), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_double_property Returning",error);
+ return error;
+}
+
+/* Update a bool property. */
+inline int update_bool_property(struct collection_item *ci,
+ char *property,
+ int mode_flags,
+ unsigned char logical)
+{
+ int error = EOK;
+ TRACE_FLOW_STRING("update_bool_property","Entry.");
+
+ error = update_property(ci,property, COL_TYPE_BOOL, (void *)(&logical), sizeof(unsigned char), mode_flags);
+
+ TRACE_FLOW_NUMBER("update_bool_property Returning",error);
+ return error;
+}
+
+/* Function to modify the item */
+int modify_item(struct collection_item *item,
+ char *property,
+ int type,
+ void *data,
+ int length)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("modify_item","Entry");
+
+ if((item == (struct collection_item *)(NULL)) ||
+ (item->type == COL_TYPE_COLLECTION) ||
+ (item->type == COL_TYPE_COLLECTIONREF)) {
+ TRACE_ERROR_NUMBER("Invalid argument or invalid argument type",EINVAL);
+ return EINVAL;
+ }
+
+ if(property != NULL) {
+ free(item->property);
+ item->property=strdup(property);
+ if(item->property == NULL) {
+ TRACE_ERROR_STRING("Failed to allocate memory","");
+ return ENOMEM;
+ }
+ }
+
+ /* If type is different or same but it is string or binary we need to replace the storage */
+ if((item->type != type) ||
+ ((item->type == type) &&
+ ((item->type == COL_TYPE_STRING) || (item->type == COL_TYPE_BINARY)))) {
+ TRACE_INFO_STRING("Replacing item data buffer","");
+ free(item->data);
+ item->data = malloc(length);
+ if(item->data == NULL) {
+ TRACE_ERROR_STRING("Failed to allocate memory","");
+ item->length = 0;
+ return ENOMEM;
+ }
+ item->length = length;
+ }
+
+
+ TRACE_INFO_STRING("Overwriting item data","");
+ memcpy(item->data,data,item->length);
+ item->type = type;
+
+ if(item->type == COL_TYPE_STRING) *(((char *)(item->data))+item->length-1) = '\0';
+
+ TRACE_FLOW_STRING("modify_item","Exit");
+ return EOK;
+}
+
+
+/* Convinience functions that wrap modify_item(). */
+/* Modify item data to be str */
+inline int modify_str_item(struct collection_item *item,
+ char *property,
+ char *string,
+ int length)
+{
+ int len;
+ int error;
+
+ TRACE_FLOW_STRING("modify_str_item","Entry");
+
+ if(length != 0) len = length;
+ else len = strlen(string) + 1;
+
+ error = modify_item(item,property,COL_TYPE_STRING,(void *)string,len);
+
+ TRACE_FLOW_STRING("modify_str_item","Exit");
+ return error;
+}
+
+/* Modify item data to be binary */
+inline int modify_binary_item(struct collection_item *item,
+ char *property,
+ void *binary_data,
+ int length)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_binary_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_BINARY,binary_data,length);
+
+ TRACE_FLOW_STRING("modify_binary_item","Exit");
+ return error;
+}
+
+/* Modify item data to be bool */
+inline int modify_bool_item(struct collection_item *item,
+ char *property,
+ unsigned char logical)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_bool_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_BOOL,(void *)(&logical),1);
+
+ TRACE_FLOW_STRING("modify_bool_item","Exit");
+ return error;
+}
+
+/* Modify item data to be int */
+inline int modify_int_item(struct collection_item *item,
+ char *property,
+ int number)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_int_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_INTEGER,(void *)(&number),sizeof(int));
+
+ TRACE_FLOW_STRING("modify_int_item","Exit");
+ return error;
+}
+
+/* Modify item data to be long */
+inline int modify_long_item(struct collection_item *item,
+ char *property,
+ long number)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_long_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_LONG,(void *)(&number),sizeof(long));
+
+ TRACE_FLOW_STRING("modify_long_item","Exit");
+ return error;
+}
+
+/* Modify item data to be unigned long */
+inline int modify_ulong_item(struct collection_item *item,
+ char *property,
+ unsigned long number)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_ulong_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_ULONG,(void *)(&number),sizeof(unsigned long));
+
+ TRACE_FLOW_STRING("modify_ulong_item","Exit");
+ return error;
+}
+
+inline int modify_unsigned_item(struct collection_item *item,
+ char *property,
+ unsigned number)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_unsigned_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_UNSIGNED,(void *)(&number),sizeof(unsigned));
+
+ TRACE_FLOW_STRING("modify_unsigned_item","Exit");
+ return error;
+}
+
+inline int modify_double_item(struct collection_item *item,
+ char *property,
+ double number)
+{
+ int error;
+
+ TRACE_FLOW_STRING("modify_double_item","Entry");
+
+ error = modify_item(item,property,COL_TYPE_DOUBLE,(void *)(&number),sizeof(double));
+
+ TRACE_FLOW_STRING("modify_double_item","Exit");
+ return error;
+}
+
+
+/* Grow iteration stack */
+static int grow_stack(struct collection_iterator *iterator, unsigned desired)
+{
+ int error;
+ int grow_by = 0;
+ struct collection_item **temp;
+
+ TRACE_FLOW_STRING("grow_stack","Entry.");
+
+ if(desired > iterator->stack_size) {
+ grow_by = (((desired - iterator->stack_size) / STACK_DEPTH_BLOCK) + 1) * STACK_DEPTH_BLOCK;
+ errno = 0;
+ temp = (struct collection_item **)(realloc(iterator->stack,grow_by * sizeof(struct collection_item *)));
+ if(temp == (struct collection_item **)(NULL)) {
+ TRACE_ERROR_NUMBER("Failed to allocate memory",ENOMEM);
+ return ENOMEM;
+ }
+ iterator->stack = temp;
+ iterator->stack_size += grow_by;
+ }
+ TRACE_FLOW_STRING("grow_stack","Exit.");
+ return EOK;
+}
+
+
+
+/* Bind iterator to a collection */
+int bind_iterator(struct collection_iterator **iterator,
+ struct collection_item *ci,
+ int mode_flags)
+{
+ int error;
+ struct collection_header *header;
+ struct collection_iterator *iter = (struct collection_iterator *)(NULL);
+
+ TRACE_FLOW_STRING("bind_iterator","Entry.");
+
+ /* Do some argument checking first */
+ if((iterator == (struct collection_iterator **)(NULL)) ||
+ (ci == (struct collection_item *)(NULL))) {
+ TRACE_ERROR_NUMBER("Invalid parameter.",EINVAL);
+ return EINVAL;
+ }
+
+ iter = (struct collection_iterator *)malloc(sizeof(struct collection_iterator));
+ if(iter == (struct collection_iterator *)(NULL)) {
+ TRACE_ERROR_NUMBER("Error allocating memory for the iterator.",ENOMEM);
+ return ENOMEM;
+ }
+
+ /* Allocate memory for the stack */
+ iter->stack = (struct collection_item **)(NULL);
+ iter->stack_size = 0;
+ iter->stack_depth = 0;
+ iter->flags = mode_flags;
+
+ /* Allocate memory for stack */
+ error = grow_stack(iter,1);
+ if(error) {
+ free(iter);
+ TRACE_ERROR_NUMBER("Error growing stack.",error);
+ return error;
+ }
+
+ /* Make sure that we tie iterator to the collection */
+ header = (struct collection_header *)(ci->data);
+ (header->reference_count)++;
+ iter->top = ci;
+ *(iter->stack) = ci;
+ iter->stack_depth++;
+
+ *iterator = iter;
+
+ TRACE_FLOW_STRING("bind_iterator","Exit");
+ return EOK;
+}
+
+/* Stop processing this subcollection and move to the next item in the collection 'level' levels up.*/
+inline int iterate_up(struct collection_iterator *iterator, int level)
+{
+ TRACE_FLOW_STRING("iterate_up","Entry");
+
+ if((iterator == (struct collection_iterator *)(NULL)) ||
+ (level >= iterator->stack_depth)) {
+ TRACE_ERROR_NUMBER("Invalid parameter.",EINVAL);
+ return EINVAL;
+ }
+
+ TRACE_INFO_NUMBER("Going up:",level);
+
+ iterator->stack_depth--;
+
+ TRACE_INFO_NUMBER("Stack depth at the end:",iterator->stack_depth);
+ TRACE_FLOW_STRING("iterate_up","Exit");
+ return EOK;
+}
+/* How deep are we relative to the top level.*/
+inline int get_iterator_depth(struct collection_iterator *iterator, int *depth)
+{
+ TRACE_FLOW_STRING("iterate_up","Entry");
+
+ if((iterator == (struct collection_iterator *)(NULL)) ||
+ (depth == (int *)(NULL))) {
+ TRACE_ERROR_NUMBER("Invalid parameter.",EINVAL);
+ return EINVAL;
+ }
+
+ *depth = iterator->stack_depth -1;
+
+ TRACE_INFO_NUMBER("Stack depth at the end:",iterator->stack_depth);
+ TRACE_FLOW_STRING("iterate_up","Exit");
+ return EOK;
+}
+
+
+/* Unbind the iterator from the collection */
+inline void unbind_iterator(struct collection_iterator *iterator)
+{
+ TRACE_FLOW_STRING("unbind_iterator","Entry.");
+ if(iterator != (struct collection_iterator *)(NULL)) {
+ destroy_collection(iterator->top);
+ if(iterator->stack != (struct collection_item **)(NULL)) free(iterator->stack);
+ free(iterator);
+ }
+ TRACE_FLOW_STRING("unbind_iterator","Exit");
+}
+
+/* Get items from the collection one by one following the tree */
+int iterate_collection(struct collection_iterator *iterator, struct collection_item **item)
+{
+ int error;
+ struct collection_item *current;
+ struct collection_item *other;
+
+ TRACE_FLOW_STRING("iterate_collection","Entry.");
+
+ /* Check if we have storage for item */
+ if(item == (struct collection_item **)(NULL)) {
+ TRACE_ERROR_NUMBER("Invalid parameter.",EINVAL);
+ return EINVAL;
+ }
+
+ while(1) {
+
+ TRACE_INFO_NUMBER("Stack depth:",iterator->stack_depth);
+
+ /* Are we done? */
+ if(iterator->stack_depth == 0) {
+ TRACE_FLOW_STRING("We are done.","");
+ *item = (struct collection_item *)(NULL);
+ return EOK;
+ }
+
+ /* Is current item available */
+ current = *(iterator->stack + iterator->stack_depth - 1);
+
+ /* We are not done so check if we have an item */
+ if(current != (struct collection_item *)(NULL)) {
+
+ TRACE_INFO_STRING("Current item:",current->property);
+ TRACE_INFO_NUMBER("Current item type:",current->type);
+
+ /* Is this a collection reference */
+ if(current->type == COL_TYPE_COLLECTIONREF) {
+ /* We do follow references? */
+ TRACE_INFO_STRING("Current item:","collection reference");
+ if((iterator->flags & COL_TRAVERSE_IGNORE) == 0) {
+ /* We should not ignore - then move on */
+ TRACE_INFO_STRING("Collection references are not ignored","");
+ error = grow_stack(iterator,iterator->stack_depth + 1);
+ if(error) {
+ TRACE_ERROR_NUMBER("Error growing stack.",error);
+ return error;
+ }
+ /* Do we need to go deeper than one level ? */
+ if((iterator->flags & COL_TRAVERSE_ONELEVEL) == 0) {
+ TRACE_INFO_STRING("Need to go deeper","");
+ /* We need to go deeper... */
+ /* Do we need to show headers but not reference? */
+ if((iterator->flags & COL_TRAVERSE_ONLYSUB) != 0) {
+ TRACE_INFO_STRING("Instructed to show header not reference","");
+ other = *((struct collection_item **)(current->data));
+ *(iterator->stack + iterator->stack_depth) = other->next;
+ *item = other;
+ }
+ /* Do we need to show both? */
+ else if((iterator->flags & COL_TRAVERSE_SHOWSUB) != 0) {
+ TRACE_INFO_STRING("Instructed to show header and reference","");
+ *(iterator->stack + iterator->stack_depth) = *((struct collection_item **)(current->data));
+ *item = current;
+ }
+ /* We need to show reference only */
+ else {
+ TRACE_INFO_STRING("Instructed to show reference only","");
+ other = *((struct collection_item **)(current->data));
+ TRACE_INFO_STRING("Sub collection:",other->property);
+ TRACE_INFO_NUMBER("Sub collection type:",other->type);
+ *(iterator->stack + iterator->stack_depth) = other->next;
+ if(other->next != (struct collection_item *)(NULL)) {
+ TRACE_INFO_STRING("Will show this item next time:",(other->next)->property);
+ TRACE_INFO_NUMBER("Will show this item next time type:",(other->next)->type);
+ }
+ *item = current;
+ }
+
+ TRACE_INFO_STRING("We return item:",(*item)->property);
+ TRACE_INFO_NUMBER("We return item type:",(*item)->type);
+ TRACE_INFO_STRING("Moving to the next item on the previous item in stack","");
+ *(iterator->stack + iterator->stack_depth - 1) = current->next;
+ (iterator->stack_depth)++;
+
+ }
+ else {
+ TRACE_INFO_STRING("Instructed to parse just one level","");
+ /* On one level - just return current */
+ *item = current;
+ TRACE_INFO_STRING("Moving to the next item on one level","");
+ *(iterator->stack + iterator->stack_depth - 1) = current->next;
+ }
+ break;
+ }
+ else {
+ /* We need to ignore references so move to the next item */
+ TRACE_INFO_STRING("Stepping over the reference","");
+ *(iterator->stack + iterator->stack_depth - 1) = current->next;
+ continue;
+ }
+ }
+ else {
+ /* Got a normal item - return it and move to the next one */
+ TRACE_INFO_STRING("Simple item","");
+ *item = current;
+ *(iterator->stack + iterator->stack_depth - 1) = current->next;
+ break;
+ }
+ }
+ else {
+ /* Item is NULL */
+ TRACE_INFO_STRING("Finished level","moving to upper level");
+ iterator->stack_depth--;
+ TRACE_INFO_NUMBER("Stack depth at the end:",iterator->stack_depth);
+ if((iterator->flags & COL_TRAVERSE_END) != 0) {
+ /* Return dummy entry to indicate the end of the collection */
+ TRACE_INFO_STRING("Finished level","told to return END");
+ *item = &dummy;
+ break;
+ }
+ else continue; /* Move to next level */
+ }
+ }
+
+ TRACE_FLOW_STRING("iterate_collection","Exit");
+ return EOK;
+}
+
+/* Set collection class */
+inline int set_collection_class(struct collection_item *item, unsigned class)
+{
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("set_collection_class","Entry");
+
+ if(item->type != COL_TYPE_COLLECTION) {
+ TRACE_INFO_NUMBER("Not a collectin object. Type is",item->type);
+ return EINVAL;
+ }
+
+ header = (struct collection_header *)(item->data);
+ header->class = class;
+ TRACE_FLOW_STRING("set_collection_class","Exit");
+ return EOK;
+}
+
+/* Get collection class */
+inline int get_collection_class(struct collection_item *item,
+ unsigned *class)
+{
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("get_collection_class","Entry");
+
+ if(item->type != COL_TYPE_COLLECTION) {
+ TRACE_ERROR_NUMBER("Not a collection object. Type is",item->type);
+ return EINVAL;
+ }
+
+ header = (struct collection_header *)(item->data);
+ *class = header->class;
+ TRACE_FLOW_STRING("get_collection_class","Exit");
+ return EOK;
+}
+
+/* Get collection count */
+inline int get_collection_count(struct collection_item *item,
+ unsigned *count)
+{
+ struct collection_header *header;
+
+ TRACE_FLOW_STRING("get_collection_count","Entry");
+
+ if(item->type != COL_TYPE_COLLECTION) {
+ TRACE_ERROR_NUMBER("Not a collectin object. Type is",item->type);
+ return EINVAL;
+ }
+
+ header = (struct collection_header *)(item->data);
+ *count = header->count;
+ TRACE_FLOW_STRING("get_collection_count","Exit");
+ return EOK;
+
+}
+
+/* Convinience function to check if the collection is of the specific class */
+/* In case of internal error assumes that collection is not of the right class */
+inline int is_of_class(struct collection_item *item,unsigned class)
+{
+ int error = EOK;
+ unsigned ret_class = 0;
+
+ TRACE_FLOW_STRING("is_of_class invoked","");
+
+ error = get_collection_class(item,&ret_class);
+ if((error) || (ret_class != class)) return 0;
+ else return 1;
+}
+
+/* Get propery */
+inline char *get_item_property(struct collection_item *ci,int *property_len)
+{
+ if(property_len != NULL) *property_len = ci->property_len;
+ return ci->property;
+}
+
+/* Get type */
+inline int get_item_type(struct collection_item *ci)
+{
+ return ci->type;
+}
+
+/* Get length */
+inline int get_item_length(struct collection_item *ci)
+{
+ return ci->length;
+}
+
+/* Get data */
+void *get_item_data(struct collection_item *ci)
+{
+ return ci->data;
+}
+
+
+/* Set time stamp in the collection - FIXME move to another level */
+int set_timestamp(struct collection_item *ci,struct collection_item **timestr_ref,struct collection_item **timeint_ref)
+{
+ time_t utctime;
+ struct tm time_struct;
+ char time_array[TIME_ARRAY_SIZE+1];
+ int len;
+ struct collection_item *timestr = (struct collection_item *)(NULL);
+ struct collection_item *timeint = (struct collection_item *)(NULL);
+ int error = EOK;
+
+ TRACE_FLOW_STRING("set_timestamp","Entry point");
+
+ utctime = time(NULL);
+ localtime_r(&utctime,&time_struct);
+
+ len = strftime(time_array, TIME_ARRAY_SIZE, DATE_FORMAT, &time_struct);
+ if(len == 0) {
+ TRACE_ERROR_STRING("add_time","CODING ERROR - INCREASE THE BUFFER");
+ return EMSGSIZE;
+ }
+
+ TRACE_INFO_STRING("Timestamp:",time_array);
+
+ /* Check if we have the timestamp item already */
+ error = get_item(ci, TS_NAME, COL_TYPE_STRING,COL_TRAVERSE_IGNORE,&timestr);
+ if(error) {
+ TRACE_ERROR_NUMBER("search failed with error:",error);
+ return error;
+ }
+
+ if(timestr != (struct collection_item *)(NULL)) {
+ /* There is a timestamp */
+ free(timestr->data);
+ timestr->data = strdup(time_array);
+ if(timestr->data == NULL) {
+ TRACE_ERROR_NUMBER("failed to add timestamp property:",error);
+ return ENOMEM;
+ }
+ timestr->length = len+1;
+ *timestr_ref = timestr;
+ }
+ else {
+ /* Add timestamp to the collection */
+ error = add_str_property_with_ref(ci,NULL, TS_NAME,time_array,len+1,timestr_ref);
+ if(error) {
+ TRACE_ERROR_NUMBER("failed to add timestamp property:",error);
+ return error;
+ }
+ }
+
+ /* Check if we have the time item already */
+ error = get_item(ci, T_NAME, COL_TYPE_INTEGER,COL_TRAVERSE_IGNORE,&timeint);
+ if(error) {
+ TRACE_ERROR_NUMBER("search failed with error:",error);
+ return error;
+ }
+
+ if(timeint != (struct collection_item *)(NULL)) {
+ /* There is a time property */
+ *((int *)(timeint->data)) = utctime;
+ *timeint_ref = timeint;
+ }
+ else {
+ /* Add time to the collection */
+ error = add_int_property_with_ref(ci,NULL, T_NAME,utctime,timeint_ref);
+ if(error) {
+ TRACE_ERROR_NUMBER("failed to add time property:",error);
+ return error;
+ }
+ }
+
+ TRACE_FLOW_STRING("set_timestamp","Exit point");
+ return EOK;
+}
+
diff --git a/common/collection/collection.h b/common/collection/collection.h
new file mode 100644
index 00000000..2a88f82c
--- /dev/null
+++ b/common/collection/collection.h
@@ -0,0 +1,426 @@
+/*
+ COLLECTION LIBRARY
+
+ Header file for collection interface.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef COLLECTION_H
+#define COLLECTION_H
+
+#ifndef EOK
+#define EOK 0
+#endif
+
+#define COL_TYPE_STRING 0x00000001 /* For elements of type string the trailing 0 is counted into the length. */
+#define COL_TYPE_BINARY 0x00000002
+#define COL_TYPE_INTEGER 0x00000004
+#define COL_TYPE_UNSIGNED 0x00000008
+#define COL_TYPE_LONG 0x00000010
+#define COL_TYPE_ULONG 0x00000020
+#define COL_TYPE_DOUBLE 0x00000040
+#define COL_TYPE_BOOL 0x00000080
+#define COL_TYPE_COLLECTION 0x00000100 /* The item of this type denotes that starting element of a collection */
+#define COL_TYPE_COLLECTIONREF 0x00000200 /* The item of this type denotes a pointer to already existing external collection */
+#define COL_TYPE_END 0x10000000 /* Special type that denotes the end of the collection. Useful when traversing collection */
+#define COL_TYPE_ANY 0x0FFFFFFF /* Special type that denotes any. Useful when traversing collection */
+
+/* Any data we deal with can't be longer than this */
+/* FIXME - make it compile time option */
+#define COL_MAX_DATA 65535
+
+/* Default class for a free form collection */
+#define COL_CLASS_DEFAULT 0
+
+/* The modes that define how one collection can be added to another */
+
+#define COL_ADD_MODE_REFERENCE 0 /* One collection will contain a pointer of another */
+#define COL_ADD_MODE_EMBED 1 /* One collection will be donated to become a part of another collection.
+ * After that the donating connection handle should not be used or freed.
+ * It means that it can be donated only once. The donation attempt will
+ * fail if the collection is referenced by other collection. */
+#define COL_ADD_MODE_CLONE 2 /* Creates a deep copy of a collection with its sub collections */
+
+
+/* Modes how the collection is traversed */
+#define COL_TRAVERSE_DEFAULT 0x00000000 /* No special flags - means it will go through all the items */
+#define COL_TRAVERSE_ONELEVEL 0x00000001 /* Flag to traverse only high level - ignored it IGNORE flag is specified */
+#define COL_TRAVERSE_END 0x00000002 /* Call handler once more when end of the collection is reached - good for processing nested collections */
+ /* Flag is implied for iterator unless FLAT flag is specified */
+#define COL_TRAVERSE_IGNORE 0x00000004 /* Ignore sub collections at all as if there are none */
+#define COL_TRAVERSE_FLAT 0x00000008 /* Flatten the collection - FIXME - not implemented yet */
+/* Additional iterator flags - not respected by traverse functions */
+#define COL_TRAVERSE_SHOWSUB 0x00010000 /* Include header of the sub collections - respected by iterator */
+ /* By default iterator returns just references and skips headers */
+ /* Ignored if ONELEVEL flag is specified and not ignored */
+ /* Ignored if FLAT flag is specified */
+#define COL_TRAVERSE_ONLYSUB 0x00020000 /* Show header of the sub collection instead of reference - respected by iterator */
+ /* Ignored if ONELEVEL flag is specified and not ignored */
+ /* Ignored if FLAT flag is specified */
+
+/* FIXME - move to event level - this does not belong to collection */
+/* Time stamp property name */
+#define TS_NAME "stamp"
+/* Time property name */
+#define T_NAME "time"
+
+/* Match values */
+#define COL_NOMATCH 0
+#define COL_MATCH 1
+
+/* Deapth for iteraor depth allocation block */
+#define STACK_DEPTH_BLOCK 15
+
+/* Public declaration of the private data */
+#ifndef COLLECTION_PRIV_H
+/* Structure that holds one property. */
+struct collection_item;
+
+/* Your implementation can assume that following members
+ * will always be members of the collection_item.
+ * but you should use get_item_xxx functions to get them.
+ * char *property;
+ * int property_len;
+ * int type;
+ * int length;
+ * void *data;
+ */
+
+
+/* Internal iterator structure */
+struct collection_iterator;
+#endif /* COLLECTION_PRIV_H */
+
+/* IMPORATNAT - the collection is a set of items of different types.
+ * There is always a header item in any collection that starts the collection.
+ * Most of the functions in the interface (unless it is explicitly mentioned
+ * otherwise) assume that the collection_item * argument points to the header element.
+ * Passing in elements extracted from the middle of collection to the functions
+ * that expect header elements is illegal. There might be not enough checking
+ * at the moment but this will be enforced in future versions of the library.
+
+/* IMPORTANT - To better understand how collections work imagine travel bags.
+ * They usually come in different sizes and one can put a bag in a bag when they put away
+ * to the shelf in a garage or closet. Collection is such bag except that you
+ * can put other bags into each other even if they are not empty.
+ * When you put items into a bag you do not see the contents of the bag.
+ * You just hold the bag. How many other bags inside this bag you do not know.
+ * But you might know that you put a "valet" somewhere there.
+ * You ask the bag you hold: "find my valet and give it to me".
+ * get_item function will return you the item that is you "valet".
+ * You can then change something or just get information about the item you retrieved.
+ * But in most cases you do not the valet itself. You want to get something from the vallet
+ * or put something into it. IMO money would be an obvious choice.
+ * To do this you use update_xxx_property functions.
+ * There might be a bag somewhere deep and you might want to add something to it.
+ * add_xxx_property_xxx functions allow you to specify sub collection you want the item
+ * to be added to. If this sub collection argument is NULL top level collection is assumed.
+ * The search in the collections users a dotted notation to refer to an item (or property)
+ * You can search for "valet" and it will find any first instance of the "valet" in
+ * your luggage. But you might have two valets. One is yours and another is your significant other's.
+ * So you might say find "my.valet". It will find valet in your bad (collection) named "my".
+ * This collection can be many levels deep inside other collections. You do not need to know
+ * the full path to get to it. But if you have the full path you can use the fill path
+ * like this "luggage.newbags.my.valet".
+ * It is useful to be able to put bags into bags as well as get them out of each other.
+ * When the collection is created the header keeps a reference count on how many
+ * copies of the collection are known to the world. So one can put a collection into collection
+ * and give up its access to it (embed) of still hold to the reference.
+ * By embedding the collection the caller effectively gives up its responsibility
+ * to destroy the collection after it is used.
+ * By extracting reference from an internal collection the caller gains access to the
+ * collection directly and thus has responsibility to destroy it after use.
+
+/* Function that creates an named collection */
+int create_collection(struct collection_item **ci,char *name,unsigned class);
+
+/* Function that destroys a collection */
+void destroy_collection(struct collection_item *ci);
+
+/* Family of functions that add properties to an event */
+/* See details about subcollection argument above. */
+/* Family includes the following convinience functions: */
+/* Add a string property to collection. Length should include the null terminating 0 */
+int add_str_property(struct collection_item *ci,char *subcollection, char *property,char *string,int length);
+/* Add a binary property to collection. */
+int add_binary_property(struct collection_item *ci,char *subcollection, char *property,void *binary_data,int length);
+/* Add an int property to collection. */
+int add_int_property(struct collection_item *ci,char *subcollection, char *property,int number);
+/* Add an unsigned int property. */
+int add_unsigned_property(struct collection_item *ci,char *subcollection, char *property,unsigned int number);
+/* Add a long property. */
+int add_long_property(struct collection_item *ci,char *subcollection, char *property,long number);
+/* Add an unsigned long property. */
+int add_ulong_property(struct collection_item *ci,char *subcollection, char *property,unsigned long number);
+/* Add a double property. */
+int add_double_property(struct collection_item *ci,char *subcollection, char *property,double number);
+/* Add a bool property. */
+int add_bool_property(struct collection_item *ci,char *subcollection, char *property,unsigned char logical);
+
+/* Add any property */
+int add_any_property(struct collection_item *ci, /* Collection to find things in */
+ char *subcollection, /* Subcollection */
+ char *property, /* Name */
+ int type, /* Type of the passed in data */
+ void *data, /* Pointer to the new data */
+ int length); /* Length of the data. For strings should include trailing 0 */
+
+/* The functions that add an item and immediately return you this item in the ret_ref parameter */
+int add_str_property_with_ref(struct collection_item *ci,char *subcollection, char *property,char *string,int length,
+ struct collection_item **ret_ref);
+int add_binary_property_with_ref(struct collection_item *ci,char *subcollection, char *property,void *binary_data,int length,
+ struct collection_item **ret_ref);
+int add_int_property_with_ref(struct collection_item *ci,char *subcollection, char *property,int number,
+ struct collection_item **ret_ref);
+int add_unsigned_property_with_ref(struct collection_item *ci,char *subcollection, char *property,unsigned int number,
+ struct collection_item **ret_ref);
+int add_long_property_with_ref(struct collection_item *ci,char *subcollection, char *property,long number,
+ struct collection_item **ret_ref);
+int add_ulong_property_with_ref(struct collection_item *ci,char *subcollection, char *property,unsigned long number,
+ struct collection_item **ret_ref);
+int add_double_property_with_ref(struct collection_item *ci,char *subcollection, char *property,double number,
+ struct collection_item **ret_ref);
+int add_bool_property_with_ref(struct collection_item *ci,char *subcollection, char *property,unsigned char logical,
+ struct collection_item **ret_ref);
+int add_any_property_with_ref(struct collection_item *ci,char *subcollection,char *property,int type,void *data,int length,
+ struct collection_item **ret_ref);
+
+/* FIXME - does not belong here - move to other place */
+/* Function to create a timestamp */
+/* Automatically adds/updates time and timestamp properties in the collection returning references */
+int set_timestamp(struct collection_item *ci,
+ struct collection_item **timestr_ref,
+ struct collection_item **timeint_ref);
+
+
+/* Update functions */
+/* All update functions search the property using the search algorithm described at the top of the header file.
+ * Use same dotted notation to specify a property.
+ */
+/* Update a string property in the collection. Length should include the null terminating 0 */
+int update_str_property(struct collection_item *ci, char *property,int mode_flags, char *string,int length);
+/* Update a binary property in the collection. */
+int update_binary_property(struct collection_item *ci, char *property,int mode_flags, void *binary_data,int length);
+/* Update an int property in the collection. */
+int update_int_property(struct collection_item *ci, char *property,int mode_flags, int number);
+/* Update an unsigned int property. */
+int update_unsigned_property(struct collection_item *ci, char *property,int mode_flags, unsigned int number);
+/* Update a long property. */
+int update_long_property(struct collection_item *ci, char *property,int mode_flags ,long number);
+/* Update an unsigned long property. */
+int update_ulong_property(struct collection_item *ci, char *property,int mode_flags, unsigned long number);
+/* Update a double property. */
+int update_double_property(struct collection_item *ci, char *property,int mode_flags, double number);
+/* Update a double property. */
+int update_bool_property(struct collection_item *ci, char *property,int mode_flags, unsigned char logical);
+
+
+/* Update property in the collection */
+int update_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type of the passed in data */
+ void *new_data, /* Pointer to the new data */
+ int length, /* Length of the data. For strings should include trailing 0 */
+ int mode_flags); /* How to traverse the collection */
+
+
+
+
+/* Add collection to collection */
+int add_collection_to_collection(struct collection_item *ci, /* Collection handle to with we add another collection */
+ char *sub_collection_name, /* Name of the sub collection to which
+ collection needs to be added as a property.
+ If NULL high level collection is assumed. */
+ char *as_property, /* Name of the collection property.
+ If NULL, same property as the name of
+ the collection being added will be used. */
+ struct collection_item *collection_to_add, /* Collection to add */
+ int mode); /* How this collection needs to be added */
+
+/* Create a deep copy of the current collection. */
+/* Referenced collections of the donor are copied as sub collections. */
+int copy_collection(struct collection_item **collection_copy,
+ struct collection_item *collection_to_copy,
+ char *name_to_use);
+
+/* Signature of the callback that needs to be used when
+ traversing a collection or looking for a specific item */
+typedef int (*item_fn)(char *property, /* The name of the property will be passed in this parameter. */
+ int property_len, /* Length of the property name will be passed in this parameter. */
+ int type, /* Type of the data will be passed in this parameter */
+ void *data, /* Pointer to the data will be passed in this parameter */
+ int length, /* Length of data will be passed in this parameter */
+ void *custom_dat, /* Custom data will be passed in this parameter */
+ int *stop); /* Pointer to variable where the handler can put non zero to stop processing */
+
+/* Function to traverse the entire collection including optionally sub collections */
+int traverse_collection(struct collection_item *ci, /* Collection to traverse */
+ int mode_flags, /* Flags defining how to traverse */
+ item_fn item_handler, /* Handler called for each item */
+ void *custom_data); /* Custom data passed around */
+
+/* Search function. Looks up an item in the collection based on the property.
+ Actually it is a traverse function with spacial traversing logic.
+ It is the responsibility of the handler to set something in the custom data
+ to indicate that the item was found.
+ Function will not return error if the item is not found.
+ It is the responsibility of the calling application to check
+ the data passed in custom_data and see if the item was found and
+ that the action was performed.
+ */
+int get_item_and_do(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ item_fn item_handler, /* Function to call when the item is found */
+ void *custom_data); /* Custom data passed around */
+
+/* Convenience function to get individual item */
+/* Caller should be aware that this is not a copy of the item
+ * but the pointer to actual item stored in the collection.
+ * The returned pointer should never be altered or freed by caller of the function.
+ * The caller should be sure that the collection does not go out of scope
+ * while the pointer to its data is in use.
+ * Working with the internals of the collection item structure directly
+ * may cause problems in future if the internal implementation changes.
+ */
+int get_item(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ struct collection_item **item); /* Found item */
+
+/* Group of functions that allows retrieving individual elements of the collection_item
+ * hiding the internal implementation.
+ */
+char *get_item_property(struct collection_item *ci,int *property_len);
+int get_item_type(struct collection_item *ci);
+int get_item_length(struct collection_item *ci);
+void *get_item_data(struct collection_item *ci);
+
+/* If you want to modify the item that you got as a result of iterating through collection
+ * or by calling get_item(). If you want to rename item provide a new name in the property
+ * argument. If you want the data to remain unchanged use NULL as data parameter.
+ * If item is a reference or collection the call will return error.
+ * Previous type and data of the item is destroyed.
+ */
+int modify_item(struct collection_item *item,
+ char *property,
+ int type,
+ void *data,
+ int length);
+
+/* Convenience functions that wrap modify_tem(). */
+int modify_str_item(struct collection_item *item,
+ char *property,
+ char *string,
+ int length);
+int modify_binary_item(struct collection_item *item,
+ char *property,
+ void *binary_data,
+ int length);
+int modify_bool_item(struct collection_item *item,
+ char *property,
+ unsigned char logical);
+int modify_int_item(struct collection_item *item,
+ char *property,
+ int number);
+int modify_long_item(struct collection_item *item,
+ char *property,
+ long number);
+int modify_ulong_item(struct collection_item *item,
+ char *property,
+ unsigned long number);
+int modify_unsigned_item(struct collection_item *item,
+ char *property,
+ unsigned number);
+int modify_double_item(struct collection_item *item,
+ char *property,
+ double number);
+
+/* Delete property from the collection */
+int delete_property(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags); /* How to traverse the collection */
+
+
+/* Convenience function to check if the property is indeed in the collection */
+int is_item_in_collection(struct collection_item *ci, /* Collection to find things in */
+ char *property_to_find, /* Name to match */
+ int type, /* Type filter */
+ int mode_flags, /* How to traverse the collection */
+ int *found); /* Boolean that turns to nonzero if the match is found */
+
+
+/* Get collection - get a pointer to a collection included into another collection */
+/* Delete extracted collection after use to decrease reference count. */
+int get_collection_reference(struct collection_item *ci, /* High level collection */
+ struct collection_item **acceptor, /* The pointer that will accept extracted handle */
+ char *collection_to_find); /* Name to of the collection */
+
+/* Get collection - if current item is a reference get a real collection from it. */
+/* Delete extracted collection after use to decrease reference count. */
+int get_reference_from_item(struct collection_item *ci, /* Reference element of the high level collection */
+ struct collection_item **acceptor); /* The pointer that will accept extracted handle */
+
+
+/* Bind iterator to a collection */
+int bind_iterator(struct collection_iterator **iterator, /* The iterator to bind */
+ struct collection_item *ci, /* Collection to bind iterator to */
+ int mode_flags); /* How the collection needs to be iterated */
+
+/* Unbind the iterator from the collection */
+void unbind_iterator(struct collection_iterator *iterator);
+
+/* Get items from the collection one by one following the tree */
+int iterate_collection(struct collection_iterator *iterator, struct collection_item **item);
+
+/* Stop processing this subcollection and move to the next item in the collection 'level' levels up.*/
+/* 'Level' parameter indicates how many levels up you want to jump. If 0 - call is a no op.
+ * If the depth is less than requested level function will return error EINVAL.
+ */
+int iterate_up(struct collection_iterator *iterator, int level);
+
+/* How deep are we relative to the top level.*/
+int get_iterator_depth(struct collection_iterator *iterator, int *depth);
+
+/* FIXME - Do we need to be able to rewind iterator? */
+
+/* Set collection class */
+int set_collection_class(struct collection_item *item, /* Collection */
+ unsigned class); /* Class of the collection */
+
+/* Get collection class */
+int get_collection_class(struct collection_item *item, /* Collection */
+ unsigned *class); /* Class of the collection */
+
+
+/* Get collection count */
+int get_collection_count(struct collection_item *item, /* Collection */
+ unsigned *count); /* Count of elements in this collection.
+ * Each subcollection is counted as 1 element.
+ */
+
+/* Convenience function to check if the collection is of the specific class */
+/* In case of internal error assumes that collection is not of the right class */
+int is_of_class(struct collection_item *item, /* Collection */
+ unsigned class); /* Class of the collection */
+
+
+
+#endif
diff --git a/common/collection/collection_priv.h b/common/collection/collection_priv.h
new file mode 100644
index 00000000..8dd6d802
--- /dev/null
+++ b/common/collection/collection_priv.h
@@ -0,0 +1,70 @@
+/*
+ COLLECTION LIBRARY
+
+ Header file for internal structures used by the collection interface.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef COLLECTION_PRIV_H
+#define COLLECTION_PRIV_H
+
+/* Define real strcutures */
+/* Structure that holds one property.
+ * This structure should never be assumed and used directly other than
+ * inside the collection.c that contains actual implementation or
+ * collection_tools.c or collection_utils.c.
+ */
+struct collection_item {
+ /* Member that contains element linking information.
+ * This member should never be directly accessed by an application.
+ */
+ struct collection_item *next;
+
+ /* Your implementation can assume that these members
+ * will always be members of the collection_item.
+ * but you should use get_item_xxx functions to get them.
+ */
+ char *property;
+ int property_len;
+ int type;
+ int length;
+ void *data;
+};
+
+
+/* Internal iterator structure - exposed for reference.
+ * Never access internals of this structure in your application.
+ */
+struct collection_iterator {
+ struct collection_item *top;
+ struct collection_item **stack;
+ unsigned stack_size;
+ unsigned stack_depth;
+ int flags;
+};
+
+
+/* Special type of data that stores collection header information. */
+struct collection_header {
+ struct collection_item *last;
+ unsigned reference_count;
+ unsigned count;
+ unsigned class;
+};
+
+#endif
+
diff --git a/common/collection/collection_tools.c b/common/collection/collection_tools.c
new file mode 100644
index 00000000..1c96f6f8
--- /dev/null
+++ b/common/collection/collection_tools.c
@@ -0,0 +1,587 @@
+/*
+ COLLECTION LIBRARY
+
+ Additional functions for printing and debugging collections.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+
+#include <stdio.h>
+#include <malloc.h>
+#include <errno.h>
+#include "trace.h"
+#include "collection_priv.h"
+#include "collection.h"
+#include "collection_tools.h"
+
+/* Debug handle */
+int debug_handle(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy)
+{
+ int i;
+ int nest_level;
+
+ TRACE_FLOW_STRING("debug_handle","Entry.");
+
+
+ nest_level = *(int *)(custom_data);
+ TRACE_INFO_NUMBER("We are getting this pointer:",custom_data);
+ TRACE_INFO_NUMBER("Nest level:",nest_level);
+
+ switch(type) {
+ case COL_TYPE_STRING:
+ printf("%*s %s[%d] str: %s (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ (char *)(data),
+ (int)(nest_level));
+ break;
+ case COL_TYPE_BINARY:
+ printf("%*s %s[%d] bin: ",
+ (nest_level-1)*4,"",
+ property,
+ length);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case COL_TYPE_INTEGER:
+ printf("%*s %s[%d] int: %d (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((int *)(data)),
+ nest_level);
+ break;
+ case COL_TYPE_UNSIGNED:
+ printf("%*s %s[%d] uint: %u (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((unsigned int *)(data)),
+ nest_level);
+ break;
+ case COL_TYPE_LONG:
+ printf("%*s %s[%d] long: %ld (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((long *)(data)),
+ nest_level);
+ break;
+ case COL_TYPE_ULONG:
+ printf("%*s %s[%d] ulong: %lu (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((unsigned long *)(data)),
+ nest_level);
+ break;
+ case COL_TYPE_DOUBLE:
+ printf("%*s %s[%d] double: %.4f (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ *((double *)(data)),
+ nest_level);
+ break;
+ case COL_TYPE_BOOL:
+ printf("%*s %s[%d] bool: %s (%d)\n",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ (*((unsigned char *)(data)) == '\0') ? "flase" : "true",
+ (int)(nest_level));
+ break;
+ case COL_TYPE_COLLECTION:
+ nest_level++;
+ printf("%*s %s[%d] header: count %d, ref_count %d class %d data: ",
+ (nest_level-1)*4,"",
+ property,
+ length,
+ ((struct collection_header *)(data))->count,
+ ((struct collection_header *)(data))->reference_count,
+ ((struct collection_header *)(data))->class);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case COL_TYPE_COLLECTIONREF:
+ printf("%*s %s[%d] external link: ",
+ (nest_level-1)*4,"",
+ property,
+ length);
+ for(i=0;i<length;i++) printf("%02X",*((unsigned char *)(data+i)));
+ printf(" (%d)\n",(int)(nest_level));
+ break;
+ case COL_TYPE_END:
+ nest_level--;
+ /* printf("Reduced nest level\n");*/
+ break;
+ default:
+ printf("Not implemented yet.\n");
+ break;
+ }
+ *(int *)(custom_data) = nest_level;
+ TRACE_INFO_NUMBER("Nest level at the end:",nest_level);
+ TRACE_FLOW_STRING("debug_handle","Success exit.");
+ return EOK;
+}
+
+/* Convenience function to debug an item */
+inline int debug_item(struct collection_item *item)
+{
+ int dummy = 0;
+ int nest_level = 0;
+ return debug_handle(item->property,
+ item->property_len,
+ item->type,
+ item->data,
+ item->length,
+ (void *)(&nest_level),
+ &dummy);
+}
+
+
+/* Print collection for debugging purposes */
+int debug_collection(struct collection_item *handle,int flag)
+{
+ int error = EOK;
+ int nest_level=0;
+
+ TRACE_FLOW_STRING("debug_collection","Entry.");
+
+ printf("DEBUG COLLECTION %s\n",handle->property);
+
+ flag |= COL_TRAVERSE_END;
+
+ printf("Traverse flags %d\n",flag);
+
+ /* Traverse collection */
+ error = traverse_collection(handle,flag,debug_handle,(void *)(&nest_level));
+ if(error) printf("Error debuging collection %d\n",error);
+
+ TRACE_FLOW_STRING("debug_collection","Exit.");
+ return error;
+}
+
+
+/* Return a static string based on type of the element */
+static inline const char *get_type(int type)
+{
+ switch(type) {
+ case COL_TYPE_STRING: return COL_TYPE_NAME_STRING;
+ case COL_TYPE_INTEGER: return COL_TYPE_NAME_INTEGER;
+ case COL_TYPE_UNSIGNED: return COL_TYPE_NAME_UNSIGNED;
+ case COL_TYPE_LONG: return COL_TYPE_NAME_LONG;
+ case COL_TYPE_ULONG: return COL_TYPE_NAME_ULONG;
+ case COL_TYPE_BINARY: return COL_TYPE_NAME_BINARY;
+ case COL_TYPE_DOUBLE: return COL_TYPE_NAME_DOUBLE;
+ case COL_TYPE_BOOL: return COL_TYPE_NAME_BOOL;
+ default: return COL_TYPE_NAME_UNKNOWN;
+ }
+
+}
+
+/* Calculate the potential size of the item */
+int get_data_len(int type, int length)
+{
+ int len = 0;
+
+ TRACE_FLOW_STRING("util_get_item_len","Entry point");
+
+ switch(type) {
+ case COL_TYPE_INTEGER:
+ case COL_TYPE_UNSIGNED:
+ case COL_TYPE_LONG:
+ case COL_TYPE_ULONG:
+ len = 15;
+ break;
+ case COL_TYPE_STRING:
+ case COL_TYPE_BINARY:
+ len = length * 2 + 2;
+ break;
+ case COL_TYPE_DOUBLE:
+ len = 64;
+ break;
+ case COL_TYPE_BOOL:
+ len = 6;
+ break;
+ default:
+ len = 0;
+ break;
+ }
+
+ TRACE_FLOW_STRING("util_get_item_len","Exit point");
+
+ return len;
+}
+
+/* Copy data escaping characters */
+static int copy_esc(char *dest,char *source,char esc)
+{
+ int i=0;
+ int j=0;
+
+ *(dest +j) = esc;
+ j++;
+
+ while(*(source+i) != '\0') {
+ if((*(source+i) == '\\') ||
+ (*(source+i) == esc)) {
+
+ *(dest +j) = '\\';
+ j++;
+
+ }
+ *(dest +j) = *(source +i);
+ i++;
+ j++;
+ }
+ *(dest +j) = esc;
+ j++;
+
+ return j;
+}
+
+/* Grow buffer to accomodate more space */
+int grow_buffer(struct serial_data *buf_data, int len)
+{
+ void *tmp;
+
+ TRACE_FLOW_STRING("grow_buffer","Entry point");
+ TRACE_INFO_NUMBER("Current length: ",buf_data->length);
+ TRACE_INFO_NUMBER("Increment length: ",len);
+ TRACE_INFO_NUMBER("Expected length: ",buf_data->length+len);
+ TRACE_INFO_NUMBER("Current size: ",buf_data->size);
+
+ /* Grow buffer if needed */
+ while(buf_data->length+len >= buf_data->size) {
+ errno = 0;
+ tmp = realloc(buf_data->buffer,buf_data->size+BLOCK_SIZE);
+ if(tmp == NULL) {
+ TRACE_ERROR_NUMBER("Error. Failed to allocate memory. Errno: ",errno);
+ return errno;
+ }
+ buf_data->buffer = (char *)(tmp);
+ buf_data->size += BLOCK_SIZE;
+ TRACE_INFO_NUMBER("New size: ",buf_data->size);
+
+ }
+
+ TRACE_INFO_NUMBER("Final size: ",buf_data->size);
+ TRACE_FLOW_STRING("grow_buffer","Success Exit.");
+ return EOK;
+}
+
+/* Specail function to add different formatting symbols to the output */
+int put_marker(struct serial_data *buf_data, void *data, int len)
+{
+ int error = EOK;
+
+ TRACE_FLOW_STRING("put_marker","Entry point");
+ TRACE_INFO_NUMBER("Marker length: ",len);
+
+ error = grow_buffer(buf_data, len);
+ if(error) {
+ TRACE_ERROR_NUMBER("grow_buffer failed with: ",error);
+ return error;
+ }
+ memcpy(buf_data->buffer+buf_data->length,data,len);
+ buf_data->length+=len;
+ *(buf_data->buffer+buf_data->length) = '\0';
+
+ TRACE_FLOW_STRING("put_marker","Success exit");
+ return error;
+}
+
+/* Add item's data */
+int serialize(char *property_in,
+ int property_len_in,
+ int type,
+ void *data_in,
+ int length_in,
+ void *custom_data,
+ int *dummy)
+{
+ int len;
+ struct serial_data *buf_data;
+ char *property;
+ void *data;
+ int property_len;
+ int length;
+ int error = EOK;
+ int i;
+
+ TRACE_FLOW_STRING("serialize","Entry point");
+
+ *dummy = 0;
+
+ /* Check is there is buffer. If not allocate */
+ buf_data = (struct serial_data *)(custom_data);
+ if(buf_data == (struct serial_data *)(NULL)) {
+ TRACE_ERROR_STRING("Error.","Storage data is not passed in!");
+ return EINVAL;
+ }
+ if(buf_data->buffer == NULL) {
+ TRACE_INFO_STRING("First time use.","Allocating buffer.");
+ errno = 0;
+ buf_data->buffer = malloc(BLOCK_SIZE);
+ if(buf_data->buffer == NULL) {
+ TRACE_ERROR_NUMBER("Error. Failed to allocate memory. Errno: ",errno);
+ return errno;
+ }
+ *(buf_data->buffer)='\0';
+ buf_data->length=0;
+ buf_data->size = BLOCK_SIZE;
+ }
+
+ TRACE_INFO_NUMBER("Buffer len: ", buf_data->length);
+ TRACE_INFO_NUMBER("Buffer size: ", buf_data->size);
+ TRACE_INFO_STRING("Buffer: ", buf_data->buffer);
+
+ /* Check the beginning of the collection */
+ if(type == COL_TYPE_COLLECTION) {
+ TRACE_INFO_STRING("Serializing collection: ", property_in);
+ TRACE_INFO_STRING("First header. ", "");
+ if((error=put_marker(buf_data,"(",1))) return error;
+ property = TEXT_COLLECTION;
+ property_len = TEXT_COLLEN;
+ data = property_in;
+ length = property_len_in+1;
+ type=COL_TYPE_STRING;
+ buf_data->nest_level++;
+ }
+ /* Check for subcollections */
+ else if(type==COL_TYPE_COLLECTIONREF) {
+ /* Skip */
+ TRACE_FLOW_STRING("serialize","skip reference return");
+ return EOK;
+ }
+ /* Check for the end of the collection */
+ else if(type==COL_TYPE_END) {
+ if((buf_data->length>0) &&
+ (*(buf_data->buffer+buf_data->length-1) == ',')) {
+ buf_data->length--;
+ *(buf_data->buffer+buf_data->length) = '\0';
+ }
+ if(buf_data->nest_level>0) {
+ buf_data->nest_level--;
+ if((error=put_marker(buf_data,")",1))) return error;
+ }
+ TRACE_FLOW_STRING("serialize","end collection item processed returning");
+ return EOK;
+ }
+ else {
+ property = property_in;
+ property_len = property_len_in;
+ data = data_in;
+ length = length_in;
+ }
+
+ TRACE_INFO_STRING("Property: ", property);
+ TRACE_INFO_NUMBER("Property length: ", property_len);
+
+ /* Start with property and "=" */
+ if((error=put_marker(buf_data,property,property_len)) ||
+ (error=put_marker(buf_data,"=",1))) {
+ TRACE_ERROR_NUMBER("put_marker returned error: ",error);
+ return error;
+ }
+ /* Get projected length of the item */
+ len = get_data_len(type,length);
+ TRACE_INFO_NUMBER("Expected data length: ",len);
+ TRACE_INFO_STRING("Buffer so far: ", buf_data->buffer);
+
+ /* Make sure we have enough space */
+ if((error=grow_buffer(buf_data,len))) {
+ TRACE_ERROR_NUMBER("grow_buffer returned error: ",error);
+ return error;
+ }
+
+ /* Add the value */
+ switch(type) {
+ case COL_TYPE_STRING:
+ /* Escape double quotes */
+ len = copy_esc(buf_data->buffer+buf_data->length,(char *)(data),'"');
+ break;
+ case COL_TYPE_BINARY:
+ *(buf_data->buffer+buf_data->length) = '\'';
+ for(i=0;i<length;i++) sprintf(buf_data->buffer+buf_data->length+i*2 + 1,"%02X",*((unsigned char *)(data+i)));
+ len = length * 2 + 1;
+ *(buf_data->buffer+buf_data->length + len) = '\'';
+ len++;
+ break;
+ case COL_TYPE_INTEGER:
+ len = sprintf(buf_data->buffer+buf_data->length,"%d",*((int *)(data)));
+ break;
+ case COL_TYPE_UNSIGNED:
+ len = sprintf(buf_data->buffer+buf_data->length,"%u",*((unsigned int *)(data)));
+ break;
+ case COL_TYPE_LONG:
+ len = sprintf(buf_data->buffer+buf_data->length,"%ld",*((long *)(data)));
+ break;
+ case COL_TYPE_ULONG:
+ len = sprintf(buf_data->buffer+buf_data->length,"%lu",*((unsigned long *)(data)));
+ break;
+ case COL_TYPE_DOUBLE:
+ len = sprintf(buf_data->buffer+buf_data->length,"%.4f",*((double *)(data)));
+ break;
+ case COL_TYPE_BOOL:
+ len = sprintf(buf_data->buffer+buf_data->length,"%s",(*((unsigned char *)(data)) == '\0') ? "false" : "true");
+ break;
+ default:
+ *(buf_data->buffer+buf_data->length) = '\0';
+ len = 0;
+ break;
+ }
+
+ /* Adjust length */
+ buf_data->length+=len;
+ *(buf_data->buffer+buf_data->length) = '\0';
+
+ /* Always put a comma at the end */
+ if((error=put_marker(buf_data,",",1))) {
+ TRACE_ERROR_NUMBER("put_marker returned error: ",error);
+ return error;
+ }
+
+ TRACE_INFO_STRING("Data: ",buf_data->buffer);
+ TRACE_FLOW_STRING("serialize","Exit point");
+ return EOK;
+
+}
+
+/* Print the collection using default serialization */
+int print_collection(struct collection_item *handle)
+{
+ struct serial_data buf_data;
+ int error = EOK;
+
+ TRACE_FLOW_STRING("print_collection", "Entry");
+
+ printf("COLLECTION:\n");
+
+ buf_data.buffer=NULL;
+ buf_data.length=0;
+ buf_data.size=0;
+ buf_data.nest_level=0;
+
+ /* Traverse collection */
+ error = traverse_collection(handle,COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END ,serialize,(void *)(&buf_data));
+ if(error) printf("Error traversing collection %d\n",error);
+ else printf("%s\n",buf_data.buffer);
+
+ free(buf_data.buffer);
+
+ TRACE_FLOW_NUMBER("print_collection returning", error);
+ return error;
+}
+
+/* Print the collection using iterator */
+int print_collection2(struct collection_item *handle)
+{
+ struct collection_iterator *iterator = (struct collection_iterator *)(NULL);
+ int error = EOK;
+ struct collection_item *item = (struct collection_item *)(NULL);
+ int nest_level=0;
+ int dummy = 0;
+ int line = 1;
+
+ TRACE_FLOW_STRING("print_collection2", "Entry");
+
+ /* If we have something to print print it */
+ if(handle == (struct collection_item *)(NULL)) {
+ TRACE_ERROR_STRING("No error list","");
+ return EINVAL;
+ }
+
+ /* Bind iterator */
+ error = bind_iterator(&iterator,handle,COL_TRAVERSE_DEFAULT|COL_TRAVERSE_END|COL_TRAVERSE_SHOWSUB);
+ if(error) {
+ TRACE_ERROR_NUMBER("Error (bind):",error);
+ return error;
+ }
+
+ do {
+ /* Loop through a collection */
+ error = iterate_collection(iterator, &item);
+ if(error) {
+ TRACE_ERROR_NUMBER("Error (iterate):",error);
+ unbind_iterator(iterator);
+ return error;
+ }
+
+ /* Are we done ? */
+ if(item == (struct collection_item *)(NULL)) break;
+
+ if(item->type != COL_TYPE_END) printf("%05d",line);
+
+ debug_handle(item->property,
+ item->property_len,
+ item->type,
+ item->data,
+ item->length,
+ (void *)(&nest_level),
+ &dummy);
+ line++;
+ }
+ while(1);
+
+ /* Do not forget to unbind iterator - otherwise there will be a leak */
+ unbind_iterator(iterator);
+
+ TRACE_INFO_STRING("print_collection2", "Exit");
+ return EOK;
+}
+
+/* Find and print one item using default serialization */
+int print_item(struct collection_item *handle, char *name)
+{
+ struct serial_data buf_data;
+ int error = EOK;
+
+ TRACE_FLOW_STRING("print_item", "Entry");
+
+ printf("FIND ITEM:\n");
+
+ buf_data.buffer=NULL;
+ buf_data.length=0;
+ buf_data.size=0;
+ buf_data.nest_level=0;
+
+ error = get_item_and_do(handle, name, COL_TYPE_ANY,COL_TRAVERSE_DEFAULT, serialize,&buf_data);
+ if(error) printf("Error searching collection %d\n",error);
+ else {
+ if(buf_data.buffer != NULL) {
+ if(buf_data.length> 0) buf_data.length--;
+ *(buf_data.buffer+buf_data.length)= '\0',
+ printf("%s\n",buf_data.buffer);
+ free(buf_data.buffer);
+ }
+ else printf("Name %s is not found in the collection %s.\n",name,handle->property);
+ }
+
+ TRACE_FLOW_NUMBER("print_item returning", error);
+ return error;
+}
+
+
diff --git a/common/collection/collection_tools.h b/common/collection/collection_tools.h
new file mode 100644
index 00000000..726f21c7
--- /dev/null
+++ b/common/collection/collection_tools.h
@@ -0,0 +1,98 @@
+/*
+ COLLECTION LIBRARY
+
+ Header file for supplementary functions that provide
+ printing and debugging of collections.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef COLLECTION_TOOLS_H
+#define COLLECTION_TOOLS_H
+
+#include "trace.h"
+#include "collection.h"
+
+#ifdef HAVE_TRACE
+#define DEBUG_COLLECTION(collection) debug_collection(collection,COL_TRAVERSE_DEFAULT);
+#else
+#define DEBUG_COLLECTION(collection) ;
+#endif
+
+#define COL_TYPE_NAME_STRING "string"
+#define COL_TYPE_NAME_BINARY "bin"
+#define COL_TYPE_NAME_INTEGER "int"
+#define COL_TYPE_NAME_UNSIGNED "uint"
+#define COL_TYPE_NAME_LONG "long"
+#define COL_TYPE_NAME_ULONG "ulong"
+#define COL_TYPE_NAME_DOUBLE "double"
+#define COL_TYPE_NAME_BOOL "bool"
+#define COL_TYPE_NAME_UNKNOWN "unknown"
+
+#define TEXT_COLLECTION "SET"
+#define TEXT_COLLEN 3
+
+#define BLOCK_SIZE 1024
+
+struct serial_data {
+ char *buffer;
+ int size;
+ int length;
+ int nest_level;
+};
+
+
+/* Calculate the potential size of the item */
+int get_data_len(int type, int length);
+
+/* Grow buffer to accomodate more space */
+int grow_buffer(struct serial_data *buf_data, int len);
+
+/* Specail function to add different formatting symbols to the output */
+int put_marker(struct serial_data *buf_data, void *data, int len);
+
+/* Serialization of data user handler */
+int serialize(char *property_in,
+ int property_len_in,
+ int type,
+ void *data_in,
+ int length_in,
+ void *custom_data,
+ int *dummy);
+
+/* Debug handle */
+int debug_handle(char *property,
+ int property_len,
+ int type,
+ void *data,
+ int length,
+ void *custom_data,
+ int *dummy);
+
+/* Convenience function to debug an item */
+int debug_item(struct collection_item *item);
+
+/* Print collection for debugging purposes */
+int debug_collection(struct collection_item *handle,int flag);
+
+/* Print the collection using default serialization */
+int print_collection(struct collection_item *handle);
+
+
+/* Find and print one item using default serialization */
+int print_item(struct collection_item *handle, char *name);
+
+#endif
diff --git a/common/collection/collection_ut.c b/common/collection/collection_ut.c
new file mode 100644
index 00000000..ec38d556
--- /dev/null
+++ b/common/collection/collection_ut.c
@@ -0,0 +1,712 @@
+/*
+ COLLECTION LIBRARY
+
+ Collection unit test.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ Collection Library is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Collection Library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with Collection Library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+
+#include <stdio.h>
+#include <string.h>
+#include <errno.h>
+#define TRACE_HOME
+#include "trace.h"
+#include "collection.h"
+#include "collection_tools.h"
+
+
+int ref_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ TRACE_FLOW_STRING("ref_collection_test","Entry.");
+
+ printf("\n\nREF TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer",0)) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ printf("Creating SOCKET collection.\n");
+
+ if((error=create_collection(&socket,"socket",0)) ||
+ (error=add_int_property(socket,NULL,"id",1)) ||
+ (error=add_long_property(socket,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET collection as a reference named PEER\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket,NULL,"peer",peer,COL_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add collection to collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ printf("About to destroy PEER\n");
+ destroy_collection(peer);
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+
+ printf("About to extract PEER\n");
+ error = get_collection_reference(socket,&peer,"peer");
+ if(error) {
+ destroy_collection(socket);
+ printf("Failed to extract collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+ destroy_collection(peer);
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ destroy_collection(socket);
+ TRACE_FLOW_NUMBER("ref_collection_test. Returning",error);
+
+ printf("\n\nEND OF REF TEST!!!.\n\n\n");
+
+ return error;
+
+}
+
+
+int single_collection_test()
+{
+ struct collection_item *handle;
+ int error = EOK;
+
+ TRACE_FLOW_STRING("single_collection_test","Entry.");
+
+ if((error=create_collection(&handle,"string_test",0)) ||
+ (error=add_str_property(handle,NULL,"property_1","some data",0)) ||
+ (error=add_str_property(handle,NULL,"property_2","some other data",2)) ||
+ (error=add_str_property(handle,NULL,"property_3","more data",7))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+
+ error = add_str_property(handle,NULL,"property 1","some data",0);
+ if(error) printf("Expected error adding bad property to collection %d\n",error);
+ else {
+ printf("Expected error but got success\n");
+ return -1;
+ }
+
+ error=add_double_property(handle,NULL,"double",0.253545);
+ if(error) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+
+ error=update_double_property(handle,"double",COL_TRAVERSE_DEFAULT,1.999999);
+ if(error) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(handle);
+ return error;
+ }
+ printf("Created collection\n");
+
+ /* Traverse collection */
+ error = debug_collection(handle,COL_TRAVERSE_DEFAULT);
+ if(error) {
+ printf("Error debugging collection %d\n",error);
+ return error;
+ }
+ error = print_collection(handle);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+
+ destroy_collection(handle);
+
+ TRACE_FLOW_NUMBER("single_collection_test. Error: ",error);
+ return error;
+}
+
+int add_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+
+ int error = EOK;
+
+ TRACE_FLOW_STRING("add_collection_test","Entry.");
+
+ printf("\n\nADD TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer",0)) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ printf("Creating SOCKET collection.\n");
+
+ if((error=create_collection(&socket,"socket",0)) ||
+ (error=add_int_property(socket,NULL,"id",1)) ||
+ (error=add_long_property(socket,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET collection as a reference named PEER\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket,NULL,"peer",peer,COL_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+ destroy_collection(peer);
+ debug_collection(socket,COL_TRAVERSE_DEFAULT);
+ destroy_collection(socket);
+ TRACE_FLOW_NUMBER("add_collection_test. Returning",error);
+ return error;
+}
+
+int mixed_collection_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket1;
+ struct collection_item *socket2;
+ struct collection_item *packet;
+ struct collection_item *event;
+ struct collection_item *host;
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int found = 0;
+ int class = 0;
+
+ int error = EOK;
+
+ TRACE_FLOW_STRING("mixed_collection_test","Entry.");
+
+ printf("\n\nMIXED TEST!!!.\n\n\n");
+ printf("Creating PEER collection.\n");
+
+ if((error=create_collection(&peer,"peer",0)) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ printf("Creating HOST collection.\n");
+
+ if((error=create_collection(&host,"host",0)) ||
+ (error=add_str_property(host,NULL,"hostname","myhost.mytest.com",0)) ||
+ (error=add_str_property(host,NULL,"IPv4","20.20.20.20",13)) ||
+ (error=add_str_property(host,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0)) ||
+ (error=add_double_property(host,NULL,"double",0.253545))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ destroy_collection(host);
+ return error;
+ }
+
+ debug_collection(host,COL_TRAVERSE_DEFAULT);
+
+ printf("Creating SOCKET1 collection.\n");
+
+ if((error=create_collection(&socket1,"socket1",0)) ||
+ (error=add_int_property(socket1,NULL,"id",1)) ||
+ (error=add_long_property(socket1,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket1,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket1,COL_TRAVERSE_DEFAULT);
+ printf("Creating a copy of SOCKET1 collection named SOCKET2.\n");
+
+ error = copy_collection(&socket2,socket1,"socket2");
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ printf("Failed to copy collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,COL_TRAVERSE_DEFAULT);
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ printf("Adding PEER collection to SOCKET2 collection as a reference named PEER2\n");
+
+ /* Embed peer host into the socket2 as reference */
+ error = add_collection_to_collection(socket2,NULL,"peer2",peer,COL_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,COL_TRAVERSE_DEFAULT);
+
+ printf("Creating an EVENT collection.\n");
+
+ /* Construct event */
+ error = create_collection(&event,"event",0);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to create collection. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,COL_TRAVERSE_DEFAULT);
+
+ printf("Adding HOST to EVENT.\n");
+
+ /* Add host to event */
+ error = add_collection_to_collection(event,NULL,NULL,host,COL_ADD_MODE_REFERENCE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,COL_TRAVERSE_DEFAULT);
+
+ printf("Embed SOCKET1 into EVENT.\n");
+ /* Donate socket1 to event */
+ /* Socket1 should not be used after this */
+ error = add_collection_to_collection(event,NULL,NULL,socket1,COL_ADD_MODE_EMBED);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ printf("Traverse one level:\n");
+ debug_collection(event,COL_TRAVERSE_ONELEVEL);
+ printf("Traverse ignore subcollections:\n");
+ debug_collection(event,COL_TRAVERSE_IGNORE);
+ printf("Traverse normal:\n");
+ debug_collection(event,COL_TRAVERSE_DEFAULT);
+ debug_collection(socket1,COL_TRAVERSE_DEFAULT);
+
+ printf("SOCKET1 MUST NO BE USED AFTER THIS POINT!!!\n");
+ socket1 = (struct collection_item *)(NULL);
+
+ printf("Add collection PEER as PEER1 to subcollection SOCKET1 of the EVENT.\n");
+
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ error = add_collection_to_collection(event,"socket1","peer1",peer,COL_ADD_MODE_CLONE);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add collections. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,COL_TRAVERSE_DEFAULT);
+
+ printf("Add property named TIMEOUT to PEER collection.\n");
+
+ /* Add new property to the peer collection */
+ error = add_int_property(peer,NULL,"timeout",5);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(socket2,COL_TRAVERSE_DEFAULT);
+
+ printf("Add property named DELAY to PEER1 collection.\n");
+
+ error = add_int_property(event,"peer1","delay",10);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ debug_collection(event,COL_TRAVERSE_DEFAULT);
+ debug_collection(host,COL_TRAVERSE_DEFAULT);
+
+ printf("Check if property PEER1.DELAY is in the EVENT collection.\n");
+
+ /* Check if the property in the collection */
+ found = 0;
+ error = is_item_in_collection(event, "peer1.delay", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to check property. Error %d\n",error);
+ return error;
+ }
+
+ if (found == 1) printf("Property is found!\n");
+ else printf("Error property is not found!\n");
+
+
+ print_item(event, "peer1.IPv6");
+ print_item(event, "event.socket1.peer1.IPv6");
+ print_item(event, "event.peer1.IPv6");
+ print_item(event, "speer1.IPv6");
+ print_item(event, "eer1.IPv6");
+ print_item(event, ".peer1.IPv6");
+ print_item(event, "t.peer1.IPv6");
+
+ /* Traverse collection */
+ error = print_collection2(event);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+
+ printf("Delete property PEER1.DELAY from the EVENT collection.\n");
+
+ error = delete_property(event,"peer1.delay",COL_TYPE_ANY, COL_TRAVERSE_DEFAULT);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(host);
+ /* No socket1 any more :) */
+ destroy_collection(socket2);
+ printf("Failed to delete property. Error %d\n",error);
+ return error;
+ }
+
+ printf("Printing EVENT.\n");
+
+ /* Traverse collection */
+ error = print_collection2(event);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+ printf("Debugging EVENT.\n");
+
+ error = debug_collection(event,COL_TRAVERSE_DEFAULT);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+
+ printf("Cleanup of the collections PEER, HOST and SOCKET2.\n");
+
+ /* Destroy a referenced collection */
+ destroy_collection(peer);
+ destroy_collection(host);
+ destroy_collection(socket2);
+
+ printf("Printing EVENT again.\n");
+
+ /* Traverse collection again - peer should still be there */
+ error = print_collection(event);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+
+ printf("Debugging EVENT again.\n");
+
+ error = debug_collection(event,COL_TRAVERSE_DEFAULT);
+ if(error) {
+ printf("Error printing collection %d\n",error);
+ return error;
+ }
+
+ printf("Attempt to add property to a referenced collection.\n");
+
+ /* Some negative tests */
+ /* Can't add attributes to the referenced collection */
+ error = add_int_property(event,"host","session",500);
+ if(error != 0) printf("Error was NOT able to add property to a referenced collection.\n");
+ else {
+ printf("Unexpected success which is an implementation error.\n");
+ return error;
+ }
+
+ printf("Attempt to delete non-existent property.\n");
+
+ /* Can't delete non exitent property */
+ error = delete_property(event,"host.host",COL_TYPE_ANY, COL_TRAVERSE_DEFAULT);
+ if(error == 0) {
+ printf("Error was able to delete property that does not exist.\n");
+ return -1;
+ }
+ else printf("Expected error %d\n",error);
+
+ /* Set collection class */
+ error = set_collection_class(event,2);
+ if(error != 0) {
+ printf("Error was NOT able to set class.\n");
+ return error;
+ }
+
+ error = get_collection_class(event,&class);
+ if(error != 0) {
+ printf("Error was NOT able to get class.\n");
+ return error;
+ }
+ else printf("Class = %d\n",class);
+
+ if(is_of_class(event,2)) printf("Class mathced!\n");
+ else {
+ printf("Error - bad class.\n");
+ return -1;
+ }
+
+ printf("Done. Cleaning...\n");
+
+ destroy_collection(event);
+
+ printf("Exit.\n");
+ TRACE_FLOW_NUMBER("add_collection_test. Returning",EOK);
+ return EOK;
+}
+
+
+int iterator_test()
+{
+ struct collection_item *peer;
+ struct collection_item *socket1;
+ struct collection_item *socket2;
+ struct collection_iterator *iterator = (struct collection_iterator *)(NULL);
+ int error = EOK;
+ struct collection_item *item = (struct collection_item *)(NULL);
+ char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
+ int depth = 0;
+
+ printf("\n\n==== ITERATOR TEST ====\n\n");
+
+ if((error=create_collection(&peer,"peer",0)) ||
+ (error=add_str_property(peer,NULL,"hostname","peerhost.mytest.com",0)) ||
+ (error=add_str_property(peer,NULL,"IPv4","10.10.10.10",12)) || /* Expect trailing zero to be truncated */
+ (error=add_str_property(peer,NULL,"IPv6","bla:bla:bla:bla:bla:bla",0))) {
+ printf("Failed to add property. Error %d",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ if((error=create_collection(&socket1,"socket",0)) ||
+ (error=add_int_property(socket1,NULL,"id",1)) ||
+ (error=add_long_property(socket1,NULL,"packets",100000000L)) ||
+ (error=add_binary_property(socket1,NULL,"stack",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket1);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ if((error=create_collection(&socket2,"socket",0)) ||
+ (error=add_int_property(socket2,NULL,"id",2)) ||
+ (error=add_long_property(socket2,NULL,"packets",200000000L)) ||
+ (error=add_binary_property(socket2,NULL,"queue",binary_dump,sizeof(binary_dump)))) {
+ destroy_collection(peer);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add property. Error %d\n",error);
+ return error;
+ }
+
+ error = add_collection_to_collection(peer,NULL,"first",socket1,COL_ADD_MODE_EMBED);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket1);
+ destroy_collection(socket2);
+ printf("Failed to add collection to collection. Error %d\n",error);
+ return error;
+ }
+
+ error = add_collection_to_collection(peer,NULL,"second",socket2,COL_ADD_MODE_EMBED);
+ if(error) {
+ destroy_collection(peer);
+ destroy_collection(socket2);
+ printf("Failed to add collection to collection. Error %d\n",error);
+ return error;
+ }
+
+ /* Bind iterator */
+ error = bind_iterator(&iterator,peer,COL_TRAVERSE_DEFAULT);
+ if(error) {
+ printf("Error (bind): %d\n",error);
+ destroy_collection(peer);
+ return error;
+ }
+
+ printf("\n\nCollection:\n\n");
+ debug_collection(peer,COL_TRAVERSE_DEFAULT);
+
+ /* This should also work becuase iterator holds to collection */
+ destroy_collection(peer);
+
+ printf("\n\nIteration:\n\n");
+
+ do {
+ depth = 0;
+ get_iterator_depth(iterator,&depth);
+
+ /* Loop through a collection */
+ error = iterate_collection(iterator, &item);
+ if(error) {
+ printf("Error (iterate): %d\n",error);
+ unbind_iterator(iterator);
+ return error;
+ }
+
+ /* Are we done ? */
+ if(item == (struct collection_item *)(NULL)) break;
+
+ printf("%*s Property (%s), type = %d, data size = %d\n",
+ depth * 4, "",
+ get_item_property(item,NULL),
+ get_item_type(item),
+ get_item_length(item));
+
+ if((strcmp(get_item_property(item,NULL),"id")==0) &&
+ (*((int *)(get_item_data(item))) == 1)) {
+ printf("\n\nFound property we need - go up!!!\n\n\n");
+ error = iterate_up(iterator,5);
+ if(!error) {
+ printf("We expected error but got seucces - bad.\n");
+ unbind_iterator(iterator);
+ return -1;
+ }
+ /* This should work! */
+ error = iterate_up(iterator,1);
+ if(error) {
+ printf("We expected success but got error %d\n",error);
+ unbind_iterator(iterator);
+ return error;
+ }
+
+ if((error = modify_str_item(item,"id2","test",0)) ||
+ (error = debug_item(item)) ||
+ (error = modify_str_item(item,NULL,"test",2)) ||
+ (error = debug_item(item)) ||
+ (error = modify_binary_item(item,NULL,binary_dump,sizeof(binary_dump))) ||
+ (error = debug_item(item)) ||
+ (error = modify_bool_item(item,NULL,1)) ||
+ (error = debug_item(item)) ||
+ (error = modify_int_item(item,"int",1)) ||
+ (error = debug_item(item)) ||
+ (error = modify_long_item(item,"long",1000000000L)) ||
+ (error = debug_item(item)) ||
+ (error = modify_ulong_item(item,"ulong",4000000000UL)) ||
+ (error = debug_item(item)) ||
+ (error = modify_unsigned_item(item,"unsigned",4000000000U)) ||
+ (error = debug_item(item)) ||
+ (error = modify_double_item(item,"double",-1.1)) ||
+ (error = debug_item(item))) {
+ printf("Failed to change property.\n");
+ return error;
+ }
+ }
+ }
+ while(1);
+
+ /* Do not forget to unbind iterator - otherwise there will be a leak */
+ unbind_iterator(iterator);
+ return EOK;
+}
+
+
+/* Main function of the unit test */
+
+int main()
+{
+ int error = 0;
+
+ printf("Start\n");
+ if((error=ref_collection_test()) ||
+ (error=single_collection_test()) ||
+ (error=add_collection_test()) ||
+ (error=mixed_collection_test()) ||
+ (error=iterator_test())) {
+ printf("Failed!\n");
+ }
+ else printf("Success!\n");
+ /* Add other tests here ... */
+ return error;
+}
+
diff --git a/common/configure.ac b/common/configure.ac
new file mode 100644
index 00000000..83a2c184
--- /dev/null
+++ b/common/configure.ac
@@ -0,0 +1,25 @@
+AC_INIT([elapi], [0.0], [dpal@redhat.com])
+AC_CONFIG_SRCDIR([collection/collection.c])
+AC_CONFIG_AUX_DIR([build])
+AM_INIT_AUTOMAKE([-Wall -Werror foreign])
+AC_PROG_CC
+AC_PROG_LIBTOOL
+AC_PROG_INSTALL
+
+AC_CONFIG_HEADERS([config.h])
+
+
+# Enable trace build
+AC_ARG_ENABLE([trace],
+ [AS_HELP_STRING([--enable-trace],[build with low level tracing enabled])],
+ [trace_level="$enableval"],
+ [trace_level="0"])
+AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])])
+
+
+AC_CONFIG_FILES([Makefile collection/Makefile])
+AC_OUTPUT
+
+
+
+
diff --git a/common/trace/trace.h b/common/trace/trace.h
new file mode 100644
index 00000000..58c97936
--- /dev/null
+++ b/common/trace/trace.h
@@ -0,0 +1,87 @@
+/*
+ COMMON TRACE
+
+ Common header file for tracing.
+
+ Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
+
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef COMMON_TRACE_H
+#define COMMON_TRACE_H
+
+#ifdef TRACE_LEVEL
+#define HAVE_TRACE
+#include <stdio.h>
+
+/* The trace level is a bit mask */
+#define TRACE_FLOW 0x0000001 /* - trace messages that are entry exit into functions */
+#define TRACE_ERROR 0x0000002 /* - trace messages that are errors */
+#define TRACE_INFO 0x0000004 /* - trace things that are informational */
+
+
+#ifdef TRACE_HOME /* Define this in the module that contains main */
+unsigned trace_level = TRACE_LEVEL;
+#else
+extern unsigned trace_level;
+#endif /* TRACE_HOME */
+#endif /* TRACE_LEVEL */
+
+
+
+#ifdef HAVE_TRACE
+/* Tracing strings */
+#define TRACE_STRING(level,message,str) if(level & trace_level) \
+ printf("[DEBUG] %23s (%4d) %s %s\n",__FILE__,__LINE__,message,str);
+/* Convenience wrappers for strings */
+#define TRACE_FLOW_STRING(message,str) TRACE_STRING(TRACE_FLOW,message,str)
+#define TRACE_ERROR_STRING(message,str) TRACE_STRING(TRACE_ERROR,message,str)
+#define TRACE_INFO_STRING(message,str) TRACE_STRING(TRACE_INFO,message,str)
+
+/* Tracing numbers */
+#define TRACE_NUMBER(level,message,number) if(level & trace_level) \
+ printf("[DEBUG] %23s (%4d) %s %lu\n",__FILE__,__LINE__,message,(unsigned long int)(number));
+/* Convenience wrappers for numbers */
+#define TRACE_FLOW_NUMBER(message,number) TRACE_NUMBER(TRACE_FLOW,message,number)
+#define TRACE_ERROR_NUMBER(message,number) TRACE_NUMBER(TRACE_ERROR,message,number)
+#define TRACE_INFO_NUMBER(message,number) TRACE_NUMBER(TRACE_INFO,message,number)
+
+/* Tracing doubles */
+#define TRACE_DOUBLE(level,message,number) if(level & trace_level) \
+ printf("[DEBUG] %23s (%4d) %s %e\n",__FILE__,__LINE__,message,(double)(number));
+/* Convenience wrappers for numbers */
+#define TRACE_FLOW_DOUBLE(message,number) TRACE_DOUBLE(TRACE_FLOW,message,number)
+#define TRACE_ERROR_DOUBLE(message,number) TRACE_DOUBLE(TRACE_ERROR,message,number)
+#define TRACE_INFO_DOUBLE(message,number) TRACE_DOUBLE(TRACE_INFO,message,number)
+
+/* Assertion */
+#define TRACE_ASSERT(expression) expression ? ; : printf("ASSERTION FAILED\n");
+#else
+/* Noop in case the tracing is disabled */
+#define TRACE_STRING(level,message,str) ;
+#define TRACE_NUMBER(level,message,number) ;
+#define TRACE_DOUBLE(level,message,number) ;
+#define TRACE_FLOW_STRING(message,str) ;
+#define TRACE_ERROR_STRING(message,str) ;
+#define TRACE_INFO_STRING(message,str) ;
+#define TRACE_FLOW_NUMBER(message,str) ;
+#define TRACE_ERROR_NUMBER(message,str) ;
+#define TRACE_INFO_NUMBER(message,str) ;
+#define TRACE_FLOW_DOUBLE(message,str) ;
+#define TRACE_ERROR_DOUBLE(message,str) ;
+#define TRACE_INFO_DOUBLE(message,str) ;
+#define TRACE_ASSERT(expression) ;
+#endif /* HAVE_TRACE */
+
+
+#endif /* COMMON_TRACE_H */