diff options
Diffstat (limited to 'src/fan')
-rw-r--r-- | src/fan/.gitignore | 3 | ||||
-rw-r--r-- | src/fan/LICENSE | 674 | ||||
-rw-r--r-- | src/fan/Linux_Fan.c | 536 | ||||
-rw-r--r-- | src/fan/Linux_Fan.h | 198 | ||||
-rw-r--r-- | src/fan/Makefile | 35 | ||||
-rw-r--r-- | src/fan/README | 42 | ||||
-rw-r--r-- | src/fan/cmpiLinux_Fan.c | 128 | ||||
-rw-r--r-- | src/fan/cmpiLinux_Fan.h | 40 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanAssociatedSensorProvider.c | 561 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanCommon.c | 252 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanCommon.h | 41 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanProvider.c | 498 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanSensor.c | 141 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanSensor.h | 40 | ||||
-rw-r--r-- | src/fan/cmpiLinux_FanSensorProvider.c | 327 | ||||
-rw-r--r-- | src/fan/mof/Linux_Fan.mof | 112 | ||||
-rw-r--r-- | src/fan/mof/Linux_Fan.reg | 18 |
17 files changed, 3646 insertions, 0 deletions
diff --git a/src/fan/.gitignore b/src/fan/.gitignore new file mode 100644 index 0000000..57828b5 --- /dev/null +++ b/src/fan/.gitignore @@ -0,0 +1,3 @@ +*.o +*.so + diff --git a/src/fan/LICENSE b/src/fan/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/src/fan/LICENSE @@ -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/src/fan/Linux_Fan.c b/src/fan/Linux_Fan.c new file mode 100644 index 0000000..738920b --- /dev/null +++ b/src/fan/Linux_Fan.c @@ -0,0 +1,536 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef _XOPEN_SOURCE + //this is for strdup + #define _XOPEN_SOURCE 500 +#endif +#include <stdlib.h> +#include <stdio.h> +#include <string.h> +#include <libgen.h> +#include <errno.h> +#include <stdbool.h> +#include <sensors/sensors.h> +#include <sensors/error.h> + +#include "Linux_Fan.h" + +#define MAX_CHIP_NAME_LENGTH 200 + +//* constants ***************************************************************** +static bool MODULE_INITIALIZED = false; + +static char const * const _fan_errors[] = { + "success", + "failed to get fan by identification supplied", + "given identification data is not enough to identify uniquely", + "no chip with given system path found", + "no fan with given name and chip found", + "unknown property", + "this property is not supported for setting", + "property is not writable", + "input/output error", + "initialization failed", + "unknown error occured" +}; + +//* static functions ********************************************************** +static cim_fan_error_t prop_type2sf_num( + cim_fan_prop_type_t pt, + int *sf_num) +{ + switch (pt) { + case CIM_FAN_MIN_SPEED: *sf_num = SENSORS_SUBFEATURE_FAN_MIN; break; + case CIM_FAN_MAX_SPEED: +#ifdef SENSORS_SUBFEATURE_FAN_MAX + *sf_num = SENSORS_SUBFEATURE_FAN_MAX; break; +#else + return CIM_FAN_NOT_SUPPORTED_PROP; +#endif + case CIM_FAN_DIV: *sf_num = SENSORS_SUBFEATURE_FAN_DIV; break; + case CIM_FAN_PULSES: *sf_num = SENSORS_SUBFEATURE_FAN_PULSES; break; + case CIM_FAN_BEEP: *sf_num = SENSORS_SUBFEATURE_FAN_BEEP; break; + default: return CIM_FAN_UNKNOWN_PROP; break; + } + return CIM_FAN_SUCCESS; +} + +static double prop_val2double( + cim_fan_prop_type_t pt, + cim_fan_prop_value_t const *val) { + switch (pt) { + case CIM_FAN_MIN_SPEED: return val->min_speed; + case CIM_FAN_MAX_SPEED: return val->max_speed; + case CIM_FAN_DIV: return val->divisor; + case CIM_FAN_PULSES: return val->pulses; + case CIM_FAN_BEEP: return val->beep; + } + return 0; +} + +static cim_fan_error_t libsensors2cim_fan_error(int err) { + if (!err) return CIM_FAN_SUCCESS; + if (err < 0) err = -err; + if (err < SENSORS_ERR_WILDCARDS || err > SENSORS_ERR_RECURSION) { + return CIM_FAN_OTHER_ERROR; + } + return (cim_fan_error_t) (0x100 + err); +} + +static const char * sprintf_chip_name(sensors_chip_name const *name) { + /** @return NULL on error, cstring otherwise */ + static char buf[MAX_CHIP_NAME_LENGTH]; + if (sensors_snprintf_chip_name(buf, MAX_CHIP_NAME_LENGTH, name) < 0) + return NULL; + return buf; +} + +static cim_fan_error_t reload_config_file(char const * fp) { + /** + * @param fp if NULL -> default configuration file will be loaded + * @return 0 on success */ + FILE *config_file = NULL; + int err; + + if (fp) { + if (!(config_file = fopen(fp, "r"))) { + fprintf(stderr, "Cound not open config file \"%s\": %s\n", + fp, strerror(errno)); + } + } + err = sensors_init(config_file); + if (err) { + fprintf(stderr, "sensors_init: %s\n", sensors_strerror(err)); + if (config_file) fclose(config_file); + }else { + if (config_file) fclose(config_file); + } + return libsensors2cim_fan_error(err); +} + +static double _get_value( sensors_chip_name const *chip + , sensors_subfeature const *sf) +{ + double val; + if (sensors_get_value(chip, sf->number, &val)) return 0.; + return val; +} + +static int _assign_sf_value( + sensors_chip_name const *chip, + sensors_feature const *feature, + int subfeature_type, + struct cim_fan *fdest) +{ + sensors_subfeature const *sf; + double val; + + sf = sensors_get_subfeature(chip, feature, subfeature_type); + val = sf ? _get_value(chip, sf):0.; + switch (subfeature_type) { + case SENSORS_SUBFEATURE_FAN_INPUT: fdest->speed = val; break; + case SENSORS_SUBFEATURE_FAN_MIN: fdest->min_speed = val; break; +#ifdef SENSORS_SUBFEATURE_FAN_MAX + case SENSORS_SUBFEATURE_FAN_MAX: fdest->max_speed = val; break; +#endif + case SENSORS_SUBFEATURE_FAN_DIV: fdest->divisor = val; break; + case SENSORS_SUBFEATURE_FAN_PULSES: fdest->pulses = val; break; + case SENSORS_SUBFEATURE_FAN_FAULT: fdest->fault = val != 0; break; + case SENSORS_SUBFEATURE_FAN_BEEP: fdest->beep = val != 0; break; + case SENSORS_SUBFEATURE_FAN_ALARM: fdest->alarm = val != 0; break; +#ifdef SENSORS_SUBFEATURE_ALARM_MIN + case SENSORS_SUBFEATURE_FAN_ALARM_MIN: + fdest->alarm_min = val != 0; + break; +#endif +#ifdef SENSORS_SUBFEATURE_FAN_ALARM_MAX + case SENSORS_SUBFEATURE_FAN_ALARM_MAX: + fdest->alarm_max = val != 0; + break; +#endif + default: return 1; + } + return !sf; +} + +static unsigned int _load_accessible_features( + sensors_chip_name const *chip, + sensors_feature const *feature) +{ + sensors_subfeature const *sf; + unsigned int res = 0; + unsigned int i = 1; + int sf_type; + + while(i <= CIM_FAN_AF_FEATURE_MAX) { + switch (i) { + case CIM_FAN_AF_MIN_SPEED: + sf_type = SENSORS_SUBFEATURE_FAN_MIN; break; +#ifdef SENSORS_SUBFEATURE_FAN_MAX + case CIM_FAN_AF_MAX_SPEED: + sf_type = SENSORS_SUBFEATURE_FAN_MAX; break; +#endif + case CIM_FAN_AF_DIV: + sf_type = SENSORS_SUBFEATURE_FAN_DIV; break; + case CIM_FAN_AF_PULSES: + sf_type = SENSORS_SUBFEATURE_FAN_PULSES; break; + case CIM_FAN_AF_FAULT: + sf_type = SENSORS_SUBFEATURE_FAN_FAULT; break; + case CIM_FAN_AF_BEEP: + sf_type = SENSORS_SUBFEATURE_FAN_BEEP; break; + case CIM_FAN_AF_ALARM: + sf_type = SENSORS_SUBFEATURE_FAN_ALARM; break; +#ifdef SENSORS_SUBFEATURE_FAN_ALARM_MIN + case CIM_FAN_AF_ALARM_MIN: + sf_type = SENSORS_SUBFEATURE_ALARM_MIN: break; +#endif +#ifdef SENSORS_SUBFEATURE_ALARM_MAX + case CIM_FAN_AF_ALARM_MAX: + sf_type = SENSORS_SUBFEATURE_ALARM_MAX; break; +#endif + default: + sf_type = -1; break; + } + if (sf_type != -1) { + sf = sensors_get_subfeature(chip, feature, sf_type); + res |= sf ? i : 0; + } + i = i << 1; + } + return res; +} + + +static struct cim_fan * _load_fan_data( sensors_chip_name const *chip + , sensors_feature const *feature) +{ + struct cim_fan *f; + char const *chip_name; + char * tmp; + int length; + int const sfs[] = { + SENSORS_SUBFEATURE_FAN_INPUT, + SENSORS_SUBFEATURE_FAN_MIN, +#ifdef SENSORS_SUBFEATURE_FAN_MAX + SENSORS_SUBFEATURE_FAN_MAX, +#endif + SENSORS_SUBFEATURE_FAN_DIV, + SENSORS_SUBFEATURE_FAN_PULSES, + SENSORS_SUBFEATURE_FAN_FAULT, + SENSORS_SUBFEATURE_FAN_BEEP, + SENSORS_SUBFEATURE_FAN_ALARM, +#ifdef SENSORS_SUBFEATURE_FAN_MIN_ALARM + SENSORS_SUBFEATURE_FAN_MIN_ALARM, +#endif +#ifdef SENSORS_SUBFEATURE_FAN_MAX_ALARM + SENSORS_SUBFEATURE_FAN_MAX_ALARM, +#endif + -1, // terminator + }; + + + if ((f = calloc(1, sizeof(struct cim_fan)))) { + if (!(chip_name = sprintf_chip_name(chip))) { + fprintf(stderr, "could not get chip name\n"); + goto lab_err_free_fan; + } + if (!(f->chip_name = strdup(chip_name))) { + perror("strdup"); + goto lab_err_free_fan; + } + f->sys_path = chip->path; + if (!(f->name = sensors_get_label(chip, feature))) { + fprintf(stderr, "could not get fan name for chip: %s\n", + f->chip_name); + goto lab_err_chip_name; + } + length = strlen(f->sys_path); + if (!(f->device_id = malloc((length + strlen(f->name) + 2) + * sizeof(char)))) { + perror("malloc"); + goto lab_err_fan_name; + } + tmp = strcpy((char*) f->device_id, f->sys_path); + tmp += length * sizeof(char); + if (f->sys_path[length - 1] != '/') { + //this will be almost certainly true + *(tmp++) = '/'; + } + strcpy(tmp, f->name); + + for (int const *sf_ptr=sfs; *sf_ptr != -1; ++sf_ptr) { + _assign_sf_value(chip, feature, *sf_ptr, f); + } + f->accessible_features = _load_accessible_features(chip, feature); + return f; + } +//lab_err_device_id: +// free((char*) f->device_id); +lab_err_fan_name: + free((char*) f->name); +lab_err_chip_name: + free((char*) f->chip_name); +lab_err_free_fan: + free(f); + return NULL; +} + +static cim_fan_error_t _find_fan( + char const *sys_path, + char const *fan_name, + sensors_chip_name const **chip, + sensors_feature const **feature) +{ + int chip_nr = 0, feature_nr = 0; + char * sp = (char*) sys_path; + char const *label; + int length; + cim_fan_error_t ret = CIM_FAN_OTHER_ERROR; + + if (!sys_path || !fan_name) goto lab_err_fan_data; + + length = strlen(sys_path); + if (length && sys_path[length - 1] == '/') { + if (!(sp = strdup(sys_path))) { + perror("strdup"); + goto lab_err_fan_data; + } + sp[length - 1] = '\0'; + } + + while ((*chip = sensors_get_detected_chips(NULL, &chip_nr))) { + if ((*chip)->path && !strcmp((*chip)->path, sys_path)) break; + } + if (!(*chip)) { + ret = CIM_FAN_NO_SUCH_CHIP; + goto lab_err_sys_path; + } + while ((*feature = sensors_get_features(*chip, &feature_nr))) { + if ((*feature)->type != SENSORS_FEATURE_FAN) continue; + if (!(label = sensors_get_label(*chip, *feature))) { + continue; + } + if (!strcmp(label, fan_name)) { + free((char*) label); + break; + } + free((char*) label); + } + if (!(*feature)) { + ret = CIM_FAN_NO_SUCH_FAN_NAME; + goto lab_err_sys_path; + } + return CIM_FAN_SUCCESS; + +lab_err_sys_path: + if (sp != sys_path) free(sp); +lab_err_fan_data: + return ret; +} + +static cim_fan_error_t _find_fan_by_id( + char const *device_id, + sensors_chip_name const **chip, + sensors_feature const **feature) +{ + char *sys_path; + char *fan_name; + char *tmp1, *tmp2; + cim_fan_error_t ret; + + if (!(tmp1 = strdup(device_id))) { + perror("strdup"); + return CIM_FAN_OTHER_ERROR; + } + if (!(tmp2 = strdup(device_id))) { + perror("strdup"); + free(tmp1); + return CIM_FAN_OTHER_ERROR; + } + sys_path = dirname(tmp1); + fan_name = basename(tmp2); + ret = _find_fan(sys_path, fan_name, chip, feature); + free(tmp1); + free(tmp2); + + return ret; +} + +static cim_fan_error_t _set_fan_prop( + sensors_chip_name const *chip, + cim_fan_prop_type_t prop_type, + cim_fan_prop_value_t const *prop) +{ + int sf_num; + cim_fan_error_t err; + double val; + + if (!(err = prop_type2sf_num(prop_type, &sf_num))) { + val = prop_val2double(prop_type, prop); + err = libsensors2cim_fan_error( + sensors_set_value(chip, sf_num, val)); + } + return err; +} + +//* module interface ********************************************************** +char const * cim_fan_strerror(cim_fan_error_t error) { + if ( ((int) error) > 0x100 + && ((int) error) <= 0x100 + SENSORS_ERR_RECURSION) { + return sensors_strerror(((int) error) - 0x100); + } + if ( ((int) error) < CIM_FAN_SUCCESS + || ((int) error) > CIM_FAN_OTHER_ERROR) { + return "unknown error code"; + } + return _fan_errors[(int) error]; +} + +cim_fan_error_t enum_all_fans(struct fanlist **lptr) { + struct fanlist * lptrhelp = NULL; + sensors_chip_name const *chip; + sensors_feature const *feature; + int chip_nr = 0, feature_nr; + + if (!(lptrhelp = calloc(1, sizeof(struct fanlist)))) { + perror("calloc"); + return CIM_FAN_OTHER_ERROR; + } + *lptr = lptrhelp; + while ((chip = sensors_get_detected_chips(NULL, &chip_nr))) { + feature_nr = 0; + while ((feature = sensors_get_features(chip, &feature_nr))) { + if (feature->type != SENSORS_FEATURE_FAN) continue; + if (lptrhelp->f) { + if (!(lptrhelp->next = calloc(1, sizeof(struct fanlist)))) { + free_fanlist(*lptr); + perror("calloc"); + return CIM_FAN_OTHER_ERROR; + } + lptrhelp = lptrhelp->next; + } + if (!(lptrhelp->f = _load_fan_data(chip, feature))) { + free_fanlist(*lptr); + return CIM_FAN_OTHER_ERROR; + } + } + } + if (!(*lptr)->f) { + free_fanlist(*lptr); + *lptr = NULL; + } + return CIM_FAN_SUCCESS; +} + +cim_fan_error_t get_fan_data_by_id( + char const *device_id, + struct cim_fan **sptr) +{ + sensors_chip_name const *chip; + sensors_feature const *feature; + cim_fan_error_t ret; + + if ((ret = _find_fan_by_id(device_id, &chip, &feature)) + == CIM_FAN_SUCCESS) { + if (!(*sptr = _load_fan_data(chip, feature))) { + ret = CIM_FAN_OTHER_ERROR; + } + } + return ret; +} + +cim_fan_error_t get_fan_data( + char const *sys_path, + char const *fan_name, + struct cim_fan **sptr) +{ + sensors_chip_name const *chip; + sensors_feature const *feature; + cim_fan_error_t ret; + + if ((ret = _find_fan(sys_path, fan_name, &chip, &feature)) + == CIM_FAN_SUCCESS) { + if (!(*sptr = _load_fan_data(chip, feature))) { + ret = CIM_FAN_OTHER_ERROR; + } + } + return ret; +} + +cim_fan_error_t set_fan_prop_by_id( + char const *device_id, + cim_fan_prop_type_t prop_type, + cim_fan_prop_value_t const *prop) +{ + sensors_chip_name const *chip; + sensors_feature const *feature; + cim_fan_error_t err; + + if (!(err = _find_fan_by_id(device_id, &chip, &feature))) + err = _set_fan_prop(chip, prop_type, prop); + return err; +} + +cim_fan_error_t set_fan_prop( + char const *sys_path, + char const *fan_name, + cim_fan_prop_type_t prop_type, + cim_fan_prop_value_t const *prop) +{ + sensors_chip_name const *chip; + sensors_feature const *feature; + cim_fan_error_t err; + + if (!(err = _find_fan(sys_path, fan_name, &chip, &feature))) + err = _set_fan_prop(chip, prop_type, prop); + return err; +} + +void free_fanlist(struct fanlist *lptr) { + struct fanlist *tmp; + while (lptr) { + tmp = lptr->next; + if (lptr->f) free_fan(lptr->f); + free(lptr); + lptr = tmp; + } +} + +void free_fan(struct cim_fan *fan) { + if (fan) { + if (fan->name) free((char*) fan->name); + if (fan->chip_name) free((char*) fan->chip_name); + if (fan->device_id) free((char*) fan->device_id); + free(fan); + } +} + +cim_fan_error_t init_linux_fan_module() { + if (!MODULE_INITIALIZED) { + if (reload_config_file(NULL)) return CIM_FAN_INIT_FAILED; + MODULE_INITIALIZED = true; + } + return CIM_FAN_SUCCESS; +} + +void cleanup_linux_fan_module() { + if (MODULE_INITIALIZED) { + sensors_cleanup(); + MODULE_INITIALIZED = false; + } +} + diff --git a/src/fan/Linux_Fan.h b/src/fan/Linux_Fan.h new file mode 100644 index 0000000..6eacd49 --- /dev/null +++ b/src/fan/Linux_Fan.h @@ -0,0 +1,198 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef LINUX_FAN_H_ +#define LINUX_FAN_H_ + +#include <stdbool.h> + +/** accessible features of fan + * each value represents a bit position in accessible_features vector in + * cim_fan struct + */ +#define CIM_FAN_AF_MIN_SPEED (1 << 0) +#define CIM_FAN_AF_MAX_SPEED (1 << 1) +#define CIM_FAN_AF_DIV (1 << 2) +#define CIM_FAN_AF_PULSES (1 << 3) +#define CIM_FAN_AF_FAULT (1 << 4) +#define CIM_FAN_AF_BEEP (1 << 5) +#define CIM_FAN_AF_ALARM (1 << 6) +#define CIM_FAN_AF_ALARM_MIN (1 << 7) +#define CIM_FAN_AF_ALARM_MAX (1 << 8) +#define CIM_FAN_AF_FEATURE_MAX (1 << 8) + +/** + * Descriptions of attributes are taken from: + * sysfs-interface documentation of hwmon + */ +struct cim_fan{ + char const * chip_name; + char const * sys_path; + char const * name; + /* is a composition of sys_path and name + * uniquely identifies fan + */ + char const * device_id; + + /* This is a bit vector with bit on position i meaning: + * CIM_FAN_AF_[i] = 1 <==> feature is available in fan's kernel interface + * (a file/channel is available under sys_path) + */ + unsigned int accessible_features; + + /* [RO] Fan input value. + * Unit: revolution/min (RPM) + */ + unsigned int speed; + + /* [RW] Fan minimum value + * Unit: revolution/min (RPM) + */ + unsigned int min_speed; + + /* [RW] Fan maximum value + * Unit: revolution/min (RPM) + * Only rarely supported by the hardware. + */ + unsigned int max_speed; + + /* [RW] Fan divisor. + * Integer value in powers of two (1, 2, 4, 8, 16, 32, 64, 128). + * Some chips only support values 1, 2, 4 and 8. + * Note that this is actually an internal clock divisor, which + * affects the measurable speed range, not the read value. + */ + unsigned int divisor; + + /* [RW] Number of tachometer pulses per fan revolution. + * Integer value, typically between 1 and 4. + * This value is a characteristic of the fan connected to the + * device's input, so it has to be set in accordance with the fan + * model. + * Should only be created if the chip has a register to configure + * the number of pulses. In the absence of such a register (and + * thus attribute) the value assumed by all devices is 2 pulses + * per fan revolution. + */ + unsigned int pulses; + + /* [RO] Each input channel may have an associated fault file. This can be + * used to notify open diodes, unconnected fans etc. where the hardware + * supports it. When this boolean has value 1, the measurement for that + * channel should not be trusted. + */ + bool fault; + + /* [RW] Channel beep + * false : disable + * true : enable + * Some chips also offer the possibility to get beeped when an alarm + * occurs. + */ + bool beep; + + /* [RO] Channel alarm + * false : no alarm + * true : alarm + * Each channel or limit may have an associated alarm file, containing a + * boolean value. 1 means that an alarm condition exists, 0 means no alarm. + * + * Usually a given chip will either use channel-related alarms, or + * limit-related alarms, not both. The driver should just reflect the + * hardware implementation. + */ + bool alarm; + bool alarm_min; + bool alarm_max; +}; + +struct fanlist{ + struct cim_fan * f; + struct fanlist * next; +}; + +typedef enum cim_fan_prop_type{ + CIM_FAN_MIN_SPEED = 1 << 0, + CIM_FAN_MAX_SPEED = 1 << 1, + CIM_FAN_DIV = 1 << 2, + CIM_FAN_PULSES = 1 << 3, + CIM_FAN_BEEP = 1 << 4, +}cim_fan_prop_type_t; + +typedef union cim_fan_prop_value{ + unsigned int min_speed; + unsigned int max_speed; + unsigned int divisor; + unsigned int pulses; + bool beep; +}cim_fan_prop_value_t; + +/** errors *******************************************************************/ +typedef enum cim_fan_error{ + CIM_FAN_SUCCESS = 0, + CIM_FAN_FAILED_TO_GET_FAN = 1, + CIM_FAN_MISSING_IDENTIFICATION = 2, + CIM_FAN_NO_SUCH_CHIP = 3, + CIM_FAN_NO_SUCH_FAN_NAME = 4, + CIM_FAN_UNKNOWN_PROP = 5, + CIM_FAN_NOT_SUPPORTED_PROP = 6, + CIM_FAN_NOT_WRITABLE_PROP = 7, + CIM_FAN_INIT_FAILED = 9, + CIM_FAN_OTHER_ERROR = 10, + + CIM_FAN_SEN_WILDCARDS = 0x101, + CIM_FAN_SEN_NO_ENTRY = 0x102, + CIM_FAN_SEN_ACCESS_R = 0x103, + CIM_FAN_SEN_KERNEL = 0x104, + CIM_FAN_SEN_DIV_ZERO = 0x105, + CIM_FAN_SEN_CHIP_NAME = 0x106, + CIM_FAN_SEN_BUS_NAME = 0x107, + CIM_FAN_SEN_PARSE = 0x108, + CIM_FAN_SEN_ACCESS_W = 0x109, + CIM_FAN_SEN_IO = 0x110, + CIM_FAN_SEN_RECURSION = 0x111, +}cim_fan_error_t; + +char const * cim_fan_strerror(cim_fan_error_t error); + +cim_fan_error_t enum_all_fans(struct fanlist ** lptr); + +cim_fan_error_t get_fan_data_by_id( + char const *device_id, + struct cim_fan **sptr); +cim_fan_error_t get_fan_data( + char const *sys_path, + char const *fan_name, + struct cim_fan **sptr); + +cim_fan_error_t set_fan_prop_by_id( + char const *device_id, + cim_fan_prop_type_t prop_type, + cim_fan_prop_value_t const *prop); +cim_fan_error_t set_fan_prop( + char const *sys_path, + char const *fan_name, + cim_fan_prop_type_t prop_type, + cim_fan_prop_value_t const *prop); + +void free_fanlist(struct fanlist *lptr); +void free_fan(struct cim_fan *sptr); + +cim_fan_error_t init_linux_fan_module(); +void cleanup_linux_fan_module(); + +#endif /* ----- LINUX_FAN_H_ ----- */ + diff --git a/src/fan/Makefile b/src/fan/Makefile new file mode 100644 index 0000000..35a91c7 --- /dev/null +++ b/src/fan/Makefile @@ -0,0 +1,35 @@ +CC=gcc +CFLAGS=-Wall -Wextra -std=c99 -g +LIBS=Linux_Fan Linux_FanSensor Linux_FanAssociatedSensor +LIBRARIES=$(foreach l,$(LIBS),cmpi$(l)Provider) +LIBRNS=$(foreach l,$(LIBRARIES),lib$(l).so) +DESTLIBDIR=$(shell [ `uname -m` = "x86_64" ] && echo /usr/lib64/cmpi || echo /usr/lib/cmpi) +LINKS=$(foreach l,$(LIBRNS),$(DESTLIBDIR)/$(l)) + +providers: $(LIBRNS) + +libcmpiLinux_FanAssociatedSensorProvider.so: \ + cmpiLinux_FanAssociatedSensorProvider.o + $(CC) -shared -Wl -o $@ $^ -lcmpiOSBase_Common + +libcmpi%Provider.so: cmpi%Provider.o cmpi%.o \ + cmpiLinux_FanCommon.o Linux_Fan.o + $(CC) -shared -Wl -o $@ $^ -lcmpiOSBase_Common -lsensors + +%.o: %.c + $(CC) $(CFLAGS) -I/usr/include/cmpi -c -fPIC -o $@ $^ + +clean: + -rm *.o *.so + +sfcb: $(LINKS) + sfcbstage -r mof/Linux_Fan.reg mof/Linux_Fan.mof + sfcbrepos -f + +$(DESTLIBDIR)/%.so: %.so + ln -sf `pwd`/$? $(DESTLIBDIR) + +install: $(LIBRNS) + cp $^ $(DESTLIBDIR) + sfcbstage -r mof/Linux_Fan.reg mof/Linux_Fan.mof + sfcbrepos -f diff --git a/src/fan/README b/src/fan/README new file mode 100644 index 0000000..bf226a5 --- /dev/null +++ b/src/fan/README @@ -0,0 +1,42 @@ +******************************************************************************* + * Description +******************************************************************************* +CIM Linux_Fan providers for sfcb. Specific for linux, because of usage of +lm_sensors library for hadware monitoring of fans. It uses CMPI, so +it should be usable under any broker supporting this interface. + +There are three providers provided according to CIM model: + * Linux_Fan + - Provides instance for every fan founded by lm_sensors with basic + information. + * Linux_FanSensor + - Associated sensor for each instance of Linux_Fan. + - Value of fan speed can be obtained from property CurrentReading. + * Linux_FanAssociatedSensor + - Provides association of instances of above 2 providers. + +******************************************************************************* + * Build Dependencies +******************************************************************************* + * lm_sensors - installed and configured + * lm_sensors-libs + * lm_sensors-devel + * sblim-cmpi-devel + * sblim-cmpi-base + * sblim-cmpi-base-devel (for library cmpiOSBase_Common) + +******************************************************************************* + *Â Build and installation (for sfcb) +******************************************************************************* +steps: + * make + *Â make install + +alternatively: + *Â make + * install *.so libraries to your cmpi libdir + * sfcbstage -r mof/Linux_Fan.reg mof/Linux_Fan.mof + * sfcbrepos -f + +and restart broker: + systemctl restart sfcb.service diff --git a/src/fan/cmpiLinux_Fan.c b/src/fan/cmpiLinux_Fan.c new file mode 100644 index 0000000..8088a70 --- /dev/null +++ b/src/fan/cmpiLinux_Fan.c @@ -0,0 +1,128 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef _XOPEN_SOURCE + //this is for strdup + #define _XOPEN_SOURCE 500 +#endif +#include <stdlib.h> +#include <string.h> +#include <stdbool.h> +#include <stdint.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +#include "cmpiLinux_Fan.h" + +static CMPIArray * _get_AccessibleFeatures( + CMPIBroker const *_broker, + CMPIStatus *rc, + struct cim_fan const *sptr) +{ + int index = 0; + uint16_t value = 1; + unsigned int i = 1; + + CMPIArray *res = CMNewArray(_broker, 8, CMPI_uint16, rc); + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 8, CMPI_uint16, rc)"); + _OSBASE_TRACE(2, ("--- _get_AccessibleFeatures failed: %s", + CMGetCharPtr(rc->msg))); + }else { + while (i <= CIM_FAN_AF_FEATURE_MAX) { + if (i & sptr->accessible_features) { + CMSetArrayElementAt(res, index++, (CMPIValue*)(&value), + CMPI_uint16); + } + ++value; + i = i << 1; + } + } + return res; +} + +CMPIObjectPath * _makePath_Fan( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc) +{ + return _makePath_FanCommon(_ClassName, _broker, ctx, cop, sptr, rc); +} + +CMPIInstance * _makeInst_Fan( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc) +{ + CMPIObjectPath *op; + CMPIInstance *ci; + CMPIValue val; + + _OSBASE_TRACE(2, ("--- _makeInst_Fan() called")); + if (!(ci = _makeInst_FanCommon(_ClassName, _broker, ctx, cop, properties, + sptr, rc, &op))) { + return NULL; + } + + // CoolingDevice + val.boolean = true; + CMSetProperty(ci, "ActiveCooling", &val, CMPI_boolean); + + // CIM_Fan + // Linux_Fan + val.array = _get_AccessibleFeatures(_broker, rc, sptr); + if (!rc->rc) { + CMSetProperty(ci, "AccessibleFeatures", &val, CMPI_uint16A); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_MIN_SPEED) { + val.uint64 = (uint64_t) sptr->min_speed; + CMSetProperty(ci, "MinSpeed", &val, CMPI_uint64); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_MAX_SPEED) { + val.uint64 = (uint64_t) sptr->max_speed; + CMSetProperty(ci, "MaxSpeed", &val, CMPI_uint64); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_DIV) { + CMSetProperty(ci, "Divisor", &sptr->divisor, CMPI_uint32); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_PULSES) { + CMSetProperty(ci, "Pulses", &sptr->pulses, CMPI_uint32); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_BEEP) { + val.boolean = sptr->beep; + CMSetProperty(ci, "Beep", &val, CMPI_boolean); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_ALARM) { + CMSetProperty(ci, "Alarm", &sptr->alarm, CMPI_boolean); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_ALARM_MIN) { + CMSetProperty(ci, "MinAlarm", &sptr->alarm_min, CMPI_boolean); + } + if (!rc->rc && sptr->accessible_features & CIM_FAN_AF_ALARM_MAX) { + CMSetProperty(ci, "MaxAlarm", &sptr->alarm_max, CMPI_boolean); + } + + _OSBASE_TRACE(2, ("--- _makeInst_Fan() exited")); + return ci; +} + diff --git a/src/fan/cmpiLinux_Fan.h b/src/fan/cmpiLinux_Fan.h new file mode 100644 index 0000000..5fc7227 --- /dev/null +++ b/src/fan/cmpiLinux_Fan.h @@ -0,0 +1,40 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef CMPILINUX_FAN_H_ +#define CMPILINUX_FAN_H_ + +#include "cmpiLinux_FanCommon.h" + +static char const *_ClassName = "Linux_Fan"; + +CMPIObjectPath * _makePath_Fan( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc); + +CMPIInstance * _makeInst_Fan( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc); + +#endif /* ----- CMPILINUX_FAN_H_ ----- */ + diff --git a/src/fan/cmpiLinux_FanAssociatedSensorProvider.c b/src/fan/cmpiLinux_FanAssociatedSensorProvider.c new file mode 100644 index 0000000..61e7dfb --- /dev/null +++ b/src/fan/cmpiLinux_FanAssociatedSensorProvider.c @@ -0,0 +1,561 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#include <stdio.h> +#include <string.h> +#include <stdint.h> +#include <limits.h> +#include <sys/types.h> +#include <sys/wait.h> +#include <unistd.h> +#include <strings.h> + +#include <cmpi/cmpidt.h> +#include <cmpi/cmpift.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +static char const * _ClassName = "Linux_FanAssociatedSensor"; +static char const * _RefLeft = "Antecedent"; +static char const * _RefRight = "Dependent"; +static char const * _RefLeftClass = "Linux_FanSensor"; +static char const * _RefRightClass = "Linux_Fan"; + +#define UNUSED(x) ((void) (x)) +static const CMPIBroker * _broker; +#ifdef CMPI_VER_100 + #define Linux_FanAssociatedSensorProviderSetInstance \ + Linux_FanAssociatedSensorProviderModifyInstance +#endif + +/* ---------------------------------------------------------------------------*/ +/* Instance Provider Interface */ +/* ---------------------------------------------------------------------------*/ + +CMPIStatus Linux_FanAssociatedSensorProviderCleanup( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + CMPIBoolean terminate) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(terminate); + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() called",_ClassName)); + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanAssociatedSensorProviderEnumInstanceNames( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref) +{ + UNUSED(mi); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstanceNames() called",_ClassName)); + + refrc = _assoc_create_inst_1toN( _broker,ctx,rslt,ref, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 1,0,&rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI EnumInstanceNames() failed",_ClassName)); + } + return rc; + } + + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI EnumInstanceNames() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderEnumInstances( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char ** properties) +{ + UNUSED(mi); UNUSED(properties); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstances() called",_ClassName)); + + refrc = _assoc_create_inst_1toN( _broker,ctx,rslt,ref, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 1,1,&rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI EnumInstances() failed",_ClassName)); + } + return rc; + } + + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI EnumInstances() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderGetInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char ** properties) +{ + UNUSED(mi); UNUSED(properties); + const CMPIInstance * ci = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI GetInstance() called",_ClassName)); + + ci = _assoc_get_inst( _broker,ctx,cop,_ClassName,_RefLeft,_RefRight,&rc); + + if( ci == NULL ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI GetInstance() failed",_ClassName)); + } + return rc; + } + + CMReturnInstance( rslt, ci ); + CMReturnDone(rslt); + _OSBASE_TRACE(1,("--- %s CMPI GetInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderCreateInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); UNUSED(ci); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI CreateInstance() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI CreateInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderSetInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci, + const char ** properties) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); UNUSED(ci); + UNUSED(properties); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI SetInstance() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI SetInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderDeleteInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanAssociatedSensorProviderExecQuery( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char * lang, + const char * query) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(ref); UNUSED(lang); + UNUSED(query); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() exited",_ClassName)); + return rc; +} + + +/* ---------------------------------------------------------------------------*/ +/* Associator Provider Interface */ +/* ---------------------------------------------------------------------------*/ + + +CMPIStatus Linux_FanAssociatedSensorProviderAssociationCleanup( + CMPIAssociationMI * mi, + const CMPIContext * ctx, + CMPIBoolean terminate) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(terminate); + _OSBASE_TRACE(1,("--- %s CMPI AssociationCleanup() called",_ClassName)); + _OSBASE_TRACE(1,("--- %s CMPI AssociationCleanup() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +/* + * The intention of associations is to show the relations between different + * classes and their instances. Therefore an association has two properties. + * Each one representing a reference to a certain instance of the specified + * class. We can say, that an association has a left and the right "end". + * + * Linux_RunningOS : + * < role > -> < class > + * Antecedent -> Linux_Fan + * Dependent -> Linux_FanSensor + * + */ + +/* + * general API information + * + * cop : + * Specifies the CMPIObjectPath to the CMPIInstance of the known end of + * the association. Its absolutelly necessary to define this anchor point, + * from where the evaluation of the association starts. + * assocPath : + * If not NULL, it contains the name of the association the caller is + * looking for. The provider should only return values, when the assocPath + * contains the name(s) of the association(s) he is responsible for ! + * role : + * The caller can specify that the source instance ( cop ) has to play + * a certain <role> in the association. The <role> is specified by the + * association definition (see above). That means, role has to contain + * the same value as the <role> the source instance plays in this assoc. + * If this requirement is not true, the provider returns nothing. + */ + +/* + * specification of associators() and associatorNames() + * + * These methods return CMPIInstance ( in the case of associators() ) or + * CMPIObjectPath ( in the case of associatorNames() ) object(s) of the + * opposite end of the association. + * + * resultRole : + * The caller can specify that the target instance(s) has/have to play + * a certain <role> in the association. The <role> is specified by the + * association definition (see above). That means, resultRole has to + * contain the same value as the <role> the target instance(s) plays + * in this assoc. If this requirement is not true, the provider returns + * nothing. + * resultClass : + * The caller can specify that the target instance(s) has/have to be + * instances of a certain <class>. The <class> is specified by the + * association definition (see above). That means, resultClass has to + * contain the same value as the <class> of the target instance(s). + * If this requirement is not true, the provider returns nothing. + */ + +CMPIStatus Linux_FanAssociatedSensorProviderAssociators( + CMPIAssociationMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char * assocClass, + const char * resultClass, + const char * role, + const char * resultRole, + const char ** propertyList) +{ + UNUSED(mi); UNUSED(propertyList); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + CMPIObjectPath * op = NULL; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI Associators() called",_ClassName)); + + if( assocClass ) { + op = CMNewObjectPath( _broker, CMGetCharPtr(CMGetNameSpace(cop,&rc)), + _ClassName, &rc ); + if( op==NULL ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed." ); + _OSBASE_TRACE(2, + ("--- %s CMPI Associators() failed : %s",CMGetCharPtr(rc.msg))); + return rc; + } + } + + if ( (assocClass == NULL) + || (CMClassPathIsA(_broker,op,assocClass,&rc) == 1)) + { + + if( _assoc_check_parameter_const( _broker,cop,_RefLeft,_RefRight, + _RefLeftClass,_RefRightClass, + resultClass,role,resultRole, + &rc ) == 0 ) { goto exit; } + + refrc = _assoc_create_refs_1toN(_broker, ctx, rslt, cop, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 1, 1, &rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI Associators() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI Associators() failed",_ClassName)); + } + return rc; + } + } + + exit: + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI Associators() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanAssociatedSensorProviderAssociatorNames( + CMPIAssociationMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char * assocClass, + const char * resultClass, + const char * role, + const char * resultRole) +{ + UNUSED(mi); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + CMPIObjectPath * op = NULL; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI AssociatorNames() called",_ClassName)); + + if( assocClass ) { + op = CMNewObjectPath( _broker, CMGetCharPtr(CMGetNameSpace(cop,&rc)), + _ClassName, &rc ); + if( op==NULL ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed." ); + _OSBASE_TRACE(2, ("--- %s CMPI AssociatorNames() failed : %s", + CMGetCharPtr(rc.msg))); + return rc; + } + } + + if( ( assocClass==NULL ) || ( CMClassPathIsA(_broker,op,assocClass,&rc) == 1 ) ) { + + if( _assoc_check_parameter_const( _broker,cop,_RefLeft,_RefRight, + _RefLeftClass,_RefRightClass, + resultClass,role,resultRole, + &rc ) == 0 ) { goto exit; } + + refrc = _assoc_create_refs_1toN(_broker, ctx, rslt, cop, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 0, 1, &rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI AssociatorNames() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI AssociatorNames() failed",_ClassName)); + } + return rc; + } + } + + exit: + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI AssociatorNames() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + + +/* + * specification of references() and referenceNames() + * + * These methods return CMPIInstance ( in the case of references() ) or + * CMPIObjectPath ( in the case of referenceNames() ) object(s) of th + * association itself. + */ + +CMPIStatus Linux_FanAssociatedSensorProviderReferences( + CMPIAssociationMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char * assocClass, + const char * role, + const char ** propertyList) +{ + UNUSED(mi); UNUSED(propertyList); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + CMPIObjectPath * op = NULL; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI References() called",_ClassName)); + + if( assocClass ) { + op = CMNewObjectPath( _broker, CMGetCharPtr(CMGetNameSpace(cop,&rc)), + _ClassName, &rc ); + if( op==NULL ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed." ); + _OSBASE_TRACE(2,("--- %s CMPI References() failed : %s",CMGetCharPtr(rc.msg))); + return rc; + } + } + + if( ( assocClass==NULL ) || ( CMClassPathIsA(_broker,op,assocClass,&rc) == 1 ) ) { + + if( _assoc_check_parameter_const( _broker,cop,_RefLeft,_RefRight, + _RefLeftClass,_RefRightClass, + NULL,role,NULL, + &rc ) == 0 ) { goto exit; } + + refrc = _assoc_create_refs_1toN(_broker, ctx, rslt, cop, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 1, 0, &rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI References() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI References() failed",_ClassName)); + } + return rc; + } + } + + exit: + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI References() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanAssociatedSensorProviderReferenceNames( + CMPIAssociationMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char * assocClass, + const char * role) +{ + UNUSED(mi); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + CMPIObjectPath * op = NULL; + int refrc = 0; + + _OSBASE_TRACE(1,("--- %s CMPI ReferenceNames() called",_ClassName)); + + if( assocClass ) { + op = CMNewObjectPath( _broker, CMGetCharPtr(CMGetNameSpace(cop,&rc)), + _ClassName, &rc ); + if( op==NULL ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed." ); + _OSBASE_TRACE(2,("--- %s CMPI ReferenceNames() failed : %s",CMGetCharPtr(rc.msg))); + return rc; + } + } + + if( ( assocClass==NULL ) || ( CMClassPathIsA(_broker,op,assocClass,&rc) == 1 ) ) { + + if( _assoc_check_parameter_const( _broker,cop,_RefLeft,_RefRight, + _RefLeftClass,_RefRightClass, + NULL,role,NULL, + &rc ) == 0 ) { goto exit; } + + refrc = _assoc_create_refs_1toN(_broker, ctx, rslt, cop, + _ClassName,_RefLeftClass,_RefRightClass, + _RefLeft,_RefRight, + 0, 0, &rc); + if( refrc != 0 ) { + if( rc.msg != NULL ) { + _OSBASE_TRACE(1,("--- %s CMPI ReferenceNames() failed : %s",_ClassName,CMGetCharPtr(rc.msg))); + } + else { + _OSBASE_TRACE(1,("--- %s CMPI ReferenceNames() failed",_ClassName)); + } + return rc; + } + } + + exit: + CMReturnDone( rslt ); + _OSBASE_TRACE(1,("--- %s CMPI ReferenceNames() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +/* ---------------------------------------------------------------------------*/ +/* Provider Factory */ +/* ---------------------------------------------------------------------------*/ +CMInstanceMIStub( Linux_FanAssociatedSensorProvider, + Linux_FanAssociatedSensorProvider, + _broker, + CMNoHook); + +CMAssociationMIStub( Linux_FanAssociatedSensorProvider, + Linux_FanAssociatedSensorProvider, + _broker, + CMNoHook); + +/* ---------------------------------------------------------------------------*/ +/* end of cmpiLinux_FanAssociatedSensorProvider */ +/* ---------------------------------------------------------------------------*/ + diff --git a/src/fan/cmpiLinux_FanCommon.c b/src/fan/cmpiLinux_FanCommon.c new file mode 100644 index 0000000..68aca46 --- /dev/null +++ b/src/fan/cmpiLinux_FanCommon.c @@ -0,0 +1,252 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#include <stdlib.h> +#include <string.h> +#include <stdbool.h> +#include <stdint.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +#include "cmpiLinux_FanCommon.h" + +#define UNUSED(x) ((void) (x)) + +static CMPIArray * _get_OperationalStatus( + CMPIBroker const *_broker, + CMPIStatus *rc, + struct cim_fan const *sptr) +{ + CMPIArray *res = CMNewArray(_broker, 2, CMPI_uint16, rc); + unsigned short val; + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 2, CMPI_uint16, rc)"); + _OSBASE_TRACE(2, ("--- _get_OperationalStatus failed: %s", + CMGetCharPtr(rc->msg))); + }else { + val = sptr->fault ? 3:1; // Error : OK + *rc = CMSetArrayElementAt(res, 0, (CMPIValue*)(&val), CMPI_uint16); + if (sptr->alarm || sptr->alarm_min || sptr->alarm_max) { + val = 4; // Stressed + *rc = CMSetArrayElementAt(res, 1, (CMPIValue*)(&val), CMPI_uint16); + } + } + return res; +} + +static CMPIArray * _get_StatusDescriptions( + CMPIBroker const *_broker, + CMPIStatus *rc, + struct cim_fan const *sptr) +{ + CMPIArray *res = CMNewArray(_broker, 2, CMPI_string, rc); + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 2, CMPI_string, rc)"); + _OSBASE_TRACE(2, ("--- _get_StatusDescriptions failed: %s", + CMGetCharPtr(rc->msg))); + }else { + *rc = CMSetArrayElementAt(res, 0, sptr->fault ? + "Chip indicates, that fan is in fault state." + " Possible causes are open diodes, unconnected fan etc." + " Thus the measurement for this channel should not be trusted." + : "Fan seems to be functioning correctly.", CMPI_chars); + if (!rc->rc && (sptr->alarm || sptr->alarm_min || sptr->alarm_max)) { + char buf[100]; + snprintf(buf, 100, "These alarm flags are set by the fan's chip:" + " alarm=%s, min_alarm=%s, max_alarm=%s", + sptr->alarm ? "1":"0", + sptr->alarm_min ? "1":"0", + sptr->alarm_max ? "1":"0"); + CMSetArrayElementAt(res, 1, buf, CMPI_chars); + } + } + return res; +} + +static CMPIArray * _get_OtherIdentifyingInfo( + CMPIBroker const *_broker, + CMPIStatus *rc, + struct cim_fan const *sptr) +{ + CMPIArray *res = CMNewArray(_broker, 2, CMPI_string, rc); + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 2, CMPI_string, rc)"); + _OSBASE_TRACE(2, ("--- _get_OtherIdentifyingInfo failed: %s", + CMGetCharPtr(rc->msg))); + }else { + CMSetArrayElementAt(res, 0, sptr->chip_name, CMPI_chars); + CMSetArrayElementAt(res, 1, sptr->sys_path, CMPI_chars); + } + return res; +} + +static CMPIArray * _get_IdentifyingDescriptions( + CMPIBroker const *_broker, + CMPIStatus *rc) +{ + CMPIArray *res = CMNewArray(_broker, 2, CMPI_string, rc); + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 2, CMPI_string, rc)"); + _OSBASE_TRACE(2, ("--- _get_IdentifyingDescriptions failed: %s", + CMGetCharPtr(rc->msg))); + }else { + CMSetArrayElementAt(res, 0, + "ChipName - name of fan's chip.", CMPI_chars); + CMSetArrayElementAt(res, 1, + "SysPath - system path of fan's chip.", CMPI_chars); + } + return res; +} + +CMPIObjectPath * _makePath_FanCommon( + char const *class_name, + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc) +{ + UNUSED(ctx); + + CMPIObjectPath * op = NULL; + + _OSBASE_TRACE(2,("--- _makePath_FanCommon() called")); + + op = CMNewObjectPath(_broker, CMGetCharPtr(CMGetNameSpace(cop, rc)), + class_name, rc); + if (CMIsNullObject(op)) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "Create CMPIObjectPath failed"); + _OSBASE_TRACE(2, ("--- _makePath_FanCommon() failed : %s", + CMGetCharPtr(rc->msg))); + }else { + CMAddKey(op, "CreationClassName", class_name, CMPI_chars); + CMAddKey(op, "SystemCreationClassName", CSCreationClassName, + CMPI_chars); + CMAddKey(op, "SystemName", get_system_name(), CMPI_chars); + CMAddKey(op, "DeviceID", sptr->device_id, CMPI_chars); + } + _OSBASE_TRACE(2, ("--- _makePath_FanCommon() exited")); + return op; +} + +CMPIInstance * _makeInst_FanCommon( + char const *class_name, + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc, + CMPIObjectPath **op) +{ + UNUSED(ctx); + + CMPIInstance *ci = NULL; + CMPIValue val; + uint16_t uint16; + char const *keys[] = { + "CreationClassName", + "SystemCreationClassName", + "SystemName", + "DeviceID", + NULL + }; + char buf[200]; + + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() called")); + + /* the sblim-cmpi-base package offers some tool methods to get common + * system data + */ + if( !get_system_name() ) { + CMSetStatusWithChars( _broker, rc, + CMPI_RC_ERR_FAILED, "no host name found" ); + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() failed : %s", + CMGetCharPtr(rc->msg))); + return NULL; + } + + if( !get_os_name() ) { + CMSetStatusWithChars( _broker, rc, + CMPI_RC_ERR_FAILED, "no OS name found" ); + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() failed : %s", + CMGetCharPtr(rc->msg))); + return NULL; + } + + *op = CMNewObjectPath(_broker, CMGetCharPtr(CMGetNameSpace(cop, rc)), + class_name, rc); + if (CMIsNullObject(*op)) { + CMSetStatusWithChars(_broker, rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed."); + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() failed : %s", + CMGetCharPtr(rc->msg))); + return NULL; + } + ci = CMNewInstance(_broker, *op, rc); + if (CMIsNullObject(ci)) { + CMSetStatusWithChars(_broker, rc, + CMPI_RC_ERR_FAILED, "Create CMPIObjectPath failed."); + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() failed : %s", + CMGetCharPtr(rc->msg))); + return NULL; + } + CMSetPropertyFilter(ci, properties, keys); + + //* keys ****************************************************************** + CMSetProperty(ci, "CreationClassName", class_name, CMPI_chars); + CMSetProperty(ci, "SystemCreationClassName", CSCreationClassName, + CMPI_chars); + CMSetProperty(ci, "SystemName", get_system_name(), CMPI_chars); + CMSetProperty(ci, "DeviceID", sptr->device_id, CMPI_chars); + + // other properties ******************************************************* + // ManagedElement + CMSetProperty(ci, "Caption", "Computer's fan", CMPI_chars); + CMSetProperty(ci, "Description", "Computer's fan.", CMPI_chars); + snprintf(buf, 200, "Fan \"%s\" on chip \"%s\"", sptr->name, + sptr->chip_name); + CMSetProperty(ci, "ElementName", buf, CMPI_chars); + + // ManagedSystemElement + CMSetProperty(ci, "Name", sptr->name, CMPI_chars); + val.array = _get_OperationalStatus(_broker, rc, sptr); + CMSetProperty(ci, "OperationalStatus", &val, CMPI_uint16A); + val.array = _get_StatusDescriptions(_broker, rc, sptr); + CMSetProperty(ci, "StatusDescriptions", &val, CMPI_stringA); + uint16 = sptr->fault ? 20:5; // Major failure : OK + CMSetProperty(ci, "HealthState", &uint16, CMPI_uint16); + uint16 = sptr->fault ? 5:16; // Stopped : In Service + CMSetProperty(ci, "OperatingStatus", &uint16, CMPI_uint16); + uint16 = sptr->fault ? 3:1; // Error : OK + CMSetProperty(ci, "PrimaryStatus", &uint16, CMPI_uint16); + + // EnabledLogicalElement + val.array = _get_OtherIdentifyingInfo(_broker, rc, sptr); + CMSetProperty(ci, "OtherIdentifyingInfo", &val, CMPI_stringA); + val.array = _get_IdentifyingDescriptions(_broker, rc); + CMSetProperty(ci, "IdentifyingDescriptions", &val, CMPI_stringA); + + _OSBASE_TRACE(2, ("--- _makeInst_FanCommon() exited")); + return ci; +} + diff --git a/src/fan/cmpiLinux_FanCommon.h b/src/fan/cmpiLinux_FanCommon.h new file mode 100644 index 0000000..8134b3b --- /dev/null +++ b/src/fan/cmpiLinux_FanCommon.h @@ -0,0 +1,41 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef CMPILINUX_FANCOMMON_H_ +#define CMPILINUX_FANCOMMON_H_ + +#include <cmpi/cmpidt.h> +#include "Linux_Fan.h" + +CMPIObjectPath * _makePath_FanCommon( + char const *class_name, + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc); + +CMPIInstance * _makeInst_FanCommon( + char const *class_name, + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc, + CMPIObjectPath **op); + +#endif /* ----- CMPILINUX_FANCOMMON_H_ ----- */ diff --git a/src/fan/cmpiLinux_FanProvider.c b/src/fan/cmpiLinux_FanProvider.c new file mode 100644 index 0000000..67a1a82 --- /dev/null +++ b/src/fan/cmpiLinux_FanProvider.c @@ -0,0 +1,498 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#include <stdlib.h> +#include <string.h> +#include <stdint.h> +#include <limits.h> +#include <sys/types.h> +#include <sys/wait.h> +#include <unistd.h> +#include <strings.h> +#include <errno.h> + +#include <cmpi/cmpidt.h> +#include <cmpi/cmpift.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +#include "cmpiLinux_Fan.h" + +#define UNUSED(x) ((void) (x)) +static const CMPIBroker * _broker; + +#ifdef CMPI_VER_100 + #define Linux_FanProviderSetInstance Linux_FanProviderModifyInstance +#endif + +// utilities ****************************************************************** +static bool data_2_uint64_t(CMPIData const * data, uint64_t *res) { + if (data->state != CMPI_goodValue) return false; + switch (data->type) { + case CMPI_string: + errno = 0; + *res = strtoull(CMGetCharPtr(data->value.string), NULL, 10); + if (errno) return false; + break; + case CMPI_sint32: *res = (uint64_t) data->value.sint32; break; + case CMPI_uint32: *res = (uint64_t) data->value.uint32; break; + case CMPI_sint64: *res = (uint64_t) data->value.sint64; break; + default: return false; + } + return true; +} + +/* ---------------------------------------------------------------------------*/ +/* Instance Provider Interface */ +/* ---------------------------------------------------------------------------*/ + + +CMPIStatus Linux_FanProviderCleanup( CMPIInstanceMI * mi, + const CMPIContext * ctx, CMPIBoolean terminate) { + UNUSED(mi); UNUSED(ctx); UNUSED(terminate); + + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() called",_ClassName)); + cleanup_linux_fan_module(); + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanProviderEnumInstanceNames( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref) { + UNUSED(mi); + + CMPIObjectPath * op = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct fanlist * lptr = NULL; + struct fanlist * rm = NULL; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstanceNames() called",_ClassName)); + + if (enum_all_fans(&lptr) != 0 ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Could not list get fan list." ); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + // iterate fan list + for (rm = lptr; lptr && rc.rc == CMPI_RC_OK ; lptr = lptr->next) { + // method call to create the CMPIInstance object + op = _makePath_Fan(_broker, ctx, ref, lptr->f, &rc); + if (op == NULL || rc.rc != CMPI_RC_OK) { + if (rc.msg != NULL) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed" + ": %s", _ClassName, CMGetCharPtr(rc.msg))); + } + CMSetStatusWithChars(_broker, &rc, CMPI_RC_ERR_FAILED, + "Transformation from internal structure to CIM" + " ObjectPath failed."); + if (rm) free_fanlist(rm); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed" + ": %s", _ClassName, CMGetCharPtr(rc.msg))); + return rc; + }else { + CMReturnObjectPath(rslt, op); + } + } + if (rm) free_fanlist(rm); + + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanProviderEnumInstances( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char ** properties) { + UNUSED(mi); + + CMPIInstance * ci = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct fanlist * lptr = NULL; + struct fanlist * rm = NULL; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstances() called",_ClassName)); + + if (enum_all_fans(&lptr)) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not list fans."); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + // iterate fan list + for (rm=lptr; lptr && rc.rc == CMPI_RC_OK; lptr = lptr->next) { + // method call to create the CMPIInstance object + ci = _makeInst_Fan(_broker, ctx, ref, properties, lptr->f, &rc); + if (ci == NULL || rc.rc != CMPI_RC_OK ) { + if (rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed :" + " %s",_ClassName,CMGetCharPtr(rc.msg))); + } + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Transformation from internal" + " structure to CIM Instance failed."); + if (rm) free_fanlist(rm); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed :" + " %s", _ClassName,CMGetCharPtr(rc.msg))); + return rc; + }else { + CMReturnInstance(rslt, ci); + } + } + if (rm) free_fanlist(rm); + + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanProviderGetInstance( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char **properties) { + UNUSED(mi); + + CMPIInstance * ci = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct cim_fan * sptr = NULL; + CMPIData data; + CMPIArray * other_identifying_info = NULL; + CMPIString * sys_path = NULL; + CMPIString * fan_name = NULL; + CMPIString * device_id = NULL; + cim_fan_error_t cmdrc; + + _OSBASE_TRACE(1,("--- %s CMPI GetInstance() called",_ClassName)); + + _check_system_key_value_pairs(_broker, cop, "SystemCreationClassName", + "SystemName", &rc); + if (rc.rc != CMPI_RC_OK) { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + return rc; + } + + data = CMGetKey(cop, "OtherIdentifyingInfo", &rc); + if ( !rc.rc + && data.type == CMPI_stringA + && (other_identifying_info = data.value.array) + && !rc.rc + && (CMGetArrayCount(other_identifying_info, &rc) > 1) + && !rc.rc) + { + data = CMGetArrayElementAt(other_identifying_info, 0, &rc); + if (!rc.rc) sys_path = data.value.string; + data = CMGetArrayElementAt(other_identifying_info, 1, &rc); + if (!rc.rc) fan_name = data.value.string; + } + device_id = CMGetKey(cop, "DeviceID", &rc).value.string; + if ((sys_path == NULL || fan_name == NULL) && (device_id == NULL)) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not get fan ID." ); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + return rc; + } + + if (sys_path && fan_name) { + cmdrc = get_fan_data(CMGetCharPtr(sys_path), CMGetCharPtr(fan_name), + &sptr); + } + if ((cmdrc || !sptr) && device_id) { + cmdrc = get_fan_data_by_id(CMGetCharPtr(device_id), &sptr); + } + if (cmdrc || !sptr) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_FOUND, cim_fan_strerror(cmdrc)); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() exited : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + ci = _makeInst_Fan(_broker, ctx, cop, properties, sptr, &rc); + if (sptr) free_fan(sptr); + + if (ci == NULL) { + if (rc.msg != NULL) { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + }else { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed", _ClassName)); + } + return rc; + } + + CMReturnInstance(rslt, ci); + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanProviderCreateInstance( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci) { + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); UNUSED(ci); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1, ("--- %s CMPI CreateInstance() called", _ClassName)); + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED"); + _OSBASE_TRACE(1, ("--- %s CMPI CreateInstance() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanProviderSetInstance( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci, + const char ** properties) { + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(properties); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + CMPIData data; + char const * device_id = NULL; + struct cim_fan * sptr; + cim_fan_prop_value_t cfpv; + cim_fan_error_t cmdrc; + char const * tmp = NULL; + char buf[200]; + + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() called", _ClassName)); + + _check_system_key_value_pairs(_broker, cop, "SystemCreationClassName", + "SystemName", &rc); + if (rc.rc != CMPI_RC_OK) { + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + return rc; + } + + data = CMGetKey(cop, "DeviceID", &rc); + if (data.value.string == NULL) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not get fan ID." ); + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + } + device_id = CMGetCharPtr(data.value.string); + if (device_id) { + cmdrc = get_fan_data_by_id(device_id, &sptr); + } + if (cmdrc || !sptr) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_FOUND, cim_fan_strerror(cmdrc)); + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() exited : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + data = CMGetProperty(ci, "MinSpeed", &rc); + if (!rc.rc && data.value.uint64 != (uint64_t) sptr->min_speed) { + tmp = "MinSpeed"; + cfpv.min_speed = data.value.uint64; + cmdrc = set_fan_prop_by_id(device_id, CIM_FAN_MIN_SPEED, &cfpv); + } + data = CMGetProperty(ci , "MaxSpeed", &rc); + if (!cmdrc && !rc.rc && data.value.uint64 != (uint64_t) sptr->max_speed) { + tmp = "MaxSpeed"; + cfpv.max_speed = data.value.uint64; + set_fan_prop_by_id(device_id, CIM_FAN_MAX_SPEED, &cfpv); + } + data = CMGetProperty(ci, "Divisor", &rc); + if (!cmdrc && !rc.rc && data.value.uint32 != sptr->divisor) { + tmp = "Divisor"; + cfpv.divisor = data.value.uint32; + set_fan_prop_by_id(device_id, CIM_FAN_DIV, &cfpv); + } + data = CMGetProperty(ci, "Pulses", &rc); + if (!cmdrc && !rc.rc && data.value.uint32 != sptr->pulses) { + tmp = "Pulses"; + cfpv.pulses = data.value.uint32; + set_fan_prop_by_id(device_id, CIM_FAN_PULSES, &cfpv); + } + data = CMGetProperty(ci, "Beep", &rc); + if (!cmdrc && !rc.rc && data.value.boolean != sptr->beep) { + tmp = "Beep"; + cfpv.beep = data.value.uint32; + set_fan_prop_by_id(device_id, CIM_FAN_BEEP, &cfpv); + } + + if (cmdrc) { + if (tmp && cmdrc == CIM_FAN_SEN_NO_ENTRY) { + snprintf(buf, 200, + "System interface for fan(name=\"%s\", chip=\"%s\") does not" + " provide a way to set \"%s\".", sptr->name, sptr->chip_name, + tmp); + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, buf); + }else { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, cim_fan_strerror(cmdrc)) + } + _OSBASE_TRACE(2, ("--- %s CMPI SetInstance() exited : %s", + _ClassName, CMGetCharPtr(rc.msg))); + }else { + rc.rc = CMPI_RC_OK; + rc.msg = NULL; + } + + return rc; +} + +CMPIStatus Linux_FanProviderDeleteInstance( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop) { + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() called",_ClassName)); + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanProviderExecQuery( CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char * lang, + const char * query) { + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(ref); UNUSED(lang); + UNUSED(query); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() exited",_ClassName)); + return rc; +} + + +/* ---------------------------------------------------------------------------*/ +/* Method Provider Interface */ +/* ---------------------------------------------------------------------------*/ + + +CMPIStatus Linux_FanProviderMethodCleanup( CMPIMethodMI * mi, + const CMPIContext * ctx, CMPIBoolean terminate) { + UNUSED(mi); UNUSED(ctx), UNUSED(terminate); + _OSBASE_TRACE(1,("--- %s CMPI MethodCleanup() called",_ClassName)); + _OSBASE_TRACE(1,("--- %s CMPI MethodCleanup() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanProviderInvokeMethod( CMPIMethodMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char * methodName, + const CMPIArgs * in, + CMPIArgs * out) { + UNUSED(mi); UNUSED(ctx); UNUSED(in); UNUSED(out); + + struct cim_fan * sptr = NULL; + CMPIString * device_id = NULL; + CMPIValue valrc; + CMPIData data; + CMPIString * class = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + uint64_t desired_speed; + + _OSBASE_TRACE(1, ("--- %s CMPI InvokeMethod() called", _ClassName)); + + class = CMGetClassName(ref, &rc); + + if ( strcasecmp(CMGetCharPtr(class), _ClassName) == 0 + && strcasecmp(methodName, "setspeed") == 0 ) { + if (!(device_id = CMGetKey(ref, "DeviceID", &rc).value.string)) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not get fan ID." ); + _OSBASE_TRACE(1, ("--- %s CMPI InvokeMethod() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + }else if (get_fan_data_by_id(CMGetCharPtr(device_id), &sptr) || !sptr) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_FOUND, "No such Fan found."); + _OSBASE_TRACE(1, ("--- %s CMPI InvokeMethod() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + }else { + char errbuf[100]; + char const * errdscr; + data = CMGetArg(in, "DesiredSpeed", &rc); + if (data.state != CMPI_goodValue) { + switch (data.state) { + case CMPI_nullValue: errdscr = "null value"; break; + case CMPI_badValue: errdscr = "bad value"; break; + case CMPI_notFound: errdscr = "not found"; break; + default: errdscr = "unknown error"; + } + snprintf(errbuf, 100, "Argument error: DesiredSpeed - %s", errdscr); + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, errbuf); + }else if (!data_2_uint64_t(&data, &desired_speed)) { + CMSetStatusWithChars(_broker, &rc, CMPI_RC_ERR_FAILED, + "Argument error: DesiredSpeed must be of type uint64"); + }else { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED"); + } + } + }else { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_METHOD_NOT_AVAILABLE, methodName); + } + + _OSBASE_TRACE(1, ("--- %s CMPI InvokeMethod() exited", _ClassName)); + return rc; +} + +/* ---------------------------------------------------------------------------*/ +/* Provider Factory */ +/* ---------------------------------------------------------------------------*/ + +CMInstanceMIStub( Linux_FanProvider, + Linux_FanProvider, + _broker, + init_linux_fan_module()); + +CMMethodMIStub( Linux_FanProvider, + Linux_FanProvider, + _broker, + init_linux_fan_module()); + +/* ---------------------------------------------------------------------------*/ +/* end of cmpiLinux_FanProvider */ +/* ---------------------------------------------------------------------------*/ + diff --git a/src/fan/cmpiLinux_FanSensor.c b/src/fan/cmpiLinux_FanSensor.c new file mode 100644 index 0000000..bbe8b22 --- /dev/null +++ b/src/fan/cmpiLinux_FanSensor.c @@ -0,0 +1,141 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#include <stdlib.h> +#include <string.h> +#include <stdbool.h> +#include <stdint.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +#include "cmpiLinux_FanSensor.h" + +static CMPIArray * _get_PossibleStates( + CMPIBroker const *_broker, + CMPIStatus *rc, + struct cim_fan const *sptr) +{ + int index = 0; + + CMPIArray *res = CMNewArray(_broker, 5, CMPI_string, rc); + if (!res) { + CMSetStatusWithChars(_broker, rc, CMPI_RC_ERR_FAILED, + "CMNewArray(_broker, 5, CMPI_string, rc)"); + _OSBASE_TRACE(2, ("--- _get_AccessibleFeatures failed: %s", + CMGetCharPtr(rc->msg))); + }else { + if (sptr->accessible_features & CIM_FAN_AF_MIN_SPEED) { + CMSetArrayElementAt(res, index++, "Below Minimum", CMPI_chars); + CMSetArrayElementAt(res, index++, "At Minumum", CMPI_chars); + } + CMSetArrayElementAt(res, index++, "Normal", CMPI_chars); + if (sptr->accessible_features & CIM_FAN_AF_MAX_SPEED) { + CMSetArrayElementAt(res, index++, "At Maximum", CMPI_chars); + CMSetArrayElementAt(res, index++, "Above Maximum", CMPI_chars); + } + } + return res; +} + +static char const * _get_CurrentState( + struct cim_fan const *sptr) +{ + if (sptr->accessible_features & CIM_FAN_AF_MIN_SPEED) { + if (sptr->speed < sptr->min_speed) return "Below Minimum"; + if (sptr->speed == sptr->min_speed) return "At Minimum"; + } + if (sptr->accessible_features & CIM_FAN_AF_MAX_SPEED) { + if (sptr->speed > sptr->max_speed) return "Above Maximum"; + if (sptr->speed == sptr->max_speed) return "At Maximum"; + } + return "Normal"; +} + + +CMPIObjectPath * _makePath_FanSensor( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc) +{ + return _makePath_FanCommon(_ClassName, _broker, ctx, cop, sptr, rc); +} + +CMPIInstance * _makeInst_FanSensor( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc) +{ + CMPIObjectPath *op; + CMPIInstance *ci; + CMPIValue val; + + char buf[200]; + + _OSBASE_TRACE(2, ("--- _makeInst_FanSensor() called")); + if (!(ci = _makeInst_FanCommon(_ClassName, _broker, ctx, cop, properties, + sptr, rc, &op))) { + return NULL; + } + + // ManagedElement + CMSetProperty(ci, "Caption", "Fan's tachometer", CMPI_chars); + CMSetProperty(ci, "Description", "Associated sensor of fan." + " Giving information about its speed.", CMPI_chars); + snprintf(buf, 200, "Tachometer of fan \"%s\" on chip \"%s\"", sptr->name, + sptr->chip_name); + CMSetProperty(ci, "ElementName", buf, CMPI_chars); + + // Sensor + val.uint16 = 5; // Tachometer + CMSetProperty(ci, "SensorType", &val, CMPI_uint16); + val.array = _get_PossibleStates(_broker, rc, sptr); + CMSetProperty(ci, "PossibleStates", &val, CMPI_stringA); + CMSetProperty(ci, "CurrentState", _get_CurrentState(sptr), CMPI_chars); + + // NumericSensor + val.uint16 = 38; // Revolutions + CMSetProperty(ci, "BaseUnits", &val, CMPI_uint16); + val.sint32 = 0; + CMSetProperty(ci, "UnitModifier", &val, CMPI_sint32); + val.uint16 = 4; // Per Minute + CMSetProperty(ci, "RateUnits", &val, CMPI_uint16); + val.sint32 = (int32_t) sptr->speed; + CMSetProperty(ci, "CurrentReading", &val, CMPI_sint32); + if (sptr->accessible_features & CIM_FAN_AF_MAX_SPEED) { + val.sint32 = (int32_t) sptr->min_speed; + CMSetProperty(ci, "NormalMax", &val, CMPI_sint32); + } + if (sptr->accessible_features & CIM_FAN_AF_MIN_SPEED) { + val.sint32 = (int32_t) sptr->min_speed; + CMSetProperty(ci, "NormalMin", &val, CMPI_sint32); + } + val.sint32 = 0; + CMSetProperty(ci, "MinReadable", &val, CMPI_sint32); + val.boolean = true; + CMSetProperty(ci, "IsLinear", &val, CMPI_boolean); + + // Linux_FanSensor + + _OSBASE_TRACE(2, ("--- _makeInst_FanSensor() exited")); + return ci; +} + diff --git a/src/fan/cmpiLinux_FanSensor.h b/src/fan/cmpiLinux_FanSensor.h new file mode 100644 index 0000000..3d224b5 --- /dev/null +++ b/src/fan/cmpiLinux_FanSensor.h @@ -0,0 +1,40 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#ifndef CMPILINUX_FANSENSOR_H_ +#define CMPILINUX_FANSENSOR_H_ + +#include "cmpiLinux_FanCommon.h" + +static char const *_ClassName = "Linux_FanSensor"; + +CMPIObjectPath * _makePath_FanSensor( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + struct cim_fan *sptr, + CMPIStatus *rc); + +CMPIInstance * _makeInst_FanSensor( + CMPIBroker const *_broker, + CMPIContext const *ctx, + CMPIObjectPath const *cop, + char const **properties, + struct cim_fan *sptr, + CMPIStatus *rc); + +#endif /* ----- CMPILINUX_FANSENSOR_H_ ----- */ + diff --git a/src/fan/cmpiLinux_FanSensorProvider.c b/src/fan/cmpiLinux_FanSensorProvider.c new file mode 100644 index 0000000..e3e1092 --- /dev/null +++ b/src/fan/cmpiLinux_FanSensorProvider.c @@ -0,0 +1,327 @@ +/* This file is part of cmpiLinux_FanProvider. + * + * cmpiLinux_FanProvider 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. + * + * cmpiLinux_FanProvider 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 cmpiLinux_FanProvider. If not, see + * <http://www.gnu.org/licenses/>. + */ +#include <stdlib.h> +#include <stdio.h> +#include <string.h> +#include <stdint.h> +#include <limits.h> +#include <sys/types.h> +#include <sys/wait.h> +#include <unistd.h> +#include <strings.h> + +#include <cmpi/cmpidt.h> +#include <cmpi/cmpift.h> +#include <cmpi/cmpimacs.h> +#include <sblim/OSBase_Common.h> +#include <sblim/cmpiOSBase_Common.h> + +#include "cmpiLinux_FanSensor.h" + +#define UNUSED(x) ((void) (x)) +static const CMPIBroker * _broker; + +#ifdef CMPI_VER_100 + #define Linux_FanSensorProviderSetInstance \ + Linux_FanSensorProviderModifyInstance +#endif + +/* ---------------------------------------------------------------------------*/ +/* Instance Provider Interface */ +/* ---------------------------------------------------------------------------*/ + +CMPIStatus Linux_FanSensorProviderCleanup( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + CMPIBoolean terminate) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(terminate); + + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() called",_ClassName)); + cleanup_linux_fan_module(); + _OSBASE_TRACE(1,("--- %s CMPI Cleanup() exited",_ClassName)); + CMReturn(CMPI_RC_OK); +} + +CMPIStatus Linux_FanSensorProviderEnumInstanceNames( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref) +{ + UNUSED(mi); + + CMPIObjectPath * op = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct fanlist * lptr = NULL; + struct fanlist * rm = NULL; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstanceNames() called",_ClassName)); + + if (enum_all_fans(&lptr) != 0 ) { + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Could not list get fan list." ); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + // iterate fan list + for (rm = lptr; lptr && rc.rc == CMPI_RC_OK ; lptr = lptr->next) { + // method call to create the CMPIInstance object + op = _makePath_FanSensor(_broker, ctx, ref, lptr->f, &rc); + if (op == NULL || rc.rc != CMPI_RC_OK) { + if (rc.msg != NULL) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed" + ": %s", _ClassName, CMGetCharPtr(rc.msg))); + } + CMSetStatusWithChars(_broker, &rc, CMPI_RC_ERR_FAILED, + "Transformation from internal structure to CIM" + " ObjectPath failed."); + if (rm) free_fanlist(rm); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() failed" + ": %s", _ClassName, CMGetCharPtr(rc.msg))); + return rc; + }else { + CMReturnObjectPath(rslt, op); + } + } + if (rm) free_fanlist(rm); + + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstanceNames() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderEnumInstances( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char ** properties) +{ + UNUSED(mi); + + CMPIInstance * ci = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct fanlist * lptr = NULL; + struct fanlist * rm = NULL; + + _OSBASE_TRACE(1,("--- %s CMPI EnumInstances() called",_ClassName)); + + if (enum_all_fans(&lptr)) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not list fans."); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + // iterate fan list + for (rm=lptr; lptr && rc.rc == CMPI_RC_OK; lptr = lptr->next) { + // method call to create the CMPIInstance object + ci = _makeInst_FanSensor(_broker, ctx, ref, properties, lptr->f, &rc); + if (ci == NULL || rc.rc != CMPI_RC_OK ) { + if (rc.msg != NULL ) { + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed :" + " %s",_ClassName,CMGetCharPtr(rc.msg))); + } + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_FAILED, "Transformation from internal" + " structure to CIM Instance failed."); + if (rm) free_fanlist(rm); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() failed :" + " %s", _ClassName,CMGetCharPtr(rc.msg))); + return rc; + }else { + CMReturnInstance(rslt, ci); + } + } + if (rm) free_fanlist(rm); + + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI EnumInstances() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderGetInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const char **properties) +{ + UNUSED(mi); + + CMPIInstance * ci = NULL; + CMPIStatus rc = {CMPI_RC_OK, NULL}; + struct cim_fan * sptr = NULL; + CMPIData data; + CMPIArray * other_identifying_info = NULL; + CMPIString * sys_path = NULL; + CMPIString * fan_name = NULL; + CMPIString * device_id = NULL; + cim_fan_error_t cmdrc; + + _OSBASE_TRACE(1,("--- %s CMPI GetInstance() called",_ClassName)); + + data = CMGetKey(cop, "OtherIdentifyingInfo", &rc); + if ( !rc.rc + && data.type == CMPI_stringA + && (other_identifying_info = data.value.array) + && !rc.rc + && (CMGetArrayCount(other_identifying_info, &rc) > 1) + && !rc.rc) + { + data = CMGetArrayElementAt(other_identifying_info, 0, &rc); + if (!rc.rc) sys_path = data.value.string; + data = CMGetArrayElementAt(other_identifying_info, 1, &rc); + if (!rc.rc) fan_name = data.value.string; + } + device_id = CMGetKey(cop, "DeviceID", &rc).value.string; + if ((sys_path == NULL || fan_name == NULL) && (device_id == NULL)) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_FAILED, "Could not get fan ID." ); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + return rc; + } + + if (sys_path && fan_name) { + cmdrc = get_fan_data(CMGetCharPtr(sys_path), CMGetCharPtr(fan_name), + &sptr); + } + if ((cmdrc || !sptr) && device_id) { + cmdrc = get_fan_data_by_id(CMGetCharPtr(device_id), &sptr); + } + if (cmdrc || !sptr) { + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_FOUND, cim_fan_strerror(cmdrc)); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() exited : %s", + _ClassName,CMGetCharPtr(rc.msg))); + return rc; + } + + ci = _makeInst_FanSensor(_broker, ctx, cop, properties, sptr, &rc); + if (sptr) free_fan(sptr); + + if (ci == NULL) { + if (rc.msg != NULL) { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed : %s", + _ClassName, CMGetCharPtr(rc.msg))); + }else { + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() failed", _ClassName)); + } + return rc; + } + + CMReturnInstance(rslt, ci); + CMReturnDone(rslt); + _OSBASE_TRACE(1, ("--- %s CMPI GetInstance() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderCreateInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); UNUSED(ci); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1, ("--- %s CMPI CreateInstance() called", _ClassName)); + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED"); + _OSBASE_TRACE(1, ("--- %s CMPI CreateInstance() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderSetInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop, + const CMPIInstance * ci, + const char ** properties) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); + UNUSED(ci); UNUSED(properties); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() called", _ClassName)); + CMSetStatusWithChars(_broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED"); + _OSBASE_TRACE(1, ("--- %s CMPI SetInstance() exited", _ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderDeleteInstance( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * cop) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(cop); + + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() called",_ClassName)); + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + _OSBASE_TRACE(1,("--- %s CMPI DeleteInstance() exited",_ClassName)); + return rc; +} + +CMPIStatus Linux_FanSensorProviderExecQuery( + CMPIInstanceMI * mi, + const CMPIContext * ctx, + const CMPIResult * rslt, + const CMPIObjectPath * ref, + const char * lang, + const char * query) +{ + UNUSED(mi); UNUSED(ctx); UNUSED(rslt); UNUSED(ref); UNUSED(lang); + UNUSED(query); + CMPIStatus rc = {CMPI_RC_OK, NULL}; + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() called",_ClassName)); + + CMSetStatusWithChars( _broker, &rc, + CMPI_RC_ERR_NOT_SUPPORTED, "CIM_ERR_NOT_SUPPORTED" ); + + _OSBASE_TRACE(1,("--- %s CMPI ExecQuery() exited",_ClassName)); + return rc; +} + + +/* ---------------------------------------------------------------------------*/ +/* Provider Factory */ +/* ---------------------------------------------------------------------------*/ + +CMInstanceMIStub( Linux_FanSensorProvider, + Linux_FanSensorProvider, + _broker, + init_linux_fan_module()); + +/* ---------------------------------------------------------------------------*/ +/* end of cmpiLinux_FanSensorProvider */ +/* ---------------------------------------------------------------------------*/ + diff --git a/src/fan/mof/Linux_Fan.mof b/src/fan/mof/Linux_Fan.mof new file mode 100644 index 0000000..02766e6 --- /dev/null +++ b/src/fan/mof/Linux_Fan.mof @@ -0,0 +1,112 @@ +// +// Linux_Fan.mof +// + +#pragma locale ("en_US") +//#pragma namespace ("root/cimv2") + +// =================================================================== +// Linux_Fan +// =================================================================== + +[ Provider("cmpi:cmpiLinux_FanProvider") ] +class Linux_Fan : CIM_Fan { + + [ Key, Override("DeviceID"), + Description("Uniquely identifies fan. It is a composition of + SysPath and Name glued with slash ('/').") ] + string DeviceId; + + [ Override("Name"), + Description("Name of fan provided by system.") ] + string Name; + + [ Description("Array of fan features, that are exposed through system + interface. In other words: those that are readible/writable."), + ValueMap { "1", "2", "3", "4", "5", "6", "7", "8" }, + Values { "MinSpeed", "MaxSpeed", "Divisor", "Pulses", "Beep", + "Alarm", "MinAlarm", "MaxAlarm" } + ] + uint16 AccessibleFeatures[]; + + [ Description("Minimum speed value."), + Write, + Units("Revolutions per Minute") ] + uint64 MinSpeed; + + [ Description("Maximum speed value."), + Write, + Units("Revolutions per Minute") ] + uint64 MaxSpeed; + + [ Description("Fan divisisor. It affects Minimum and Maximum speed value + and accuracy of readings. + The drivers account for the 'fan divisor' in their calculation + of RPM. So changing the fan divisor will NOT change the + nominal RPM reading, it will only affect the minimum and maximum + readings and the accuracy of the readings. + The actual formula is RPM = (60 * 22500) / (count * divisor)"), + Write ] + uint32 Divisor; + + [ Description("Number of tachometer pulses per fan revolution. + Integer value, typically between 1 and 4. + This value is a characteristic of the fan connected to the + device's input, so it has to be set in accordance with the fan + model."), + Write ] + uint32 Pulses; + + [ Description("This indicates, whether a PC's speaker should beep + when an alarm occurs."), + Write ] + boolean Beep; + + [ Description("ALARM warning indicating, that current speed is out of + range. This information is supplied by fan's chip driver.") ] + boolean Alarm; + + [ Description("ALARM warning indicating, that current speed is below + the critical level. This information is supplied by fan's chip driver.") + ] + boolean MinAlarm; + + [ Description("ALARM warning indicating, that current speed is above + the critical level. This information is supplied by fan's chip driver.") + ] + boolean MaxAlarm; + +}; + +// =================================================================== +// Linux_FanSensor +// =================================================================== +[ Provider("cmpi:cmpiLinux_FanSensorProvider") ] +class Linux_FanSensor : CIM_NumericSensor { + + [ Key, Override("DeviceID"), + Description("Uniquely identifies fan. It is a composition of + SysPath and Name glued with slash ('/').") ] + string DeviceId; + + [ Key, Override("Name"), + Description("Name of fan provided by system.") ] + string Name; + +}; + + +// =================================================================== +// Associations +// =================================================================== +[ Association, + Provider("cmpi:cmpiLinux_FanAssociatedSensorProvider") ] +class Linux_FanAssociatedSensor : CIM_AssociatedSensor { + + [ Override("Antecedent") ] + Linux_FanSensor REF Antecedent; + + [ Override("Dependent") ] + Linux_Fan REF Dependent; + +}; diff --git a/src/fan/mof/Linux_Fan.reg b/src/fan/mof/Linux_Fan.reg new file mode 100644 index 0000000..9d21edb --- /dev/null +++ b/src/fan/mof/Linux_Fan.reg @@ -0,0 +1,18 @@ +[Linux_Fan] + provider: Linux_FanProvider + location: cmpiLinux_FanProvider + type: instance method + namespace: root/cimv2 + +[Linux_FanSensor] + provider: Linux_FanSensorProvider + location: cmpiLinux_FanSensorProvider + type: instance + namespace: root/cimv2 + +[Linux_FanAssociatedSensor] + provider: Linux_FanAssociatedSensorProvider + location: cmpiLinux_FanAssociatedSensorProvider + type: instance association + namespace: root/cimv2 + |