* [PATCH v7 01/32] kernel-shark: Add license information
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 02/32] kernel-shark: Change the CMake minimum version required Yordan Karadzhov (VMware)
` (9 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
The GPL-2.0 and LGPL-2.1licenses are added to the LICENSES directory.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
LICENSES/GPL-2.0 | 359 +++++++++++++++++++++++++++++++++
LICENSES/LGPL-2.1 | 503 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 862 insertions(+)
create mode 100644 LICENSES/GPL-2.0
create mode 100644 LICENSES/LGPL-2.1
diff --git a/LICENSES/GPL-2.0 b/LICENSES/GPL-2.0
new file mode 100644
index 0000000..ff0812f
--- /dev/null
+++ b/LICENSES/GPL-2.0
@@ -0,0 +1,359 @@
+Valid-License-Identifier: GPL-2.0
+Valid-License-Identifier: GPL-2.0-only
+Valid-License-Identifier: GPL-2.0+
+Valid-License-Identifier: GPL-2.0-or-later
+SPDX-URL: https://spdx.org/licenses/GPL-2.0.html
+Usage-Guide:
+ To use this license in source code, put one of the following SPDX
+ tag/value pairs into a comment according to the placement
+ guidelines in the licensing rules documentation.
+ For 'GNU General Public License (GPL) version 2 only' use:
+ SPDX-License-Identifier: GPL-2.0
+ or
+ SPDX-License-Identifier: GPL-2.0-only
+ For 'GNU General Public License (GPL) version 2 or any later version' use:
+ SPDX-License-Identifier: GPL-2.0+
+ or
+ SPDX-License-Identifier: GPL-2.0-or-later
+License-Text:
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <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 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/LICENSES/LGPL-2.1 b/LICENSES/LGPL-2.1
new file mode 100644
index 0000000..27bb434
--- /dev/null
+++ b/LICENSES/LGPL-2.1
@@ -0,0 +1,503 @@
+Valid-License-Identifier: LGPL-2.1
+Valid-License-Identifier: LGPL-2.1+
+SPDX-URL: https://spdx.org/licenses/LGPL-2.1.html
+Usage-Guide:
+ To use this license in source code, put one of the following SPDX
+ tag/value pairs into a comment according to the placement
+ guidelines in the licensing rules documentation.
+ For 'GNU Lesser General Public License (LGPL) version 2.1 only' use:
+ SPDX-License-Identifier: LGPL-2.1
+ For 'GNU Lesser General Public License (LGPL) version 2.1 or any later
+ version' use:
+ SPDX-License-Identifier: LGPL-2.1+
+License-Text:
+
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 2.1, February 1999
+
+Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts as
+the successor of the GNU Library Public License, version 2, hence the
+version number 2.1.]
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to
+share and change it. By contrast, the GNU General Public Licenses are
+intended to guarantee your freedom to share and change free software--to
+make sure the software is free for all its users.
+
+This license, the Lesser General Public License, applies to some specially
+designated software packages--typically libraries--of the Free Software
+Foundation and other authors who decide to use it. You can use it too, but
+we suggest you first think carefully about whether this license or the
+ordinary General Public License is the better strategy to use in any
+particular case, based on the explanations below.
+
+When we speak of free software, we are referring to freedom of use, not
+price. Our General Public Licenses are designed to make sure that you have
+the freedom to distribute copies of free software (and charge for this
+service if you wish); that you receive source code or can get it if you
+want it; that you can change the software and use pieces of it in new free
+programs; and that you are informed that you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for you if
+you distribute copies of the library or if you modify it.
+
+For example, if you distribute copies of the library, whether gratis or for
+a fee, you must give the recipients all the rights that we gave you. You
+must make sure that they, too, receive or can get the source code. If you
+link other code with the library, you must provide complete object files to
+the recipients, so that they can relink them with the library after making
+changes to the library and recompiling it. And you must show them these
+terms so they know their rights.
+
+We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+To protect each distributor, we want to make it very clear that there is no
+warranty for the free library. Also, if the library is modified by someone
+else and passed on, the recipients should know that what they have is not
+the original version, so that the original author's reputation will not be
+affected by problems that might be introduced by others.
+
+Finally, software patents pose a constant threat to the existence of any
+free program. We wish to make sure that a company cannot effectively
+restrict the users of a free program by obtaining a restrictive license
+from a patent holder. Therefore, we insist that any patent license obtained
+for a version of the library must be consistent with the full freedom of
+use specified in this license.
+
+Most GNU software, including some libraries, is covered by the ordinary GNU
+General Public License. This license, the GNU Lesser General Public
+License, applies to certain designated libraries, and is quite different
+from the ordinary General Public License. We use this license for certain
+libraries in order to permit linking those libraries into non-free
+programs.
+
+When a program is linked with a library, whether statically or using a
+shared library, the combination of the two is legally speaking a combined
+work, a derivative of the original library. The ordinary General Public
+License therefore permits such linking only if the entire combination fits
+its criteria of freedom. The Lesser General Public License permits more lax
+criteria for linking other code with the library.
+
+We call this license the "Lesser" General Public License because it does
+Less to protect the user's freedom than the ordinary General Public
+License. It also provides other free software developers Less of an
+advantage over competing non-free programs. These disadvantages are the
+reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+For example, on rare occasions, there may be a special need to encourage
+the widest possible use of a certain library, so that it becomes a de-facto
+standard. To achieve this, non-free programs must be allowed to use the
+library. A more frequent case is that a free library does the same job as
+widely used non-free libraries. In this case, there is little to gain by
+limiting the free library to free software only, so we use the Lesser
+General Public License.
+
+In other cases, permission to use a particular library in non-free programs
+enables a greater number of people to use a large body of free
+software. For example, permission to use the GNU C Library in non-free
+programs enables many more people to use the whole GNU operating system, as
+well as its variant, the GNU/Linux operating system.
+
+Although the Lesser General Public License is Less protective of the users'
+freedom, it does ensure that the user of a program that is linked with the
+Library has the freedom and the wherewithal to run that program using a
+modified version of the Library.
+
+The precise terms and conditions for copying, distribution and modification
+follow. Pay close attention to the difference between a "work based on the
+library" and a "work that uses the library". The former contains code
+derived from the library, whereas the latter must be combined with the
+library in order to run.
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License Agreement applies to any software library or other program
+ which contains a notice placed by the copyright holder or other
+ authorized party saying it may be distributed under the terms of this
+ Lesser General Public License (also called "this License"). Each
+ licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+ prepared so as to be conveniently linked with application programs
+ (which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work which
+ has been distributed under these terms. A "work based on the Library"
+ means either the Library or any derivative work under copyright law:
+ that is to say, a work containing the Library or a portion of it, either
+ verbatim or with modifications and/or translated straightforwardly into
+ another language. (Hereinafter, translation is included without
+ limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for making
+ modifications to it. For a library, complete source code means all the
+ source code for all modules it contains, plus any associated interface
+ definition files, plus the scripts used to control compilation and
+ installation of the library.
+
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope. The act of running
+ a program using the Library is not restricted, and output from such a
+ program is covered only if its contents constitute a work based on the
+ Library (independent of the use of the Library in a tool for writing
+ it). Whether that is true depends on what the Library does and what the
+ program that uses the Library does.
+
+1. You may copy and distribute verbatim copies of the Library's complete
+ source code as you receive it, in any medium, provided that you
+ conspicuously and appropriately publish on each copy an appropriate
+ copyright notice and disclaimer of warranty; keep intact all the notices
+ that refer to this License and to the absence of any warranty; and
+ distribute a copy of this License along with the Library.
+
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Library or any portion of it,
+ thus forming a work based on the Library, and copy and distribute such
+ modifications or work under the terms of Section 1 above, provided that
+ you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices stating
+ that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no charge to
+ all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a table
+ of data to be supplied by an application program that uses the
+ facility, other than as an argument passed when the facility is
+ invoked, then you must make a good faith effort to ensure that, in
+ the event an application does not supply such function or table, the
+ facility still operates, and performs whatever part of its purpose
+ remains meaningful.
+
+ (For example, a function in a library to compute square roots has a
+ purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must be
+ optional: if the application does not supply it, the square root
+ function must still compute square roots.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Library, and
+ can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works. But when you
+ distribute the same sections as part of a whole which is a work based on
+ the Library, the distribution of the whole must be on the terms of this
+ License, whose permissions for other licensees extend to the entire
+ whole, and thus to each and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Library.
+
+ In addition, mere aggregation of another work not based on the Library
+ with the Library (or with a work based on the Library) on a volume of a
+ storage or distribution medium does not bring the other work under the
+ scope of this License.
+
+3. You may opt to apply the terms of the ordinary GNU General Public
+ License instead of this License to a given copy of the Library. To do
+ this, you must alter all the notices that refer to this License, so that
+ they refer to the ordinary GNU General Public License, version 2,
+ instead of to this License. (If a newer version than version 2 of the
+ ordinary GNU General Public License has appeared, then you can specify
+ that version instead if you wish.) Do not make any other change in these
+ notices.
+
+ Once this change is made in a given copy, it is irreversible for that
+ copy, so the ordinary GNU General Public License applies to all
+ subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of the
+ Library into a program that is not a library.
+
+4. You may copy and distribute the Library (or a portion or derivative of
+ it, under Section 2) in object code or executable form under the terms
+ of Sections 1 and 2 above provided that you accompany it with the
+ complete corresponding machine-readable source code, which must be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy from a
+ designated place, then offering equivalent access to copy the source
+ code from the same place satisfies the requirement to distribute the
+ source code, even though third parties are not compelled to copy the
+ source along with the object code.
+
+5. A program that contains no derivative of any portion of the Library, but
+ is designed to work with the Library by being compiled or linked with
+ it, is called a "work that uses the Library". Such a work, in isolation,
+ is not a derivative work of the Library, and therefore falls outside the
+ scope of this License.
+
+ However, linking a "work that uses the Library" with the Library creates
+ an executable that is a derivative of the Library (because it contains
+ portions of the Library), rather than a "work that uses the
+ library". The executable is therefore covered by this License. Section 6
+ states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+ that is part of the Library, the object code for the work may be a
+ derivative work of the Library even though the source code is
+ not. Whether this is true is especially significant if the work can be
+ linked without the Library, or if the work is itself a library. The
+ threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data structure
+ layouts and accessors, and small macros and small inline functions (ten
+ lines or less in length), then the use of the object file is
+ unrestricted, regardless of whether it is legally a derivative
+ work. (Executables containing this object code plus portions of the
+ Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+ distribute the object code for the work under the terms of Section
+ 6. Any executables containing that work also fall under Section 6,
+ whether or not they are linked directly with the Library itself.
+
+6. As an exception to the Sections above, you may also combine or link a
+ "work that uses the Library" with the Library to produce a work
+ containing portions of the Library, and distribute that work under terms
+ of your choice, provided that the terms permit modification of the work
+ for the customer's own use and reverse engineering for debugging such
+ modifications.
+
+ You must give prominent notice with each copy of the work that the
+ Library is used in it and that the Library and its use are covered by
+ this License. You must supply a copy of this License. If the work during
+ execution displays copyright notices, you must include the copyright
+ notice for the Library among them, as well as a reference directing the
+ user to the copy of this License. Also, you must do one of these things:
+
+ a) Accompany the work with the complete corresponding machine-readable
+ source code for the Library including whatever changes were used in
+ the work (which must be distributed under Sections 1 and 2 above);
+ and, if the work is an executable linked with the Library, with the
+ complete machine-readable "work that uses the Library", as object
+ code and/or source code, so that the user can modify the Library and
+ then relink to produce a modified executable containing the modified
+ Library. (It is understood that the user who changes the contents of
+ definitions files in the Library will not necessarily be able to
+ recompile the application to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a copy
+ of the library already present on the user's computer system, rather
+ than copying library functions into the executable, and (2) will
+ operate properly with a modified version of the library, if the user
+ installs one, as long as the modified version is interface-compatible
+ with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at least three
+ years, to give the same user the materials specified in Subsection
+ 6a, above, for a charge no more than the cost of performing this
+ distribution.
+
+ d) If distribution of the work is made by offering access to copy from a
+ designated place, offer equivalent access to copy the above specified
+ materials from the same place.
+
+ e) Verify that the user has already received a copy of these materials
+ or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the Library"
+ must include any data and utility programs needed for reproducing the
+ executable from it. However, as a special exception, the materials to be
+ distributed need not include anything that is normally distributed (in
+ either source or binary form) with the major components (compiler,
+ kernel, and so on) of the operating system on which the executable runs,
+ unless that component itself accompanies the executable.
+
+ It may happen that this requirement contradicts the license restrictions
+ of other proprietary libraries that do not normally accompany the
+ operating system. Such a contradiction means you cannot use both them
+ and the Library together in an executable that you distribute.
+
+7. You may place library facilities that are a work based on the Library
+ side-by-side in a single library together with other library facilities
+ not covered by this License, and distribute such a combined library,
+ provided that the separate distribution of the work based on the Library
+ and of the other library facilities is otherwise permitted, and provided
+ that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work based on
+ the Library, uncombined with any other library facilities. This must
+ be distributed under the terms of the Sections above.
+
+ b) Give prominent notice with the combined library of the fact that part
+ of it is a work based on the Library, and explaining where to find
+ the accompanying uncombined form of the same work.
+
+8. You may not copy, modify, sublicense, link with, or distribute the
+ Library except as expressly provided under this License. Any attempt
+ otherwise to copy, modify, sublicense, link with, or distribute the
+ Library is void, and will automatically terminate your rights under this
+ License. However, parties who have received copies, or rights, from you
+ under this License will not have their licenses terminated so long as
+ such parties remain in full compliance.
+
+9. You are not required to accept this License, since you have not signed
+ it. However, nothing else grants you permission to modify or distribute
+ the Library or its derivative works. These actions are prohibited by law
+ if you do not accept this License. Therefore, by modifying or
+ distributing the Library (or any work based on the Library), you
+ indicate your acceptance of this License to do so, and all its terms and
+ conditions for copying, distributing or modifying the Library or works
+ based on it.
+
+10. Each time you redistribute the Library (or any work based on the
+ Library), the recipient automatically receives a license from the
+ original licensor to copy, distribute, link with or modify the Library
+ subject to these terms and conditions. You may not impose any further
+ restrictions on the recipients' exercise of the rights granted
+ herein. You are not responsible for enforcing compliance by third
+ parties with this License.
+
+11. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ conditions are imposed on you (whether by court order, agreement or
+ otherwise) that contradict the conditions of this License, they do not
+ excuse you from the conditions of this License. If you cannot
+ distribute so as to satisfy simultaneously your obligations under this
+ License and any other pertinent obligations, then as a consequence you
+ may not distribute the Library at all. For example, if a patent license
+ would not permit royalty-free redistribution of the Library by all
+ those who receive copies directly or indirectly through you, then the
+ only way you could satisfy both it and this License would be to refrain
+ entirely from distribution of the Library.
+
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply, and the section as a whole is intended to apply in other
+ circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system which is implemented
+ by public license practices. Many people have made generous
+ contributions to the wide range of software distributed through that
+ system in reliance on consistent application of that system; it is up
+ to the author/donor to decide if he or she is willing to distribute
+ software through any other system and a licensee cannot impose that
+ choice.
+
+ This section is intended to make thoroughly clear what is believed to
+ be a consequence of the rest of this License.
+
+12. If the distribution and/or use of the Library is restricted in certain
+ countries either by patents or by copyrighted interfaces, the original
+ copyright holder who places the Library under this License may add an
+ explicit geographical distribution limitation excluding those
+ countries, so that distribution is permitted only in or among countries
+ not thus excluded. In such case, this License incorporates the
+ limitation as if written in the body of this License.
+
+13. The Free Software Foundation may publish revised and/or new versions of
+ the Lesser General Public License from time to time. Such new versions
+ will be similar in spirit to the present version, but may differ in
+ detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the Library
+ specifies a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and
+ conditions either of that version or of any later version published by
+ the Free Software Foundation. If the Library does not specify a license
+ version number, you may choose any version ever published by the Free
+ Software Foundation.
+
+14. If you wish to incorporate parts of the Library into other free
+ programs whose distribution conditions are incompatible with these,
+ write to the author to ask for permission. For software which is
+ copyrighted by the Free Software Foundation, write to the Free Software
+ Foundation; we sometimes make exceptions for this. Our decision will be
+ guided by the two goals of preserving the free status of all
+ derivatives of our free software and of promoting the sharing and reuse
+ of software generally.
+
+NO WARRANTY
+
+15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+ FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+ PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
+ EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
+ ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH
+ YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
+ NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+ REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
+ DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
+ DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY
+ (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
+ INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
+ THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR
+ OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Libraries
+
+If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+one line to give the library's name and an idea of what it does.
+Copyright (C) year name of author
+
+This library is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or (at
+your option) any later version.
+
+This library is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this library; if not, write to the Free Software Foundation,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add
+information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+Yoyodyne, Inc., hereby disclaims all copyright interest in
+the library `Frob' (a library for tweaking knobs) written
+by James Random Hacker.
+
+signature of Ty Coon, 1 April 1990
+Ty Coon, President of Vice
+That's all there is to it!
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 02/32] kernel-shark: Change the CMake minimum version required
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 01/32] kernel-shark: Add license information Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 03/32] kernel-shark: Use libtraceevent and libtracefs Yordan Karadzhov (VMware)
` (8 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware), David Runge
We use some CMake features that are available since version 3.1.2
Suggested-by: David Runge <dave@sleepmap.de>
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
CMakeLists.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index c95249e..e730398 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,5 +1,5 @@
# Check if cmake has the required version
-cmake_minimum_required(VERSION 2.8.11 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.1.2 FATAL_ERROR)
# Set the name and version of the project
project(kernel-shark)
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 03/32] kernel-shark: Use libtraceevent and libtracefs
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 01/32] kernel-shark: Add license information Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 02/32] kernel-shark: Change the CMake minimum version required Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 19:38 ` Steven Rostedt
2020-12-11 14:44 ` [PATCH v7 04/32] kernel-shark: Update README Yordan Karadzhov (VMware)
` (7 subsequent siblings)
10 siblings, 1 reply; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
libtraceevent and libtracefs are now stand-alone libraries, independent
form trace-cmd. Start building and linking KernelShark against those
independent libraries.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
CMakeLists.txt | 8 +++-
build/FindTraceCmd.cmake | 53 ++-------------------------
build/FindTraceEvent.cmake | 75 ++++++++++++++++++++++++++++++++++++++
build/FindTraceFS.cmake | 75 ++++++++++++++++++++++++++++++++++++++
src/CMakeLists.txt | 4 +-
src/libkshark.c | 10 ++---
6 files changed, 166 insertions(+), 59 deletions(-)
create mode 100644 build/FindTraceEvent.cmake
create mode 100644 build/FindTraceFS.cmake
diff --git a/CMakeLists.txt b/CMakeLists.txt
index e730398..007f46a 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -22,6 +22,11 @@ if (NOT _LIBDIR)
endif (NOT _LIBDIR)
include(${KS_DIR}/build/FindTraceCmd.cmake)
+
+set(CMAKE_MODULE_PATH "${KS_DIR}/build")
+find_package(TraceEvent REQUIRED)
+find_package(TraceFS REQUIRED)
+
include(${KS_DIR}/build/FindJSONC.cmake)
find_package(Doxygen)
@@ -80,8 +85,7 @@ endif (CMAKE_BUILD_TYPE MATCHES Package)
include_directories(${KS_DIR}/src/
${KS_DIR}/build/src/
${JSONC_INCLUDE_DIR}
- ${TRACECMD_INCLUDE_DIR}
- ${TRACEFS_INCLUDE_DIR})
+ ${TRACECMD_INCLUDE_DIR})
message("")
message(STATUS "C flags : " ${CMAKE_C_FLAGS})
diff --git a/build/FindTraceCmd.cmake b/build/FindTraceCmd.cmake
index 02f4529..5df2789 100644
--- a/build/FindTraceCmd.cmake
+++ b/build/FindTraceCmd.cmake
@@ -32,30 +32,15 @@ find_path(TRACECMD_INCLUDE_DIR NAMES trace-cmd/trace-cmd.h
PATHS $ENV{TRACE_CMD}/include/
NO_DEFAULT_PATH)
-find_path(TRACEFS_INCLUDE_DIR NAMES tracefs/tracefs.h
- PATHS $ENV{TRACE_CMD}/include/
- NO_DEFAULT_PATH)
-
find_library(TRACECMD_LIBRARY NAMES trace-cmd/libtracecmd.a
PATHS $ENV{TRACE_CMD}/lib/
NO_DEFAULT_PATH)
-find_library(TRACEFS_LIBRARY NAMES tracefs/libtracefs.a
- PATHS $ENV{TRACE_CMD}/lib/
- NO_DEFAULT_PATH)
-
-find_library(TRACEEVENT_LIBRARY NAMES traceevent/libtraceevent.a
- PATHS $ENV{TRACE_CMD}/lib/
- NO_DEFAULT_PATH)
-
# If not found, search in the default system paths. Note that if the previous
# search was successful "find_path" will do nothing this time.
-find_program(TRACECMD_EXECUTABLE NAMES trace-cmd)
-find_path(TRACECMD_INCLUDE_DIR NAMES trace-cmd/trace-cmd.h)
-find_path(TRACEFS_INCLUDE_DIR NAMES tracefs/tracefs.h)
-find_library(TRACECMD_LIBRARY NAMES trace-cmd/libtracecmd.so)
-find_library(TRACEFS_LIBRARY NAMES tracefs/libtracefs.so)
-find_library(TRACEEVENT_LIBRARY NAMES traceevent/libtraceevent.so)
+find_program(TRACECMD_EXECUTABLE NAMES trace-cmd)
+find_path(TRACECMD_INCLUDE_DIR NAMES trace-cmd/trace-cmd.h)
+find_library(TRACECMD_LIBRARY NAMES trace-cmd/libtracecmd.so)
IF (TRACECMD_INCLUDE_DIR AND TRACECMD_LIBRARY)
@@ -72,35 +57,3 @@ ELSE (TRACECMD_FOUND)
MESSAGE(FATAL_ERROR "\nCould not find trace-cmd!\n")
ENDIF (TRACECMD_FOUND)
-
-IF (TRACEFS_INCLUDE_DIR AND TRACEFS_LIBRARY)
-
- SET(TRACEFS_FOUND TRUE)
-
-ENDIF (TRACEFS_INCLUDE_DIR AND TRACEFS_LIBRARY)
-
-IF (TRACEFS_FOUND)
-
- MESSAGE(STATUS "Found tracefs: ${TRACEFS_LIBRARY}")
-
-ELSE (TRACEFS_FOUND)
-
- MESSAGE(FATAL_ERROR "\nCould not find tracefs!\n")
-
-ENDIF (TRACEFS_FOUND)
-
-IF (TRACEEVENT_LIBRARY)
-
- SET(TRACEEVENT_FOUND TRUE)
-
-ENDIF (TRACEEVENT_LIBRARY)
-
-IF (TRACEEVENT_FOUND)
-
- MESSAGE(STATUS "Found traceevent: ${TRACEEVENT_LIBRARY}")
-
-ELSE (TRACEEVENT_FOUND)
-
- MESSAGE(FATAL_ERROR "\nCould not find libtraceevent!\n")
-
-ENDIF (TRACEEVENT_FOUND)
diff --git a/build/FindTraceEvent.cmake b/build/FindTraceEvent.cmake
new file mode 100644
index 0000000..8525697
--- /dev/null
+++ b/build/FindTraceEvent.cmake
@@ -0,0 +1,75 @@
+
+#[=======================================================================[.rst:
+FindTraceevent
+-------
+
+Finds the traceevent library.
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module defines the :prop_tgt:`IMPORTED` targets:
+
+``trace::event``
+ Defined if the system has libtraceevent.
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+``TraceEvent_FOUND``
+ True if the system has the libtraceevent library.
+``TraceEvent_VERSION``
+ The version of the libtraceevent library which was found.
+``TraceEvent_INCLUDE_DIRS``
+ Include directories needed to use libtraceevent.
+``TraceEvent_LIBRARIES``
+ Libraries needed to link to libtraceevent.
+
+Cache Variables
+^^^^^^^^^^^^^^^
+
+``TraceEvent_INCLUDE_DIR``
+ The directory containing ``event-parse.h``.
+``TraceEvent_LIBRARY``
+ The path to the traceevent library.
+
+#]=======================================================================]
+
+find_package(PkgConfig QUIET)
+pkg_check_modules(PC_TraceEvent QUIET libtraceevent)
+
+set(TraceEvent_VERSION ${PC_TraceEvent_VERSION})
+set(TraceEvent_DEFINITIONS ${PC_TraceEvent_CFLAGS_OTHER})
+
+find_path(TraceEvent_INCLUDE_DIR NAMES traceevent/event-parse.h
+ HINTS ${PC_TraceEvent_INCLUDE_DIRS}
+ ${PC_TraceEvent_INCLUDEDIR})
+
+find_library(TraceEvent_LIBRARY NAMES traceevent libtraceevent
+ HINTS ${PC_TraceEvent_LIBDIR}
+ ${PC_TraceEventLIBRARY_DIRS})
+
+mark_as_advanced(TraceEvent_INCLUDE_DIR TraceEvent_LIBRARY)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(TraceEvent DEFAULT_MSG
+ TraceEvent_LIBRARY TraceEvent_INCLUDE_DIR)
+
+if(TraceEvent_FOUND)
+
+ set(TraceEvent_LIBRARIES ${TraceEvent_LIBRARY})
+ set(TraceEvent_INCLUDE_DIRS ${TraceEvent_INCLUDE_DIR})
+
+ if(NOT TARGET trace::event)
+ add_library(trace::event UNKNOWN IMPORTED)
+
+ set_target_properties(trace::event
+ PROPERTIES
+ INTERFACE_INCLUDE_DIRECTORIES "${TraceEvent_INCLUDE_DIRS}"
+ INTERFACE_COMPILE_DEFINITIONS "${TraceEvent_DEFINITIONS}"
+ IMPORTED_LINK_INTERFACE_LANGUAGES "C"
+ IMPORTED_LOCATION "${TraceEvent_LIBRARIES}")
+ endif()
+
+endif()
diff --git a/build/FindTraceFS.cmake b/build/FindTraceFS.cmake
new file mode 100644
index 0000000..982a61d
--- /dev/null
+++ b/build/FindTraceFS.cmake
@@ -0,0 +1,75 @@
+
+#[=======================================================================[.rst:
+FindTraceFS
+-------
+
+Finds the tracefs library.
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module defines the :prop_tgt:`IMPORTED` targets:
+
+``trace::fs``
+ Defined if the system has libtracefs.
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+``TraceFS_FOUND``
+ True if the system has the libtracefs library.
+``TraceFS_VERSION``
+ The version of the libtracefs library which was found.
+``TraceFS_INCLUDE_DIRS``
+ Include directories needed to use libtracefs.
+``TraceFS_LIBRARIES``
+ Libraries needed to link to libtracefs.
+
+Cache Variables
+^^^^^^^^^^^^^^^
+
+``TraceFS_INCLUDE_DIR``
+ The directory containing ``tracefs.h``.
+``TraceFS_LIBRARY``
+ The path to the tracefs library.
+
+#]=======================================================================]
+
+find_package(PkgConfig QUIET)
+pkg_check_modules(PC_TraceFS QUIET libtracefs)
+
+set(TraceFS_VERSION ${PC_TraceFS_VERSION})
+set(TraceFS_DEFINITIONS ${PC_TraceFS_CFLAGS_OTHER})
+
+find_path(TraceFS_INCLUDE_DIR NAMES tracefs/tracefs.h
+ HINTS ${PC_TraceFS_INCLUDE_DIRS}
+ ${PC_TraceFS_INCLUDEDIR})
+
+find_library(TraceFS_LIBRARY NAMES tracefs libtracefs
+ HINTS ${PC_TraceFS_LIBDIR}
+ ${PC_TraceFSLIBRARY_DIRS})
+
+mark_as_advanced(TraceFS_INCLUDE_DIR TraceFS_LIBRARY)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(TraceFS DEFAULT_MSG
+ TraceFS_LIBRARY TraceFS_INCLUDE_DIR)
+
+if(TraceFS_FOUND)
+
+ set(TraceFS_LIBRARIES ${TraceFS_LIBRARY})
+ set(TraceFS_INCLUDE_DIRS ${TraceFS_INCLUDE_DIR})
+
+ if(NOT TARGET trace::fs)
+ add_library(trace::fs UNKNOWN IMPORTED)
+
+ set_target_properties(trace::fs
+ PROPERTIES
+ INTERFACE_INCLUDE_DIRECTORIES "${TraceFS_INCLUDE_DIRS}"
+ INTERFACE_COMPILE_DEFINITIONS "${TraceFS_DEFINITIONS}"
+ IMPORTED_LINK_INTERFACE_LANGUAGES "C"
+ IMPORTED_LOCATION "${TraceFS_LIBRARIES}")
+ endif()
+
+endif()
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 457c100..7474e9d 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -8,8 +8,8 @@ add_library(kshark SHARED libkshark.c
libkshark-collection.c)
target_link_libraries(kshark ${TRACECMD_LIBRARY}
- ${TRACEFS_LIBRARY}
- ${TRACEEVENT_LIBRARY}
+ trace::fs
+ trace::event
${JSONC_LIBRARY}
${CMAKE_DL_LIBS})
diff --git a/src/libkshark.c b/src/libkshark.c
index 52aacd3..a14d3c5 100644
--- a/src/libkshark.c
+++ b/src/libkshark.c
@@ -141,7 +141,7 @@ bool kshark_open(struct kshark_context *kshark_ctx, const char *file)
kshark_free_task_list(kshark_ctx);
- handle = tracecmd_open(file);
+ handle = tracecmd_open_head(file);
if (!handle)
return false;
@@ -696,7 +696,7 @@ static ssize_t get_records(struct kshark_context *kshark_ctx,
int pid;
int cpu;
- n_cpus = tracecmd_cpus(kshark_ctx->handle);
+ n_cpus = tep_get_cpus(kshark_ctx->pevent);
cpu_list = calloc(n_cpus, sizeof(*cpu_list));
if (!cpu_list)
return -ENOMEM;
@@ -867,7 +867,7 @@ ssize_t kshark_load_data_entries(struct kshark_context *kshark_ctx,
if (total < 0)
goto fail;
- n_cpus = tracecmd_cpus(kshark_ctx->handle);
+ n_cpus = tep_get_cpus(kshark_ctx->pevent);
rows = calloc(total, sizeof(struct kshark_entry *));
if (!rows)
@@ -923,7 +923,7 @@ ssize_t kshark_load_data_records(struct kshark_context *kshark_ctx,
if (total < 0)
goto fail;
- n_cpus = tracecmd_cpus(kshark_ctx->handle);
+ n_cpus = tep_get_cpus(kshark_ctx->pevent);
rows = calloc(total, sizeof(struct tep_record *));
if (!rows)
@@ -1047,7 +1047,7 @@ size_t kshark_load_data_matrix(struct kshark_context *kshark_ctx,
if (total < 0)
goto fail;
- n_cpus = tracecmd_cpus(kshark_ctx->handle);
+ n_cpus = tep_get_cpus(kshark_ctx->pevent);
status = data_matrix_alloc(total, offset_array,
cpu_array,
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* Re: [PATCH v7 03/32] kernel-shark: Use libtraceevent and libtracefs
2020-12-11 14:44 ` [PATCH v7 03/32] kernel-shark: Use libtraceevent and libtracefs Yordan Karadzhov (VMware)
@ 2020-12-11 19:38 ` Steven Rostedt
0 siblings, 0 replies; 14+ messages in thread
From: Steven Rostedt @ 2020-12-11 19:38 UTC (permalink / raw)
To: Yordan Karadzhov (VMware); +Cc: linux-trace-devel
On Fri, 11 Dec 2020 16:44:42 +0200
"Yordan Karadzhov (VMware)" <y.karadz@gmail.com> wrote:
> libtraceevent and libtracefs are now stand-alone libraries, independent
> form trace-cmd. Start building and linking KernelShark against those
> independent libraries.
>
> Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
> ---
We need to do the same thing for libtracecmd, as it's going to be installed
in a different place as well, depending on pkg-config.
Thanks!
-- Steve
^ permalink raw reply [flat|nested] 14+ messages in thread
* [PATCH v7 04/32] kernel-shark: Update README
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (2 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 03/32] kernel-shark: Use libtraceevent and libtracefs Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 05/32] kernel-shark: Define build target for JSONC Yordan Karadzhov (VMware)
` (6 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
KernelShark is now separated from libtraceevent, libtracefs and
trace-cmd. The README file has to be updated to reflect this.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
README | 129 ++++++++++++++++++++++++++++++---------------------------
1 file changed, 67 insertions(+), 62 deletions(-)
diff --git a/README b/README
index 6c360bb..d7efd96 100644
--- a/README
+++ b/README
@@ -1,11 +1,13 @@
-This directory contains the new Qt-based version of the KernelShark GUI.
+KernelShark is a front-end reader of tracing data.
+The official repository is here:
+ https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git
Third Party Software:
------------------------------------------------------------
KernelShark has the following external dependencies:
- Cmake, Json-C, OpenGL/Glut, Qt5Base.
+ Cmake, Json-C, OpenGL/Glut, Qt5Base, libtraceevent, libtracefs, trace-cmd.
1. In order to install the packages on Ubuntu do the following:
sudo apt-get install build-essential git cmake libjson-c-dev -y
@@ -25,88 +27,91 @@ KernelShark has the following external dependencies:
dnf install graphviz doxygen -y
-Building:
-------------------------------------------------------------
-1. Follow the instructions given in trace-cmd/README and build
-the original trace-cmd end traceevent libraries.
-
-2. Building KernelShark:
-
-2.1 There is a simple and expert way to build KernelShark
+3. In order to install the final dependencies do the following:
+ git clone https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
+ cd libtraceevent
+ make
+ sudo make install
-2.1.1 Option 1 (simple) : build KernelShark as part of trace-cmd
+ git clone https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+ cd libtracefs
+ make
+ sudo make install
- (from the toplevel git tree)
+ git clone https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
+ cd trace-cmd
+ make
+ sudo make install_libs
- make gui
+Building:
+------------------------------------------------------------
+2. Building KernelShark:
- This will build the necessary parts of trace-cmd needed
- by KernelShark.
+ cd kernel-shark/build
+ cmake ../
+ make
+ sudo make install
-2.1.1.1 By default, the installation prefix is "/usr/local". It can be
-changed by passing in "prefix" to the build.
+2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
+as a CMake Command-Line option.
- make prefix=/usr gui
+2.2 KernelShark has multiple build types. By default, the build type is
+RelWithDebInfo, which will build a release candidate with debug information.
+To change the type, pass in the option CMAKE_BUILD_TYPE=<type>.
-2.1.1.2 Use "make clean" if you want to delete all already compiled objects.
-This will also clean up all the files created by cmake.
+ cmake -DCMAKE_BUILD_TYPE=Debug - for "-g" option
+ cmake -DCMAKE_BUILD_TYPE=Release - for "-O3" option
+ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo - for "-g -O2" option (default)
+ cmake -DCMAKE_BUILD_TYPE=MinSizeRel - for "-Os" option
-2.1.1.3 KernelShark has multiple build types (See section 2.1.2.3 for more
-details. By default, the build type is RelWithDebInfo, which will build
-a release candidate with debug information. To change the type, pass in
-the option BUILD_TYPE=<type> to the make process.
+2.3 In addition to the standard CMake build types (Debug, Release,
+RelWithDebInfo, MinSizeRel) KernelShark supports a "Package" build type.
+By default this build type adds the "-O3" compiler flag. Package maintainers
+can chose their own compiler flags by providing the corresponding
+CMAKE_XXXX_FLAGS_PACKAGE Command-Line options (see the example below).
- make BUILD_TYPE=Debug gui - for "-g" option
- make BUILD_TYPE=Release gui - for "-O3" option
- make BUILD_TYPE=RelWithDebInfo gui - for "-g -O2" option (default)
- make BUILD_TYPE=MinSizeRel gui - for "-Os" option
+-- Note that when built as a "Package" the RPATH-s of the executables are
+set directly to _INSTALL_PREFIX/lib/kernelshark/
-2.1.2 Option 2 (expert) : standalone build of KernelShark (for hackers only)
+2.4 After building the code "kernel-shark/lib" will contain all libraries
+and "kernel-shark/bin" will contain all executables.
- (note, you may need to do a normal make from the toplevel git
- tree before performing the following)
+2.5 Use the script "cmake_clean.sh" if you want to delete all already
+compiled objects and all files generated by CMake.
- make
- cd kernel-shark/build
- cmake ../
- make
+ cd kernel-shark/build
+ ./cmake-clean.sh
- This gives you a bit more control as you may easily pass in
- your own cmake options.
+2.6 By default, installation prefix is "/usr/local". It can be changed using
+-D_INSTALL_PREFIX= as a CMake Command-Line option.
-2.1.2.1 In order to create a Doxygen documentation add -D_DOXYGEN_DOC=1
-as a CMake Command-Line option.
+2.7 In order to uninstall KernelShark do:
+ cd kernel-shark/build
+ ./cmake_uninstall.sh
-2.1.2.2 By default, installation prefix is "/usr/local". It can be changed using
--D_INSTALL_PREFIX= as a CMake Command-Line option.
-2.1.2.3 In addition to the standard CMake build types (Debug, Release,
-RelWithDebInfo, MinSizeRel) KernelShark supports a "Package" build type.
-By default this build type adds the "-O2" compiler flag. Package maintainers
-can chose their own compiler flags by providing the corresponding
-CMAKE_XXXX_FLAGS_PACKAGE Command-Line options (see the example below).
+CMake examples:
--- Note that when built as a "Package" the RPATH-s of the executables are
-set directly to _INSTALL_PREFIX/lib/kernelshark/
+ cmake -D_DOXYGEN_DOC=1 -D_INSTALL_PREFIX=/usr ../
--- Note that when built as a "Debug" the "Record" dialog will try to use the
-version of the trace-cmd executable from the build location. In all other cases
-the dialog will derive the absolut path to the trace-cmd executable from
-"_INSTALL_PREFIX", hence the dialog will use the installed version.
+ cmake -DCMAKE_BUILD_TYPE=Package -DCMAKE_C_FLAGS_PACKAGE="-O3 -pedantic" ../
-If no build types is specified, the type will be "RelWithDebInfo".
-Examples:
+Contributions:
+------------------------------------------------------------
+3. For questions about the use of the library, please send email to:
+ linux-trace-users@vger.kernel.org
- cmake -D_DOXYGEN_DOC=1 -D_INSTALL_PREFIX=/usr ../
+ Subscribe: http://vger.kernel.org/vger-lists.html#linux-trace-users
+ Archives: https://lore.kernel.org/linux-trace-users/
- cmake -DCMAKE_BUILD_TYPE=Package -DCMAKE_C_FLAGS_PACKAGE="-O3 -pedantic" ../
+3.1 For contributions to development, please send patches to:
+ linux-trace-devel@vger.kernel.org
-2.1.2.4 Use the script "cmake_clean.sh" if you want to delete all already
-compiled objects and all files generated by CMake.
+ Subscribe: http://vger.kernel.org/vger-lists.html#linux-trace-devel
+ Archives: https://lore.kernel.org/linux-trace-devel/
- cd kernel-shark/build
- ./cmake-clean.sh
+3.2 Note, this project follows the style of submitting patches as described
+by the Linux kernel.
-3. After building the code "kernel-shark/lib" will contain all libraries
-and "kernel-shark/bin" will contain all executables.
+ https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 05/32] kernel-shark: Define build target for JSONC
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (3 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 04/32] kernel-shark: Update README Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 06/32] kernel-shark: Use only signed types in kshark_entry Yordan Karadzhov (VMware)
` (5 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
Having the JSONC libs as a target simplifies the build/linking of
the KernelShark libraries and executables because all necessary
information, like include paths, compiler flags and library names
can be retriever directly from the target.
The patch also adds to FindJSONC.cmake the standard module
documentation header.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
CMakeLists.txt | 4 +--
build/FindJSONC.cmake | 70 +++++++++++++++++++++++++++++++++----------
src/CMakeLists.txt | 2 +-
3 files changed, 57 insertions(+), 19 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 007f46a..a66050f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -26,8 +26,7 @@ include(${KS_DIR}/build/FindTraceCmd.cmake)
set(CMAKE_MODULE_PATH "${KS_DIR}/build")
find_package(TraceEvent REQUIRED)
find_package(TraceFS REQUIRED)
-
-include(${KS_DIR}/build/FindJSONC.cmake)
+find_package(JSONC REQUIRED)
find_package(Doxygen)
@@ -84,7 +83,6 @@ endif (CMAKE_BUILD_TYPE MATCHES Package)
include_directories(${KS_DIR}/src/
${KS_DIR}/build/src/
- ${JSONC_INCLUDE_DIR}
${TRACECMD_INCLUDE_DIR})
message("")
diff --git a/build/FindJSONC.cmake b/build/FindJSONC.cmake
index 3bae20f..2d0d41f 100644
--- a/build/FindJSONC.cmake
+++ b/build/FindJSONC.cmake
@@ -1,13 +1,44 @@
-# - Try to find json-c
-# https://cmake.org/Wiki/CMake:How_To_Find_Libraries
-# Once done this will define
-# JSONC_FOUND - System has json-c
-# JSONC_INCLUDE_DIRS - The json-c include directories
-# JSONC_LIBRARIES - The libraries needed to use json-c
-# JSONC_DEFINITIONS - Compiler switches required for using json-c
-
-find_package(PkgConfig)
+
+#[=======================================================================[.rst:
+FindJSONC
+-------
+
+Finds the traceevent library.
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module defines the :prop_tgt:`IMPORTED` targets:
+
+``jsonc::jsonc``
+ Defined if the system has json-c.
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+``JSONC_FOUND``
+ True if the system has the json-c library.
+``JSONC_VERSION``
+ The version of the json-c library which was found.
+``JSONC_INCLUDE_DIRS``
+ Include directories needed to use json-c.
+``JSONC_LIBRARIES``
+ Libraries needed to link to json-c.
+
+Cache Variables
+^^^^^^^^^^^^^^^
+
+``JSONC_INCLUDE_DIR``
+ The directory containing ``json.h``.
+``JSONC_LIBRARY``
+ The path to the traceevent library.
+
+#]=======================================================================]
+
+find_package(PkgConfig QUIET)
pkg_check_modules(PC_JSONC QUIET json-c)
+
+set(JSONC_VERSION ${PC_JSONC_VERSION})
set(JSONC_DEFINITIONS ${PC_JSONC_CFLAGS_OTHER})
find_path(JSONC_INCLUDE_DIR json.h
@@ -20,19 +51,28 @@ find_library(JSONC_LIBRARY NAMES json-c libjson-c
find_library(JSONC_LIBRARY NAMES json-c libjson-c
HINTS ${PC_JSON-C_LIBDIR} ${PC_JSON-C_LIBRARY_DIRS})
+mark_as_advanced(JSONC_INCLUDE_DIR JSONC_LIBRARY)
+
include(FindPackageHandleStandardArgs)
# handle the QUIETLY and REQUIRED arguments and set JSONC_FOUND to TRUE
# if all listed variables are TRUE
find_package_handle_standard_args(JSONC DEFAULT_MSG
JSONC_LIBRARY JSONC_INCLUDE_DIR)
-if (NOT JSONC_FOUND)
+if(JSONC_FOUND)
- message(FATAL_ERROR "Json-C is Required!\n")
+ set(JSONC_LIBRARIES ${JSONC_LIBRARY})
+ set(JSONC_INCLUDE_DIRS ${JSONC_INCLUDE_DIR})
-endif (NOT JSONC_FOUND)
+ if(NOT TARGET jsonc::jsonc)
+ add_library(jsonc::jsonc UNKNOWN IMPORTED)
-mark_as_advanced(JSONC_INCLUDE_DIR JSONC_LIBRARY)
+ set_target_properties(jsonc::jsonc
+ PROPERTIES
+ INTERFACE_INCLUDE_DIRECTORIES "${JSONC_INCLUDE_DIRS}"
+ INTERFACE_COMPILE_DEFINITIONS "${JSONC_DEFINITIONS}"
+ IMPORTED_LINK_INTERFACE_LANGUAGES "C"
+ IMPORTED_LOCATION "${JSONC_LIBRARIES}")
+ endif()
-set(JSONC_LIBRARIES ${JSONC_LIBRARY})
-set(JSONC_INCLUDE_DIRS ${JSONC_INCLUDE_DIR})
+endif()
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 7474e9d..213ce87 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -10,7 +10,7 @@ add_library(kshark SHARED libkshark.c
target_link_libraries(kshark ${TRACECMD_LIBRARY}
trace::fs
trace::event
- ${JSONC_LIBRARY}
+ jsonc::jsonc
${CMAKE_DL_LIBS})
set_target_properties(kshark PROPERTIES SUFFIX ".so.${KS_VERSION_STRING}")
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 06/32] kernel-shark: Use only signed types in kshark_entry
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (4 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 05/32] kernel-shark: Define build target for JSONC Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 07/32] kernel-shark: Add stream_id to kshark_entry Yordan Karadzhov (VMware)
` (4 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
Using uint64_t for the value of the offset was just wrong. According
to the POSIX standard off_t is a signed integer type with unspecified
size. Here we stick to a 64 bit integer, because this size guaranties
optimal packing of the kshark_entry structure.
Using unsigned values for the timestamps is also a source of problems
and has been a reason for the introduction of multiple bugs in the past.
In principal the value of the timestamps cannot be negative. However,
this value must have the same type as the values used to define the
state of the visualization model, like the range of the model or the
size of the bin. The model state definitions should not take negative
values as well, however their values are recalculated automatically when
the user browses the data and those calculations may result in negative
values in some corner cases. Because of this it is better to use a
signed integer type and treat the negative values as an indicator
of an error rather than have the negative result of the calculations
casted into unsigned type which results into unpredictable behavior of
the model.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/libkshark.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/libkshark.h b/src/libkshark.h
index 0d6c50d..9eecc2d 100644
--- a/src/libkshark.h
+++ b/src/libkshark.h
@@ -61,7 +61,7 @@ struct kshark_entry {
int32_t event_id;
/** The offset into the trace file, used to find the record. */
- uint64_t offset;
+ int64_t offset;
/**
* The time of the record in nano seconds. The value is taken from
@@ -69,7 +69,7 @@ struct kshark_entry {
* dependent. The time usually is the timestamp from when the system
* started.
*/
- uint64_t ts;
+ int64_t ts;
};
/** Size of the task's hash table. */
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 07/32] kernel-shark: Add stream_id to kshark_entry
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (5 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 06/32] kernel-shark: Use only signed types in kshark_entry Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 08/32] kernel-shark: Introduce libkshark-hash Yordan Karadzhov (VMware)
` (3 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
kshark_entry contains all information from one trace record, needed
in order to visualize the time-series of trace records. Here we
reorganize the data fields of kshark_entry in order to make room for
the unique identifier of the Data stream this entry belongs to.
The Id is coded in 16 bits that are taken from the "event_id" field.
So far "event_id" uses 32 bits but we found that it is coded with only
16 bits inside the kernel, so we still have 16 unused (spare) bits in
it.
Because the stream Id is coded with int8_t, we need to set an upper
limit (127) for the total number of Data streams loaded.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/libkshark.h | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/src/libkshark.h b/src/libkshark.h
index 9eecc2d..7d8b53b 100644
--- a/src/libkshark.h
+++ b/src/libkshark.h
@@ -1,7 +1,7 @@
/* SPDX-License-Identifier: LGPL-2.1 */
/*
- * Copyright (C) 2017 VMware Inc, Yordan Karadzhov <y.karadz@gmail.com>
+ * Copyright (C) 2017 VMware Inc, Yordan Karadzhov (VMware) <y.karadz@gmail.com>
*/
/**
@@ -51,15 +51,18 @@ struct kshark_entry {
*/
uint16_t visible;
+ /** Data stream identifier. */
+ int16_t stream_id;
+
+ /** Unique Id of the trace event type. */
+ int16_t event_id;
+
/** The CPU core of the record. */
int16_t cpu;
/** The PID of the task the record was generated. */
int32_t pid;
- /** Unique Id ot the trace event type. */
- int32_t event_id;
-
/** The offset into the trace file, used to find the record. */
int64_t offset;
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 08/32] kernel-shark: Introduce libkshark-hash
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (6 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 07/32] kernel-shark: Add stream_id to kshark_entry Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 09/32] kernel-shark: Introduce Data streams Yordan Karadzhov (VMware)
` (2 subsequent siblings)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
So far KernelShark have been using an implementation of a hash table
from trace-cmd/include/trace-cmd/trace-filter-hash.h. However it turns
that KernelShark is the only user of trace-filter-hash, which means
that it make more sense to make this implementation of the hash table
part of KernelShark. In this patch we adapt the original trace-cmd
implementation and change the naming convention used.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/CMakeLists.txt | 1 +
src/libkshark-hash.c | 239 +++++++++++++++++++++++++++++++++++++++++++
src/libkshark.h | 46 +++++++++
3 files changed, 286 insertions(+)
create mode 100644 src/libkshark-hash.c
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 213ce87..e7ae09c 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -2,6 +2,7 @@ message("\n src ...")
message(STATUS "libkshark")
add_library(kshark SHARED libkshark.c
+ libkshark-hash.c
libkshark-model.c
libkshark-plugin.c
libkshark-configio.c
diff --git a/src/libkshark-hash.c b/src/libkshark-hash.c
new file mode 100644
index 0000000..89c021b
--- /dev/null
+++ b/src/libkshark-hash.c
@@ -0,0 +1,239 @@
+// SPDX-License-Identifier: LGPL-2.1
+
+/*
+ * Copyright (C) 2009, Steven Rostedt <srostedt@redhat.com>
+ * Copyright (C) 2018 VMware Inc, Steven Rostedt <rostedt@goodmis.org>
+ */
+
+/**
+ * @file libkshark-hash.c
+ * @brief Hash table of integer Id numbers.
+ */
+
+// C
+#include <stdio.h>
+#include <stdlib.h>
+#include <assert.h>
+
+// KernelShark
+#include "libkshark.h"
+
+/**
+ * @brief: quick_hash - A quick (non secured) hash alogirthm
+ * @param val: The value to perform the hash on
+ * @param bits: The size in bits you need to return
+ *
+ * This is a quick hashing function adapted from Donald E. Knuth's 32
+ * bit multiplicative hash. See The Art of Computer Programming (TAOCP).
+ * Multiplication by the Prime number, closest to the golden ratio of
+ * 2^32.
+ *
+ * "bits" is used to max the result for use cases that require
+ * a power of 2 return value that is less than 32 bits. Any value
+ * of "bits" greater than 31 (or zero), will simply return the full hash
+ * on "val".
+ */
+static inline uint32_t quick_hash(uint32_t val, unsigned int bits)
+{
+ val *= UINT32_C(2654435761);
+
+ if (!bits || bits > 31)
+ return val;
+
+ return val & ((1 << bits) - 1);
+}
+
+static size_t hash_size(struct kshark_hash_id *hash)
+{
+ return (1 << hash->n_bits);
+}
+
+/**
+ * Create new hash table of Ids.
+ */
+struct kshark_hash_id *kshark_hash_id_alloc(size_t n_bits)
+{
+ struct kshark_hash_id *hash;
+ size_t size;
+
+ hash = calloc(1, sizeof(*hash));
+ if (!hash)
+ goto fail;
+
+ hash->n_bits = n_bits;
+ hash->count = 0;
+
+ size = hash_size(hash);
+ hash->hash = calloc(size, sizeof(*hash->hash));
+ if (!hash->hash)
+ goto fail;
+
+ return hash;
+
+ fail:
+ fprintf(stderr, "Failed to allocate memory for hash table.\n");
+ kshark_hash_id_free(hash);
+ return NULL;
+}
+
+/** Free the hash table of Ids. */
+void kshark_hash_id_free(struct kshark_hash_id *hash)
+{
+ if (!hash)
+ return;
+
+ if (hash->hash) {
+ kshark_hash_id_clear(hash);
+ free(hash->hash);
+ }
+
+ free(hash);
+}
+
+/**
+ * @brief Check if an Id with a given value exists in this hash table.
+ */
+bool kshark_hash_id_find(struct kshark_hash_id *hash, int id)
+{
+ uint32_t key = quick_hash(id, hash->n_bits);
+ struct kshark_hash_id_item *item;
+
+ for (item = hash->hash[key]; item; item = item->next)
+ if (item->id == id)
+ break;
+
+ return !!(unsigned long) item;
+}
+
+/**
+ * @brief Add Id to the hash table.
+ *
+ * @param hash: The hash table to add to.
+ * @param id: The Id number to be added.
+ *
+ * @returns Zero if the Id already exists in the table, one if the Id has been
+ * added and negative errno code on failure.
+ */
+int kshark_hash_id_add(struct kshark_hash_id *hash, int id)
+{
+ uint32_t key = quick_hash(id, hash->n_bits);
+ struct kshark_hash_id_item *item;
+
+ if (kshark_hash_id_find(hash, id))
+ return 0;
+
+ item = calloc(1, sizeof(*item));
+ if (!item) {
+ fprintf(stderr,
+ "Failed to allocate memory for hash table item.\n");
+ return -ENOMEM;
+ }
+
+ item->id = id;
+ item->next = hash->hash[key];
+ hash->hash[key] = item;
+ hash->count++;
+
+ return 1;
+}
+
+/**
+ * @brief Remove Id from the hash table.
+ */
+void kshark_hash_id_remove(struct kshark_hash_id *hash, int id)
+{
+ struct kshark_hash_id_item *item, **next;
+ int key = quick_hash(id, hash->n_bits);
+
+ next = &hash->hash[key];
+ while (*next) {
+ if ((*next)->id == id)
+ break;
+ next = &(*next)->next;
+ }
+
+ if (!*next)
+ return;
+
+ assert(hash->count);
+
+ hash->count--;
+ item = *next;
+ *next = item->next;
+
+ free(item);
+}
+
+/** Remove (free) all Ids (items) from this hash table. */
+void kshark_hash_id_clear(struct kshark_hash_id *hash)
+{
+ struct kshark_hash_id_item *item, *next;
+ size_t size;
+ int i;
+
+ if (!hash || ! hash->hash)
+ return;
+
+ size = hash_size(hash);
+ for (i = 0; i < size; i++) {
+ next = hash->hash[i];
+ if (!next)
+ continue;
+
+ hash->hash[i] = NULL;
+ while (next) {
+ item = next;
+ next = item->next;
+ free(item);
+ }
+ }
+
+ hash->count = 0;
+}
+
+static int compare_ids(const void* a, const void* b)
+{
+ int arg1 = *(const int*)a;
+ int arg2 = *(const int*)b;
+
+ if (arg1 < arg2)
+ return -1;
+
+ if (arg1 > arg2)
+ return 1;
+
+ return 0;
+}
+
+/**
+ * @brief Get a sorted array containing all Ids of this hash table.
+ */
+int *kshark_hash_ids(struct kshark_hash_id *hash)
+{
+ struct kshark_hash_id_item *item;
+ size_t size = hash_size(hash);
+ int count = 0, i;
+ int *ids;
+
+ if (!hash->count)
+ return NULL;
+
+ ids = calloc(hash->count, sizeof(*ids));
+ if (!ids) {
+ fprintf(stderr,
+ "Failed to allocate memory for Id array.\n");
+ return NULL;
+ }
+
+ for (i = 0; i < size; i++) {
+ item = hash->hash[i];
+ while (item) {
+ ids[count++] = item->id;
+ item = item->next;
+ }
+ }
+
+ qsort(ids, hash->count, sizeof(*ids), compare_ids);
+
+ return ids;
+}
diff --git a/src/libkshark.h b/src/libkshark.h
index 7d8b53b..cc20077 100644
--- a/src/libkshark.h
+++ b/src/libkshark.h
@@ -75,6 +75,52 @@ struct kshark_entry {
int64_t ts;
};
+/** Size of the hash table of PIDs in terms of bits being used by the key. */
+#define KS_TASK_HASH_NBITS 16
+
+/** Size of the hash table of Ids in terms of bits being used by the key. */
+#define KS_FILTER_HASH_NBITS 8
+
+/** A bucket for the hash table of integer Id numbers (kshark_hash_id). */
+struct kshark_hash_id_item {
+ /** Pointer to the Id in this bucket. */
+ struct kshark_hash_id_item *next;
+
+ /** The Id value. */
+ int id;
+};
+
+/**
+ * Hash table of integer Id numbers. To be used for fast filter of trace
+ * entries.
+ */
+struct kshark_hash_id {
+ /** Array of buckets. */
+ struct kshark_hash_id_item **hash;
+
+ /** The number of Ids in the table. */
+ size_t count;
+
+ /**
+ * The number of bits used by the hashing function.
+ * Note that the number of buckets in the table if given by
+ * 1 << n_bits.
+ */
+ size_t n_bits;
+};
+
+bool kshark_hash_id_find(struct kshark_hash_id *hash, int id);
+
+int kshark_hash_id_add(struct kshark_hash_id *hash, int id);
+
+void kshark_hash_id_clear(struct kshark_hash_id *hash);
+
+struct kshark_hash_id *kshark_hash_id_alloc(size_t n_bits);
+
+void kshark_hash_id_free(struct kshark_hash_id *hash);
+
+int *kshark_hash_ids(struct kshark_hash_id *hash);
+
/** Size of the task's hash table. */
#define KS_TASK_HASH_SHIFT 16
#define KS_TASK_HASH_SIZE (1 << KS_TASK_HASH_SHIFT)
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 09/32] kernel-shark: Introduce Data streams
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (7 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 08/32] kernel-shark: Introduce libkshark-hash Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 10/32] kernel-shark: Rename static methods in libkshark Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 11/32] kernel-shark: Add basic methods for Data streams Yordan Karadzhov (VMware)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
With the help of Data stream, KernelShark will be able to load and
merge multiple trace files (streams). Each stream can have different
plugins or filters, registered for it, which means that the raw trace
data of the streams can have different formats, and will allow for a
great degree of customization of the provided data visualization. In
this patch we only provide the basic definitions. The actual integration
of the Data streams into the C API of KernelShark will happen in the
following patches.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/libkshark.h | 199 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 199 insertions(+)
diff --git a/src/libkshark.h b/src/libkshark.h
index cc20077..9f7b6b1 100644
--- a/src/libkshark.h
+++ b/src/libkshark.h
@@ -121,6 +121,205 @@ void kshark_hash_id_free(struct kshark_hash_id *hash);
int *kshark_hash_ids(struct kshark_hash_id *hash);
+struct kshark_data_stream;
+
+/** A function type to be used by the method interface of the data stream. */
+typedef char *(*stream_get_str_func) (struct kshark_data_stream *,
+ const struct kshark_entry *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef const int (*stream_get_int_func) (struct kshark_data_stream *,
+ const struct kshark_entry *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef int (*stream_find_id_func) (struct kshark_data_stream *,
+ const char *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef int *(*stream_get_ids_func) (struct kshark_data_stream *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef int (*stream_get_names_func) (struct kshark_data_stream *,
+ const struct kshark_entry *,
+ char ***);
+
+/** Event field format identifier. */
+typedef enum kshark_event_field_format {
+ /** A field of unknown type. */
+ KS_INVALID_FIELD,
+
+ /** Integer number */
+ KS_INTEGER_FIELD,
+
+ /** Floating-point number */
+ KS_FLOAT_FIELD
+} kshark_event_field_format;
+
+/** A function type to be used by the method interface of the data stream. */
+typedef kshark_event_field_format
+(*stream_event_field_type) (struct kshark_data_stream *,
+ const struct kshark_entry *,
+ const char *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef const int (*stream_read_event_field) (struct kshark_data_stream *,
+ const struct kshark_entry *,
+ const char *,
+ int64_t *);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef const int (*stream_read_record_field) (struct kshark_data_stream *,
+ void *,
+ const char *,
+ int64_t *);
+
+struct kshark_context;
+
+/** A function type to be used by the method interface of the data stream. */
+typedef ssize_t (*load_entries_func) (struct kshark_data_stream *,
+ struct kshark_context *,
+ struct kshark_entry ***);
+
+/** A function type to be used by the method interface of the data stream. */
+typedef ssize_t (*load_matrix_func) (struct kshark_data_stream *,
+ struct kshark_context *,
+ int16_t **event_array,
+ int16_t **cpu_array,
+ int32_t **pid_array,
+ int64_t **offset_array,
+ int64_t **ts_array);
+
+/** Data interface identifier. */
+typedef enum kshark_data_interface_id {
+ /** An interface with unknown type. */
+ KS_INVALID_INTERFACE,
+
+ /** Generic interface suitable for Ftrace data. */
+ KS_GENERIC_DATA_INTERFACE,
+} kshark_data_interface_id;
+
+/**
+ * Structure representing the interface of methods used to operate over
+ * the data from a given stream.
+ */
+struct kshark_generic_stream_interface {
+ /** Interface version identifier. */
+ kshark_data_interface_id type; /* MUST BE FIRST ENTRY. */
+
+ /** Method used to retrieve the Process Id of the entry. */
+ stream_get_int_func get_pid;
+
+ /** Method used to retrieve the Event Id of the entry. */
+ stream_get_int_func get_event_id;
+
+ /** Method used to retrieve the Event name of the entry. */
+ stream_get_str_func get_event_name;
+
+ /** Method used to retrieve the Task name of the entry. */
+ stream_get_str_func get_task;
+
+ /** Method used to retrieve the Info string of the entry. */
+ stream_get_str_func get_info;
+
+ /**
+ * Method used to retrieve an unspecified auxiliary info of the trace
+ * record.
+ */
+ stream_get_str_func aux_info;
+
+ /** Method used to retrieve Id of the Event from its name. */
+ stream_find_id_func find_event_id;
+
+ /** Method used to retrieve the array of Ids of all Events. */
+ stream_get_ids_func get_all_event_ids;
+
+ /** Method used to dump the entry's content to string. */
+ stream_get_str_func dump_entry;
+
+ /**
+ * Method used to retrieve the array of all field names of a given
+ * event.
+ */
+ stream_get_names_func get_all_event_field_names;
+
+ /** Method used to access the type of an event's data field. */
+ stream_event_field_type get_event_field_type;
+
+ /** Method used to access the value of an event's data field. */
+ stream_read_event_field read_event_field_int64;
+
+ /** Method used to access the value of an event's data field. */
+ stream_read_record_field read_record_field_int64;
+
+ /** Method used to load the data in the form of entries. */
+ load_entries_func load_entries;
+
+ /** Method used to load the data in matrix form. */
+ load_matrix_func load_matrix;
+
+ /** Generic data handle. */
+ void *handle;
+};
+
+/** The limit in size of the data format identifier string. */
+#define KS_DATA_FORMAT_SIZE 15
+
+/** Structure representing a stream of trace data. */
+struct kshark_data_stream {
+ /** Data stream identifier. */
+ uint16_t stream_id;
+
+ /** The number of CPUs presented in this data stream. */
+ int n_cpus;
+
+ /**
+ * The number of distinct event types presented in this data stream.
+ */
+ int n_events;
+
+ /** The Process Id of the Idle task. */
+ int idle_pid;
+
+ /** Trace data file pathname. */
+ char *file;
+
+ /** Stream name. */
+ char *name;
+
+ /** Hash table of task PIDs. */
+ struct kshark_hash_id *tasks;
+
+ /** A mutex, used to protect the access to the input file. */
+ pthread_mutex_t input_mutex;
+
+ /** Hash of tasks to filter on. */
+ struct kshark_hash_id *show_task_filter;
+
+ /** Hash of tasks to not display. */
+ struct kshark_hash_id *hide_task_filter;
+
+ /** Hash of events to filter on. */
+ struct kshark_hash_id *show_event_filter;
+
+ /** Hash of events to not display. */
+ struct kshark_hash_id *hide_event_filter;
+
+ /** Hash of CPUs to filter on. */
+ struct kshark_hash_id *show_cpu_filter;
+
+ /** Hash of CPUs to not display. */
+ struct kshark_hash_id *hide_cpu_filter;
+
+ /** The type of the data. */
+ char data_format[KS_DATA_FORMAT_SIZE];
+
+ /**
+ * The interface of methods used to operate over the data from a given
+ * stream.
+ */
+ void *interface;
+};
+
/** Size of the task's hash table. */
#define KS_TASK_HASH_SHIFT 16
#define KS_TASK_HASH_SIZE (1 << KS_TASK_HASH_SHIFT)
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 10/32] kernel-shark: Rename static methods in libkshark
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (8 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 09/32] kernel-shark: Introduce Data streams Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
2020-12-11 14:44 ` [PATCH v7 11/32] kernel-shark: Add basic methods for Data streams Yordan Karadzhov (VMware)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
"kshark" prefix is needed only for the public methods of the API.
We are changing the names of those static methods because we need to
use those names when integrating the data streams into the API.i
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/libkshark.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/libkshark.c b/src/libkshark.c
index a14d3c5..0acce90 100644
--- a/src/libkshark.c
+++ b/src/libkshark.c
@@ -1097,8 +1097,8 @@ size_t kshark_load_data_matrix(struct kshark_context *kshark_ctx,
return -ENOMEM;
}
-static const char *kshark_get_latency(struct tep_handle *pe,
- struct tep_record *record)
+static const char *get_latency(struct tep_handle *pe,
+ struct tep_record *record)
{
if (!record)
return NULL;
@@ -1108,7 +1108,7 @@ static const char *kshark_get_latency(struct tep_handle *pe,
return seq.buffer;
}
-static const char *kshark_get_info(struct tep_handle *pe,
+static const char *get_info(struct tep_handle *pe,
struct tep_record *record,
struct tep_event *event)
{
@@ -1233,7 +1233,7 @@ const char *kshark_get_latency_easy(struct kshark_entry *entry)
pthread_mutex_lock(&kshark_ctx->input_mutex);
data = tracecmd_read_at(kshark_ctx->handle, entry->offset, NULL);
- lat = kshark_get_latency(kshark_ctx->pevent, data);
+ lat = get_latency(kshark_ctx->pevent, data);
free_record(data);
pthread_mutex_unlock(&kshark_ctx->input_mutex);
@@ -1376,7 +1376,7 @@ const char *kshark_get_info_easy(struct kshark_entry *entry)
event_id = tep_data_type(kshark_ctx->pevent, data);
event = tep_find_event(kshark_ctx->pevent, event_id);
if (event)
- info = kshark_get_info(kshark_ctx->pevent, data, event);
+ info = get_info(kshark_ctx->pevent, data, event);
free_record(data);
@@ -1471,7 +1471,7 @@ char* kshark_dump_entry(const struct kshark_entry *entry)
event = tep_find_event(kshark_ctx->pevent, entry->event_id);
event_name = event? event->name : "[UNKNOWN EVENT]";
- lat = kshark_get_latency(kshark_ctx->pevent, data);
+ lat = get_latency(kshark_ctx->pevent, data);
size = asprintf(&temp_str, "%" PRIu64 "; %s-%i; CPU %i; %s;",
entry->ts,
@@ -1480,7 +1480,7 @@ char* kshark_dump_entry(const struct kshark_entry *entry)
entry->cpu,
lat);
- info = kshark_get_info(kshark_ctx->pevent, data, event);
+ info = get_info(kshark_ctx->pevent, data, event);
if (size > 0) {
size = asprintf(&entry_str, "%s %s; %s; 0x%x",
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH v7 11/32] kernel-shark: Add basic methods for Data streams
2020-12-11 14:44 [PATCH v7 00/32] Start KernelShark v2 transformation Yordan Karadzhov (VMware)
` (9 preceding siblings ...)
2020-12-11 14:44 ` [PATCH v7 10/32] kernel-shark: Rename static methods in libkshark Yordan Karadzhov (VMware)
@ 2020-12-11 14:44 ` Yordan Karadzhov (VMware)
10 siblings, 0 replies; 14+ messages in thread
From: Yordan Karadzhov (VMware) @ 2020-12-11 14:44 UTC (permalink / raw)
To: rostedt; +Cc: linux-trace-devel, Yordan Karadzhov (VMware)
Here we introduce the basic mechanisms for using data streams.
For the moment these are just stand alone definitions and the
integration with the API is yet to be introduced in the following
patches.
Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
src/libkshark.c | 716 ++++++++++++++++++++++++++++++++++++++++++++++++
src/libkshark.h | 104 +++++++
2 files changed, 820 insertions(+)
diff --git a/src/libkshark.c b/src/libkshark.c
index 0acce90..bf465b5 100644
--- a/src/libkshark.c
+++ b/src/libkshark.c
@@ -166,6 +166,258 @@ bool kshark_open(struct kshark_context *kshark_ctx, const char *file)
return true;
}
+static void kshark_stream_free(struct kshark_data_stream *stream)
+{
+ if (!stream)
+ return;
+
+ kshark_hash_id_free(stream->show_task_filter);
+ kshark_hash_id_free(stream->hide_task_filter);
+
+ kshark_hash_id_free(stream->show_event_filter);
+ kshark_hash_id_free(stream->hide_event_filter);
+
+ kshark_hash_id_free(stream->show_cpu_filter);
+ kshark_hash_id_free(stream->hide_cpu_filter);
+
+ kshark_hash_id_free(stream->tasks);
+
+ free(stream->file);
+ free(stream->name);
+ free(stream->interface);
+ free(stream);
+}
+
+static struct kshark_data_stream *kshark_stream_alloc()
+{
+ struct kshark_data_stream *stream;
+
+ stream = calloc(1, sizeof(*stream));
+ if (!stream)
+ goto fail;
+
+ stream->show_task_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+ stream->hide_task_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+
+ stream->show_event_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+ stream->hide_event_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+
+ stream->show_cpu_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+ stream->hide_cpu_filter = kshark_hash_id_alloc(KS_FILTER_HASH_NBITS);
+
+ stream->tasks = kshark_hash_id_alloc(KS_TASK_HASH_NBITS);
+
+ if (!stream->show_task_filter ||
+ !stream->hide_task_filter ||
+ !stream->show_event_filter ||
+ !stream->hide_event_filter ||
+ !stream->tasks) {
+ goto fail;
+ }
+
+ kshark_set_data_format(stream->data_format, KS_INVALID_DATA);
+ stream->name = strdup(KS_UNNAMED);
+
+ return stream;
+
+ fail:
+ kshark_stream_free(stream);
+
+ return NULL;
+}
+/**
+ * The maximum number of Data streams that can be added simultaneously.
+ * The limit is determined by the 16 bit integer used to store the stream Id
+ * inside struct kshark_entry.
+ */
+#define KS_MAX_STREAM_ID INT16_MAX
+
+/**
+ * Bit mask (0 - 15) used when converting indexes to pointers and vise-versa.
+ */
+#define INDEX_MASK UINT16_MAX
+
+/**
+ * Bit mask (16 - 31/63) used when converting indexes to pointers and
+ * vise-versa.
+ */
+#define INVALID_STREAM_MASK (~((unsigned long) INDEX_MASK))
+
+static int index_from_ptr(void *ptr)
+{
+ unsigned long index = (unsigned long) ptr;
+
+ return (int) (index & INDEX_MASK);
+}
+
+static void *index_to_ptr(unsigned int index)
+{
+ unsigned long p;
+
+ p = INVALID_STREAM_MASK | index;
+
+ return (void *) p;
+}
+
+static bool kshark_is_valid_stream(void *ptr)
+{
+ unsigned long p = (unsigned long) ptr;
+ bool v = !((p & ~INDEX_MASK) == INVALID_STREAM_MASK);
+
+ return p && v;
+}
+
+/**
+ * @brief Add new Data stream.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ *
+ * @returns Zero on success or a negative errno code on failure.
+ */
+int kshark_add_stream(struct kshark_context *kshark_ctx)
+{
+ struct kshark_data_stream *stream;
+ int new_stream;
+
+ if(kshark_ctx->stream_info.next_free_stream_id > KS_MAX_STREAM_ID)
+ return -ENODEV;
+
+ if (kshark_ctx->stream_info.next_free_stream_id ==
+ kshark_ctx->stream_info.array_size) {
+ size_t new_size = 2 * kshark_ctx->stream_info.array_size;
+ struct kshark_data_stream **streams_tmp;
+
+ streams_tmp = realloc(kshark_ctx->stream,
+ new_size * sizeof(*kshark_ctx->stream));
+ if (!streams_tmp)
+ return -ENOMEM;
+
+ kshark_ctx->stream = streams_tmp;
+ kshark_ctx->stream_info.array_size = new_size;
+ }
+
+ stream = kshark_stream_alloc();
+ if (!stream)
+ return -ENOMEM;
+
+ if (pthread_mutex_init(&stream->input_mutex, NULL) != 0) {
+ kshark_stream_free(stream);
+ return -EAGAIN;
+ }
+
+ if (kshark_ctx->stream_info.next_free_stream_id >
+ kshark_ctx->stream_info.max_stream_id) {
+ new_stream = ++kshark_ctx->stream_info.max_stream_id;
+
+ kshark_ctx->stream_info.next_free_stream_id = new_stream + 1;
+
+ kshark_ctx->stream[new_stream] = stream;
+ stream->stream_id = new_stream;
+ } else {
+ new_stream = kshark_ctx->stream_info.next_free_stream_id;
+
+ kshark_ctx->stream_info.next_free_stream_id =
+ index_from_ptr(kshark_ctx->stream[new_stream]);
+
+ kshark_ctx->stream[new_stream] = stream;
+ stream->stream_id = new_stream;
+ }
+
+ kshark_ctx->n_streams++;
+
+ return stream->stream_id;
+}
+
+/**
+ * @brief Remove Data stream.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ * @param sd: Data stream identifier.
+ *
+ * @returns Zero on success or a negative errno code on failure.
+ */
+int kshark_remove_stream(struct kshark_context *kshark_ctx, int sd)
+{
+ struct kshark_data_stream *stream;
+
+ if (sd < 0 ||
+ sd > kshark_ctx->stream_info.max_stream_id ||
+ !kshark_is_valid_stream(kshark_ctx->stream[sd]))
+ return -EFAULT;
+
+ stream = kshark_ctx->stream[sd];
+
+ pthread_mutex_destroy(&stream->input_mutex);
+
+ kshark_stream_free(stream);
+ kshark_ctx->stream[sd] =
+ index_to_ptr(kshark_ctx->stream_info.next_free_stream_id);
+ kshark_ctx->stream_info.next_free_stream_id = sd;
+ kshark_ctx->n_streams--;
+
+ return 0;
+}
+
+/**
+ * @brief Get the Data stream object having given Id.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ * @param sd: Data stream identifier.
+ *
+ * @returns Pointer to a Data stream object if the sream exists. Otherwise
+ * NULL.
+ */
+struct kshark_data_stream *
+kshark_get_data_stream(struct kshark_context *kshark_ctx, int sd)
+{
+ if (sd >= 0 && sd <= kshark_ctx->stream_info.max_stream_id)
+ if (kshark_ctx->stream[sd] &&
+ kshark_is_valid_stream(kshark_ctx->stream[sd]) &&
+ kshark_ctx->stream[sd]->interface)
+ return kshark_ctx->stream[sd];
+
+ return NULL;
+}
+
+/**
+ * @brief Get the Data stream object corresponding to a given entry
+ *
+ * @param entry: Input location for the KernelShark entry.
+ *
+ * @returns Pointer to a Data stream object on success. Otherwise NULL.
+ */
+struct kshark_data_stream *
+kshark_get_stream_from_entry(const struct kshark_entry *entry)
+{
+ struct kshark_context *kshark_ctx = NULL;
+
+ if (!kshark_instance(&kshark_ctx))
+ return NULL;
+
+ return kshark_get_data_stream(kshark_ctx, entry->stream_id);
+}
+
+/**
+ * @brief Get an array containing the Ids of all opened Trace data streams.
+ * The User is responsible for freeing the array.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ */
+int *kshark_all_streams(struct kshark_context *kshark_ctx)
+{
+ int *ids, i, count = 0;
+
+ ids = calloc(kshark_ctx->n_streams, (sizeof(*ids)));
+ if (!ids)
+ return NULL;
+
+ for (i = 0; i <= kshark_ctx->stream_info.max_stream_id; ++i)
+ if (kshark_ctx->stream[i] &&
+ kshark_is_valid_stream(kshark_ctx->stream[i]))
+ ids[count++] = i;
+
+ return ids;
+}
/**
* @brief Close the trace data file and free the trace data handle.
*
@@ -252,6 +504,470 @@ void kshark_free(struct kshark_context *kshark_ctx)
free(kshark_ctx);
}
+/**
+ * @brief Get the name of the command/task from its Process Id.
+ *
+ * @param sd: Data stream identifier.
+ * @param pid: Process Id of the command/task.
+ */
+char *kshark_comm_from_pid(int sd, int pid)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_context *kshark_ctx = NULL;
+ struct kshark_data_stream *stream;
+ struct kshark_entry e;
+
+ if (!kshark_instance(&kshark_ctx))
+ return NULL;
+
+ stream = kshark_get_data_stream(kshark_ctx, sd);
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_task) {
+ e.visible = KS_PLUGIN_UNTOUCHED_MASK;
+ e.pid = pid;
+
+ return interface->get_task(stream, &e);
+ }
+
+ return NULL;
+}
+
+/**
+ * @brief Get the name of the event from its Id.
+ *
+ * @param sd: Data stream identifier.
+ * @param event_id: The unique Id of the event type.
+ */
+char *kshark_event_from_id(int sd, int event_id)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_context *kshark_ctx = NULL;
+ struct kshark_data_stream *stream;
+ struct kshark_entry e;
+
+ if (!kshark_instance(&kshark_ctx))
+ return NULL;
+
+ stream = kshark_get_data_stream(kshark_ctx, sd);
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_event_name) {
+ e.visible = KS_PLUGIN_UNTOUCHED_MASK;
+ e.event_id = event_id;
+
+ return interface->get_event_name(stream, &e);
+ }
+
+ return NULL;
+}
+
+/**
+ * @brief Get the original process Id of the entry. Using this function make
+ * sense only in cases when the original value can be overwritten by
+ * plugins. If you know that no plugins are loaded use "entry->pid"
+ * directly.
+ *
+ * @param entry: Input location for an entry.
+ */
+int kshark_get_pid(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_pid)
+ return interface->get_pid(stream, entry);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Get the original event Id of the entry. Using this function make
+ * sense only in cases when the original value can be overwritten by
+ * plugins. If you know that no plugins are loaded use "entry->event_id"
+ * directly.
+ *
+ * @param entry: Input location for an entry.
+ */
+int kshark_get_event_id(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_event_id)
+ return interface->get_event_id(stream, entry);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Get an array of all event Ids for a given data stream.
+ *
+ * @param stream: Input location for a Trace data stream pointer.
+ *
+ * @returns An array of event Ids. The user is responsible for freeing the
+ * outputted array.
+ */
+int *kshark_get_all_event_ids(struct kshark_data_stream *stream)
+{
+ struct kshark_generic_stream_interface *interface;
+
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_all_event_ids)
+ return interface->get_all_event_ids(stream);
+
+ return NULL;
+}
+
+/**
+ * @brief Find the event Ids corresponding to a given event name.
+ *
+ * @param stream: Input location for a Trace data stream pointer.
+ * @param event_name: The name of the event.
+ *
+ * @returns Event Ids number.
+ */
+int kshark_find_event_id(struct kshark_data_stream *stream,
+ const char *event_name)
+{
+ struct kshark_generic_stream_interface *interface;
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->find_event_id)
+ return interface->find_event_id(stream, event_name);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Find the event name corresponding to a given entry.
+ *
+ * @param entry: Input location for an entry.
+ *
+ * @returns The mane of the event on success, or NULL in case of failure.
+ * The use is responsible for freeing the output string.
+ */
+char *kshark_get_event_name(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_event_name)
+ return interface->get_event_name(stream, entry);
+
+ return NULL;
+}
+
+/**
+ * @brief Find the task name corresponding to a given entry.
+ *
+ * @param entry: Input location for an entry.
+ *
+ * @returns The mane of the task on success, or NULL in case of failure.
+ * The use is responsible for freeing the output string.
+ */
+char *kshark_get_task(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_task)
+ return interface->get_task(stream, entry);
+
+ return NULL;
+}
+
+/**
+ * @brief Get the basic information (text) about the entry.
+ *
+ * @param entry: Input location for an entry.
+ *
+ * @returns A the info text. The user is responsible for freeing the
+ * outputted string.
+ */
+char *kshark_get_info(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_info)
+ return interface->get_info(stream, entry);
+
+ return NULL;
+}
+
+/**
+ * @brief Get the auxiliary information about the entry. In the case of
+ * TEP (Ftrace) data, this function provides the latency info.
+ *
+ * @param entry: Input location for an entry.
+ *
+ * @returns A the auxiliary text info. The user is responsible for freeing the
+ * outputted string.
+ */
+char *kshark_get_aux_info(const struct kshark_entry *entry)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return NULL;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->aux_info)
+ return interface->aux_info(stream, entry);
+
+ return NULL;
+}
+
+/**
+ * @brief Get an array of all data field names associated with a given entry.
+ *
+ * @param entry: Input location for an entry.
+ * @param fields: Output location of the array of field names. The user is
+ * responsible for freeing the elements of the outputted array.
+ *
+ * @returns Total number of event fields on success, or a negative errno in
+ * the case of a failure.
+ */
+int kshark_get_all_event_field_names(const struct kshark_entry *entry,
+ char ***fields)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_all_event_field_names)
+ return interface->get_all_event_field_names(stream,
+ entry, fields);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Get the value type of an event field corresponding to a given entry.
+ *
+ * @param entry: Input location for an entry.
+ * @param field: The name of the data field.
+ *
+ * @returns The type of the data field on success, or KS_INVALID_FIELD in
+ * the case of a failure.
+ */
+kshark_event_field_format
+kshark_get_event_field_type(const struct kshark_entry *entry,
+ const char *field)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return KS_INVALID_FIELD;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->get_event_field_type)
+ return interface->get_event_field_type(stream, entry, field);
+
+ return KS_INVALID_FIELD;
+}
+
+/**
+ * @brief Get the value of an event field in a given trace record.
+ *
+ * @param stream: Input location for a Trace data stream pointer.
+ * @param rec: Input location for a record.
+ * @param field: The name of the data field.
+ * @param val: Output location for the value of the field.
+ *
+ * @returns Zero on success or a negative errno in the case of a failure.
+ */
+int kshark_read_record_field_int(struct kshark_data_stream *stream, void *rec,
+ const char *field, int64_t *val)
+{
+ struct kshark_generic_stream_interface *interface;
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->read_record_field_int64)
+ return interface->read_record_field_int64(stream, rec,
+ field, val);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Get the value of an event field corresponding to a given entry.
+ * The value is retrieved via the offset in the file of the original
+ * record.
+ *
+ * @param entry: Input location for an entry.
+ * @param field: The name of the data field.
+ * @param val: Output location for the value of the field.
+ *
+ * @returns Zero on success or a negative errno in the case of a failure.
+ */
+int kshark_read_event_field_int(const struct kshark_entry *entry,
+ const char* field, int64_t *val)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_stream_from_entry(entry);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->read_event_field_int64)
+ return interface->read_event_field_int64(stream, entry, field, val);
+
+ return -EFAULT;
+}
+
+/** @brief Print the entry. */
+void kshark_print_entry(const struct kshark_entry *entry)
+{
+ char *entry_str = kshark_dump_entry(entry);
+
+ if (!entry_str)
+ puts("(nil)");
+
+ puts(entry_str);
+ free(entry_str);
+}
+
+/**
+ * @brief Load the content of the trace data file asociated with a given
+ * Data stream into an array of kshark_entries.
+ * If one or more filters are set, the "visible" fields of each entry
+ * is updated according to the criteria provided by the filters. The
+ * field "filter_mask" of the session's context is used to control the
+ * level of visibility/invisibility of the filtered entries.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ * @param sd: Data stream identifier.
+ * @param data_rows: Output location for the trace data. The user is
+ * responsible for freeing the elements of the outputted
+ * array.
+ *
+ * @returns The size of the outputted data in the case of success, or a
+ * negative error code on failure.
+ */
+ssize_t kshark_load_entries(struct kshark_context *kshark_ctx, int sd,
+ struct kshark_entry ***data_rows)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_data_stream(kshark_ctx, sd);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->load_entries)
+ return interface->load_entries(stream, kshark_ctx, data_rows);
+
+ return -EFAULT;
+}
+
+/**
+ * @brief Load the content of the trace data file asociated with a given
+ * Data stream into a data matrix. The user is responsible
+ * for freeing the outputted data.
+ *
+ * @param kshark_ctx: Input location for context pointer.
+ * @param sd: Data stream identifier.
+ * @param cpu_array: Output location for the CPU column (array) of the matrix.
+ * @param event_array: Output location for the Event Id column (array) of the
+ * matrix.
+ * @param pid_array: Output location for the PID column (array) of the matrix.
+ * @param offset_array: Output location for the offset column (array) of the
+ * matrix.
+ * @param ts_array: Output location for the time stamp column (array) of the
+ * matrix.
+ */
+ssize_t kshark_load_matrix(struct kshark_context *kshark_ctx, int sd,
+ int16_t **event_array,
+ int16_t **cpu_array,
+ int32_t **pid_array,
+ int64_t **offset_array,
+ int64_t **ts_array)
+{
+ struct kshark_generic_stream_interface *interface;
+ struct kshark_data_stream *stream =
+ kshark_get_data_stream(kshark_ctx, sd);
+
+ if (!stream)
+ return -EFAULT;
+
+ interface = stream->interface;
+ if (interface->type == KS_GENERIC_DATA_INTERFACE &&
+ interface->load_matrix)
+ return interface->load_matrix(stream, kshark_ctx, event_array,
+ cpu_array,
+ pid_array,
+ offset_array,
+ ts_array);
+
+ return -EFAULT;
+}
+
static struct kshark_task_list *
kshark_find_task(struct kshark_context *kshark_ctx, uint32_t key, int pid)
{
diff --git a/src/libkshark.h b/src/libkshark.h
index 9f7b6b1..77fa4c5 100644
--- a/src/libkshark.h
+++ b/src/libkshark.h
@@ -121,6 +121,19 @@ void kshark_hash_id_free(struct kshark_hash_id *hash);
int *kshark_hash_ids(struct kshark_hash_id *hash);
+/* Quiet warnings over documenting simple structures */
+//! @cond Doxygen_Suppress
+
+static const char top_name[] = { 0x1b, 0x00 }; // Non printable character
+
+//! @endcond
+
+/**
+ * Non printable character used for the name in the case when the name has to
+ * be ignored.
+ */
+#define KS_UNNAMED (char *) &top_name
+
struct kshark_data_stream;
/** A function type to be used by the method interface of the data stream. */
@@ -264,6 +277,9 @@ struct kshark_generic_stream_interface {
/** The limit in size of the data format identifier string. */
#define KS_DATA_FORMAT_SIZE 15
+/** Data format identifier string indicating invalid data. */
+#define KS_INVALID_DATA "invalid data"
+
/** Structure representing a stream of trace data. */
struct kshark_data_stream {
/** Data stream identifier. */
@@ -320,6 +336,12 @@ struct kshark_data_stream {
void *interface;
};
+static inline char *kshark_set_data_format(char *dest_format,
+ const char *src_format)
+{
+ return strncpy(dest_format, src_format, KS_DATA_FORMAT_SIZE - 1);
+}
+
/** Size of the task's hash table. */
#define KS_TASK_HASH_SHIFT 16
#define KS_TASK_HASH_SIZE (1 << KS_TASK_HASH_SHIFT)
@@ -333,8 +355,32 @@ struct kshark_task_list {
int pid;
};
+/**
+ * Structure representing the parameters of the stream descriptor array owned
+ * by the kshark session.
+ */
+struct kshark_stream_array_descriptor {
+ /** The identifier of the Data stream added. */
+ int max_stream_id;
+
+ /** The the next free Data stream identifier (index). */
+ int next_free_stream_id;
+
+ /** The capacity of the array of stream objects (pointers). */
+ int array_size;
+};
+
/** Structure representing a kshark session. */
struct kshark_context {
+ /** Array of data stream descriptors. */
+ struct kshark_data_stream **stream;
+
+ /** The number of data streams. */
+ int n_streams;
+
+ /** Parameters of the stream descriptor array. */
+ struct kshark_stream_array_descriptor stream_info;
+
/** Input handle for the trace data file. */
struct tracecmd_input *handle;
@@ -392,6 +438,18 @@ bool kshark_instance(struct kshark_context **kshark_ctx);
bool kshark_open(struct kshark_context *kshark_ctx, const char *file);
+int kshark_add_stream(struct kshark_context *kshark_ctx);
+
+int kshark_remove_stream(struct kshark_context *kshark_ctx, int sd);
+
+struct kshark_data_stream *
+kshark_get_data_stream(struct kshark_context *kshark_ctx, int sd);
+
+struct kshark_data_stream *
+kshark_get_stream_from_entry(const struct kshark_entry *entry);
+
+int *kshark_all_streams(struct kshark_context *kshark_ctx);
+
ssize_t kshark_load_data_entries(struct kshark_context *kshark_ctx,
struct kshark_entry ***data_rows);
@@ -411,6 +469,10 @@ void kshark_close(struct kshark_context *kshark_ctx);
void kshark_free(struct kshark_context *kshark_ctx);
+char *kshark_comm_from_pid(int sd, int pid);
+
+char *kshark_event_from_id(int sd, int event_id);
+
int kshark_get_pid_easy(struct kshark_entry *entry);
const char *kshark_get_task_easy(struct kshark_entry *entry);
@@ -427,6 +489,48 @@ void kshark_convert_nano(uint64_t time, uint64_t *sec, uint64_t *usec);
char* kshark_dump_entry(const struct kshark_entry *entry);
+void kshark_print_entry(const struct kshark_entry *entry);
+
+int kshark_get_pid(const struct kshark_entry *entry);
+
+int kshark_get_event_id(const struct kshark_entry *entry);
+
+int *kshark_get_all_event_ids(struct kshark_data_stream *stream);
+
+int kshark_find_event_id(struct kshark_data_stream *stream,
+ const char *event_name);
+
+char *kshark_get_event_name(const struct kshark_entry *entry);
+
+char *kshark_get_task(const struct kshark_entry *entry);
+
+char *kshark_get_info(const struct kshark_entry *entry);
+
+char *kshark_get_aux_info(const struct kshark_entry *entry);
+
+kshark_event_field_format
+kshark_get_event_field_type(const struct kshark_entry *entry,
+ const char *field);
+
+int kshark_get_all_event_field_names(const struct kshark_entry *entry,
+ char ***field);
+
+int kshark_read_record_field_int(struct kshark_data_stream *stream, void *rec,
+ const char *field, int64_t *val);
+
+int kshark_read_event_field_int(const struct kshark_entry *entry,
+ const char* field, int64_t *val);
+
+ssize_t kshark_load_entries(struct kshark_context *kshark_ctx, int sd,
+ struct kshark_entry ***data_rows);
+
+ssize_t kshark_load_matrix(struct kshark_context *kshark_ctx, int sd,
+ int16_t **event_array,
+ int16_t **cpu_array,
+ int32_t **pid_array,
+ int64_t **offset_array,
+ int64_t **ts_array);
+
/**
* Custom entry info function type. To be user for dumping info for custom
* KernelShark entryes.
--
2.25.1
^ permalink raw reply related [flat|nested] 14+ messages in thread