From 6dc2ca620b58bbd67df61d8a5265ee4292f2dd37 Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Sun, 26 Sep 2010 17:28:45 -0400 Subject: [PATCH] Common Trace Format - initial commit Signed-off-by: Mathieu Desnoyers --- LICENSE | 26 ++ gpl-2.0.txt | 339 +++++++++++++++++++++ include/ctf/align.h | 52 ++++ include/ctf/bitfield.h | 349 +++++++++++++++++++++ include/ctf/compiler.h | 6 + include/ctf/ctf-types-bitfield.h | 56 ++++ include/ctf/ctf-types.h | 56 ++++ lgpl-2.1.txt | 504 +++++++++++++++++++++++++++++++ lib/types/enum.c | 162 ++++++++++ lib/types/float.c | 220 ++++++++++++++ lib/types/integer.c | 146 +++++++++ lib/types/string.c | 23 ++ lib/types/struct.c | 14 + lib/types/types.c | 17 ++ mit-license.txt | 19 ++ std-ext-lib.txt | 72 +++++ tests/test-bitfield.c | 372 +++++++++++++++++++++++ 17 files changed, 2433 insertions(+) create mode 100644 LICENSE create mode 100644 gpl-2.0.txt create mode 100644 include/ctf/align.h create mode 100644 include/ctf/bitfield.h create mode 100644 include/ctf/compiler.h create mode 100644 include/ctf/ctf-types-bitfield.h create mode 100644 include/ctf/ctf-types.h create mode 100644 lgpl-2.1.txt create mode 100644 lib/types/enum.c create mode 100644 lib/types/float.c create mode 100644 lib/types/integer.c create mode 100644 lib/types/string.c create mode 100644 lib/types/struct.c create mode 100644 lib/types/types.c create mode 100644 mit-license.txt create mode 100644 std-ext-lib.txt create mode 100644 tests/test-bitfield.c diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..3cefc179 --- /dev/null +++ b/LICENSE @@ -0,0 +1,26 @@ +Common Trace Format - Licensing +Mathieu Desnoyers +September 26, 2010 + + +* LGPLv2.1 + +The library part is distributed under LGPLv2.1 or later. See lgpl-2.1.txt for +details. This applies to all files, except when otherwise specified within the +files. + + +* MIT license : + +A MIT license that is intended to allow use in both free and proprietary +software is applied to some headers. See mit-license.txt for details. + +This license applies to : + +bitfield.h + + +* GPLv2 + +Library test code is distributed under the GPLv2 license, as specified in the +per-file license. See gpl-2.0.txt for details. diff --git a/gpl-2.0.txt b/gpl-2.0.txt new file mode 100644 index 00000000..d511905c --- /dev/null +++ b/gpl-2.0.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/include/ctf/align.h b/include/ctf/align.h new file mode 100644 index 00000000..ad4a0134 --- /dev/null +++ b/include/ctf/align.h @@ -0,0 +1,52 @@ +#ifndef _CTF_ALIGN_H +#define _CTF_ALIGN_H + +#include + +#define ALIGN(x, a) __ALIGN_MASK(x, (typeof(x))(a) - 1) +#define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask)) +#define PTR_ALIGN(p, a) ((typeof(p)) ALIGN((unsigned long) (p), a)) +#define ALIGN_FLOOR(x, a) __ALIGN_FLOOR_MASK(x, (typeof(x)) (a) - 1) +#define __ALIGN_FLOOR_MASK(x, mask) ((x) & ~(mask)) +#define PTR_ALIGN_FLOOR(p, a) \ + ((typeof(p)) ALIGN_FLOOR((unsigned long) (p), a)) +#define IS_ALIGNED(x, a) (((x) & ((typeof(x)) (a) - 1)) == 0) + +/* + * Align pointer on natural object alignment. + */ +#define object_align(obj) PTR_ALIGN(obj, __alignof__(*(obj))) +#define object_align_floor(obj) PTR_ALIGN_FLOOR(obj, __alignof__(*(obj))) + +/** + * offset_align - Calculate the offset needed to align an object on its natural + * alignment towards higher addresses. + * @align_drift: object offset from an "alignment"-aligned address. + * @alignment: natural object alignment. Must be non-zero, power of 2. + * + * Returns the offset that must be added to align towards higher + * addresses. + */ +#define offset_align(align_drift, alignment) \ + ({ \ + MAYBE_BUILD_BUG_ON((alignment) == 0 \ + || ((alignment) & ((alignment) - 1))); \ + (((alignment) - (align_drift)) & ((alignment) - 1)); \ + }) + +/** + * offset_align_floor - Calculate the offset needed to align an object + * on its natural alignment towards lower addresses. + * @align_drift: object offset from an "alignment"-aligned address. + * @alignment: natural object alignment. Must be non-zero, power of 2. + * + * Returns the offset that must be substracted to align towards lower addresses. + */ +#define offset_align_floor(align_drift, alignment) \ + ({ \ + MAYBE_BUILD_BUG_ON((alignment) == 0 \ + || ((alignment) & ((alignment) - 1))); \ + (((align_drift) - (alignment)) & ((alignment) - 1); \ + }) + +#endif /* _CTF_ALIGN_H */ diff --git a/include/ctf/bitfield.h b/include/ctf/bitfield.h new file mode 100644 index 00000000..1cf7c1a2 --- /dev/null +++ b/include/ctf/bitfield.h @@ -0,0 +1,349 @@ +#ifndef _CTF_BITFIELD_H +#define _CTF_BITFIELD_H + +/* + * Common Trace Format + * + * Bitfields read/write functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + +#include /* C99 5.2.4.2 Numerical limits */ +#include /* C99 5.2.4.2 Numerical limits */ +#include /* Non-standard BIG_ENDIAN, LITTLE_ENDIAN, BYTE_ORDER */ +#include + +/* We can't shift a int from 32 bit, >> 32 on int is undefined */ +#define _ctf_piecewise_rshift(v, shift) \ +({ \ + unsigned long sb = (shift) / (sizeof(v) * CHAR_BIT - 1); \ + unsigned long final = (shift) % (sizeof(v) * CHAR_BIT - 1); \ + typeof(v) _v = (v); \ + \ + for (; sb; sb--) \ + _v >>= sizeof(v) * CHAR_BIT - 1; \ + _v >>= final; \ +}) + +/* + * ctf_bitfield_write - write integer to a bitfield in native endianness + * + * Save integer to the bitfield, which starts at the "start" bit, has "len" + * bits. + * The inside of a bitfield is from high bits to low bits. + * Uses native endianness. + * For unsigned "v", pad MSB with 0 if bitfield is larger than v. + * For signed "v", sign-extend v if bitfield is larger than v. + * + * On little endian, bytes are placed from the less significant to the most + * significant. Also, consecutive bitfields are placed from lower bits to higher + * bits. + * + * On big endian, bytes are places from most significant to less significant. + * Also, consecutive bitfields are placed from higher to lower bits. + */ + +#define _ctf_bitfield_write_le(ptr, _start, _length, _v) \ +do { \ + typeof(*(ptr)) mask, cmask; \ + unsigned long start = (_start), length = (_length); \ + typeof(_v) v = (_v); \ + unsigned long start_unit, end_unit, this_unit; \ + unsigned long end, cshift; /* cshift is "complement shift" */ \ + unsigned long ts = sizeof(typeof(*(ptr))) * CHAR_BIT; /* type size */ \ + \ + if (!length) \ + break; \ + \ + end = start + length; \ + start_unit = start / ts; \ + end_unit = (end + (ts - 1)) / ts; \ + \ + /* Trim v high bits */ \ + if (length < sizeof(v) * CHAR_BIT) \ + v &= ~((~(typeof(v)) 0) << length); \ + \ + /* We can now append v with a simple "or", shift it piece-wise */ \ + this_unit = start_unit; \ + if (start_unit == end_unit - 1) { \ + mask = ~((~(typeof(*(ptr))) 0) << (start % ts)); \ + if (end % ts) \ + mask |= (~(typeof(*(ptr))) 0) << (end % ts); \ + cmask = (typeof(*(ptr))) v << (start % ts); \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + break; \ + } \ + if (start % ts) { \ + cshift = start % ts; \ + mask = ~((~(typeof(*(ptr))) 0) << cshift); \ + cmask = (typeof(*(ptr))) v << cshift; \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + v = _ctf_piecewise_rshift(v, ts - cshift); \ + start += ts - cshift; \ + this_unit++; \ + } \ + for (; this_unit < end_unit - 1; this_unit++) { \ + (ptr)[this_unit] = (typeof(*(ptr))) v; \ + v = _ctf_piecewise_rshift(v, ts); \ + start += ts; \ + } \ + if (end % ts) { \ + mask = (~(typeof(*(ptr))) 0) << (end % ts); \ + cmask = (typeof(*(ptr))) v; \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + } else \ + (ptr)[this_unit] = (typeof(*(ptr))) v; \ +} while (0) + +#define _ctf_bitfield_write_be(ptr, _start, _length, _v) \ +do { \ + typeof(_v) v = (_v); \ + unsigned long start = _start, length = _length; \ + unsigned long start_unit, end_unit, this_unit; \ + unsigned long end, cshift; /* cshift is "complement shift" */ \ + typeof(*(ptr)) mask, cmask; \ + unsigned long ts = sizeof(typeof(*(ptr))) * CHAR_BIT; /* type size */ \ + \ + if (!length) \ + break; \ + \ + end = start + length; \ + start_unit = start / ts; \ + end_unit = (end + (ts - 1)) / ts; \ + \ + /* Trim v high bits */ \ + if (length < sizeof(v) * CHAR_BIT) \ + v &= ~((~(typeof(v)) 0) << length); \ + \ + /* We can now append v with a simple "or", shift it piece-wise */ \ + this_unit = end_unit - 1; \ + if (start_unit == end_unit - 1) { \ + mask = ~((~(typeof(*(ptr))) 0) << ((ts - (end % ts)) % ts)); \ + if (start % ts) \ + mask |= (~((typeof(*(ptr))) 0)) << (ts - (start % ts)); \ + cmask = (typeof(*(ptr))) v << ((ts - (end % ts)) % ts); \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + break; \ + } \ + if (end % ts) { \ + cshift = end % ts; \ + mask = ~((~(typeof(*(ptr))) 0) << (ts - cshift)); \ + cmask = (typeof(*(ptr))) v << (ts - cshift); \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + v = _ctf_piecewise_rshift(v, cshift); \ + end -= cshift; \ + this_unit--; \ + } \ + for (; (long)this_unit >= (long)start_unit + 1; this_unit--) { \ + (ptr)[this_unit] = (typeof(*(ptr))) v; \ + v = _ctf_piecewise_rshift(v, ts); \ + end -= ts; \ + } \ + if (start % ts) { \ + mask = (~(typeof(*(ptr))) 0) << (ts - (start % ts)); \ + cmask = (typeof(*(ptr))) v; \ + (ptr)[this_unit] &= mask; \ + (ptr)[this_unit] |= cmask; \ + } else \ + (ptr)[this_unit] = (typeof(*(ptr))) v; \ +} while (0) + +/* + * ctf_bitfield_write - write integer to a bitfield in native endianness + * ctf_bitfield_write_le - write integer to a bitfield in little endian + * ctf_bitfield_write_be - write integer to a bitfield in big endian + */ + +#if (BYTE_ORDER == LITTLE_ENDIAN) + +#define ctf_bitfield_write(ptr, _start, _length, _v) \ + _ctf_bitfield_write_le(ptr, _start, _length, _v) + +#define ctf_bitfield_write_le(ptr, _start, _length, _v) \ + _ctf_bitfield_write_le(ptr, _start, _length, _v) + +#define ctf_bitfield_write_be(ptr, _start, _length, _v) \ + _ctf_bitfield_write_be((uint8_t *) (ptr), _start, _length, _v) + +#elif (BYTE_ORDER == BIG_ENDIAN) + +#define ctf_bitfield_write(ptr, _start, _length, _v) \ + _ctf_bitfield_write_be(ptr, _start, _length, _v) + +#define ctf_bitfield_write_le(ptr, _start, _length, _v) \ + _ctf_bitfield_write_le((uint8_t *) (ptr), _start, _length, _v) + +#define ctf_bitfield_write_be(ptr, _start, _length, _v) \ + _ctf_bitfield_write_be(ptr, _start, _length, _v) + +#else /* (BYTE_ORDER == PDP_ENDIAN) */ + +#error "Byte order not supported" + +#endif + +#if 0 +#define _ctf_bitfield_read_le(ptr, _start, _length, _vptr) \ +do { \ + typeof(_vptr) vptr = (_vptr); \ + unsigned long start = _start, length = _length; \ + unsigned long start_unit, end_unit, this_unit; \ + unsigned long end, cshift; /* cshift is "complement shift" */ \ + typeof(*(ptr)) mask, cmask; \ + unsigned long ts = sizeof(typeof(*(ptr))) * CHAR_BIT; /* type size */ \ + \ + if (!length) \ + break; \ + \ + end = start + length; \ + start_unit = start / ts; \ + end_unit = (end + (ts - 1)) / ts; \ +} while (0) + +#endif //0 + +/* + * Read a bitfield byte-wise. This function is arch-agnostic. + */ + +static inline +uint64_t _ctf_bitfield_read_64(const unsigned char *ptr, + unsigned long start, unsigned long len, + int byte_order, int signedness) +{ + long start_unit, end_unit, this_unit; + unsigned long end, cshift; /* cshift is "complement shift" */ + unsigned long ts = sizeof(unsigned char) * CHAR_BIT; + unsigned char mask, cmask; + uint64_t v = 0; + + if (!len) + return 0; + end = start + len; + start_unit = start / ts; + end_unit = (end + (ts - 1)) / ts; + + /* + * We can now fill v piece-wise, from lower bits to upper bits. + * We read the bitfield in the opposite direction it was written. + */ + switch (byte_order) { + case LITTLE_ENDIAN: + this_unit = end_unit - 1; + if (signedness) { + if (ptr[this_unit] & (1U << ((end % ts ? : ts) - 1))) + v = ~(uint64_t) 0; + } + if (start_unit == end_unit - 1) { + mask = (~(unsigned char) 0) << (end % ts ? : ts); + mask |= ~((~(unsigned char) 0) << (start % ts)); + cmask = ptr[this_unit]; + cmask &= ~mask; + cmask >>= (start % ts); + v <<= end - start; + v |= cmask; + break; + } + if (end % ts) { + cshift = (end % ts ? : ts); + mask = (~(unsigned char) 0) << cshift; + cmask = ptr[this_unit]; + cmask &= ~mask; + v <<= cshift; + v |= (uint64_t) cmask; + end -= cshift; + this_unit--; + } + for (; this_unit >= start_unit + 1; this_unit--) { + v <<= ts; + v |= (uint64_t) ptr[this_unit]; + end -= ts; + } + if (start % ts) { + cmask = ptr[this_unit] >> (start % ts); + v <<= ts - (start % ts); + v |= (uint64_t) cmask; + } else { + v <<= ts; + v |= (uint64_t) ptr[this_unit]; + } + break; + case BIG_ENDIAN: + this_unit = start_unit; + if (signedness) { + if (ptr[this_unit] & (1U << (ts - (start % ts) - 1))) + v = ~(uint64_t) 0; + } + if (start_unit == end_unit - 1) { + mask = (~(unsigned char) 0) << (ts - (start % ts)); + mask |= ~((~(unsigned char) 0) << ((ts - (end % ts)) % ts)); + cmask = ptr[this_unit]; + cmask &= ~mask; + cmask >>= (ts - (end % ts)) % ts; + v <<= end - start; + v |= (uint64_t) cmask; + break; + } + if (start % ts) { + mask = (~(unsigned char) 0) << (ts - (start % ts)); + cmask = ptr[this_unit]; + cmask &= ~mask; + v <<= ts - (start % ts); + v |= (uint64_t) cmask; + start += ts - (start % ts); + this_unit++; + } + for (; this_unit < end_unit - 1; this_unit++) { + v <<= ts; + v |= (uint64_t) ptr[this_unit]; + start += ts; + } + if (end % ts) { + cmask = ptr[this_unit]; + cmask >>= (ts - (end % ts)) % ts; + v <<= (end % ts); + v |= (uint64_t) cmask; + } else { + v <<= ts; + v |= (uint64_t) ptr[this_unit]; + } + break; + default: + assert(0); /* TODO: support PDP_ENDIAN */ + } + return v; +} + +static inline +uint64_t ctf_bitfield_unsigned_read(const uint8_t *ptr, + unsigned long start, unsigned long len, + int byte_order) +{ + return (uint64_t) _ctf_bitfield_read_64(ptr, start, len, byte_order, 0); +} + +static inline +int64_t ctf_bitfield_signed_read(const uint8_t *ptr, + unsigned long start, unsigned long len, + int byte_order) +{ + return (int64_t) _ctf_bitfield_read_64(ptr, start, len, byte_order, 1); +} + +#endif /* _CTF_BITFIELD_H */ diff --git a/include/ctf/compiler.h b/include/ctf/compiler.h new file mode 100644 index 00000000..eadef213 --- /dev/null +++ b/include/ctf/compiler.h @@ -0,0 +1,6 @@ +#ifndef _CTF_COMPILER_H +#define _CTF_COMPILER_H + +#define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)])) + +#endif /* _CTF_COMPILER_H */ diff --git a/include/ctf/ctf-types-bitfield.h b/include/ctf/ctf-types-bitfield.h new file mode 100644 index 00000000..4657a28f --- /dev/null +++ b/include/ctf/ctf-types-bitfield.h @@ -0,0 +1,56 @@ +#ifndef _CTF_TYPES_BITFIELD_H +#define _CTF_TYPES_BITFIELD_H + +/* + * Common Trace Format + * + * Bitfields read/write functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include + +/* + * ctf_bitfield_unsigned_read and ctf_bitfield_signed_read are defined by + * bitfield.h. + * + * The write primitives below are provided as wrappers over + * ctf_bitfield_write_le and ctf_bitfield_write_be to specify per-byte write of + * signed/unsigned integers through a standard API. + */ + +static inline +size_t ctf_bitfield_unsigned_write(uint8_t *ptr, + unsigned long start, unsigned long len, + int byte_order, uint64_t v) +{ + if (!ptr) + goto end; + if (byte_order == LITTLE_ENDIAN) + ctf_bitfield_write_le(ptr, start, len, v); + else + ctf_bitfield_write_be(ptr, start, len, v); +end: + return len; +} + +static inline +size_t ctf_bitfield_signed_write(uint8_t *ptr, + unsigned long start, unsigned long len, + int byte_order, int64_t v) +{ + if (!ptr) + goto end; + if (byte_order == LITTLE_ENDIAN) + ctf_bitfield_write_le(ptr, start, len, v); + else + ctf_bitfield_write_be(ptr, start, len, v); +end: + return len; +} + +#endif /* _CTF_TYPES_BITFIELD_H */ diff --git a/include/ctf/ctf-types.h b/include/ctf/ctf-types.h new file mode 100644 index 00000000..79a20213 --- /dev/null +++ b/include/ctf/ctf-types.h @@ -0,0 +1,56 @@ +#ifndef _CTF_TYPES_H +#define _CTF_TYPES_H + +/* + * Common Trace Format + * + * Type header + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include + +/* + * All write primitives,(as well as read for dynamically sized entities, can + * receive a NULL ptr/dest parameter. In this case, no write is performed, but + * the size is returned. + */ + +uint64_t ctf_uint_read(const uint8_t *ptr, int byte_order, size_t len); +int64_t ctf_int_read(const uint8_t *ptr, int byte_order, size_t len); +size_t ctf_uint_write(uint8_t *ptr, int byte_order, size_t len, uint64_t v); +size_t ctf_int_write(uint8_t *ptr, int byte_order, size_t len, int64_t v); + +/* + * ctf-types-bitfield.h declares: + * + * ctf_bitfield_unsigned_read + * ctf_bitfield_signed_read + * ctf_bitfield_unsigned_write + * ctf_bitfield_signed_write + */ +#include + +double ctf_float_read(const uint8_t *ptr, int byte_order, size_t len); +size_t ctf_float_write(uint8_t *ptr, int byte_order, size_t len, double v); + +size_t ctf_string_copy(char *dest, const char *src); + +/* + * A GQuark can be translated to/from strings with g_quark_from_string() and + * g_quark_to_string(). + */ +GQuark ctf_enum_uint_to_quark(const struct enum_table *table, uint64_t v); +GQuark ctf_enum_int_to_quark(const struct enum_table *table, uint64_t v); +uint64_t ctf_enum_quark_to_uint(size_t len, int byte_order, GQuark q); +int64_t ctf_enum_quark_to_int(size_t len, int byte_order, GQuark q); +void ctf_enum_signed_insert(struct enum_table *table, int64_t v, GQuark q); +void ctf_enum_unsigned_insert(struct enum_table *table, uint64_t v, GQuark q); +struct enum_table *ctf_enum_new(void); +void ctf_enum_destroy(struct enum_table *table); + +#endif /* _CTF_TYPES_H */ diff --git a/lgpl-2.1.txt b/lgpl-2.1.txt new file mode 100644 index 00000000..602bfc94 --- /dev/null +++ b/lgpl-2.1.txt @@ -0,0 +1,504 @@ + 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. + + GNU LESSER GENERAL PUBLIC LICENSE + 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. + + + Copyright (C) + + 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. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/lib/types/enum.c b/lib/types/enum.c new file mode 100644 index 00000000..cae15478 --- /dev/null +++ b/lib/types/enum.c @@ -0,0 +1,162 @@ +/* + * Common Trace Format + * + * Enumeration mapping strings (quarks) from/to integers. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include +#include + +struct enum_table { + GHashTable *value_to_quark; /* Tuples (value, GQuark) */ + GHashTable *quark_to_value; /* Tuples (GQuark, value) */ +}; + +#if (__WORDSIZE == 32) +GQuark enum_uint_to_quark(const struct enum_table *table, uint64_t v) +{ + gconstpointer q = g_hash_table_lookup(table->value_to_quark, &v); + return (GQuark) (unsigned long) q; +} + +GQuark enum_int_to_quark(const struct enum_table *table, uint64_t v) +{ + gconstpointer q = g_hash_table_lookup(table->value_to_quark, &v); + return (GQuark) (unsigned long) q; +} + +uint64_t enum_quark_to_uint(size_t len, int byte_order, GQuark q) +{ + gconstpointer v = g_hash_table_lookup(table->quark_to_value, + (gconstpointer) q); + return *(const uint64_t *) v; +} + +int64_t enum_quark_to_int(size_t len, int byte_order, GQuark q) +{ + gconstpointer v = g_hash_table_lookup(table->quark_to_value, + (gconstpointer) q); + return *(const int64_t *) v; +} + +guint enum_val_hash(gconstpointer key) +{ + int64_t ukey = *(const int64_t *)key; + + return (guint)ukey ^ (guint)(ukey >> 32); +} + +gboolean enum_val_equal(gconstpointer a, gconstpointer b) +{ + int64_t ua = *(const int64_t *)a; + int64_t ub = *(const int64_t *)b; + + return ua == ub; +} + +void enum_val_free(void *ptr) +{ + g_free(ptr); +} + +void enum_signed_insert(struct enum_table *table, int64_t v, GQuark q) +{ + int64_t *valuep = g_new(int64_t, 1); + + g_hash_table_insert(table->value_to_quark, valuep, + (gpointer) (unsigned long) q); + g_hash_table_insert(table->quark_to_value, (gpointer) (unsigned long) q, + valuep); +} + +void enum_unsigned_insert(struct enum_table *table, uint64_t v, GQuark q) +{ + uint64_t *valuep = g_new(uint64_t, 1); + + g_hash_table_insert(table->value_to_quark, valuep, + (gpointer) (unsigned long) q); + g_hash_table_insert(table->quark_to_value, (gpointer) (unsigned long) q, + valuep); +} +#else /* __WORDSIZE != 32 */ +GQuark enum_uint_to_quark(const struct enum_table *table, uint64_t v) +{ + gconstpointer q = g_hash_table_lookup(table->value_to_quark, + (gconstpointer) v); + return (GQuark) (unsigned long) q; +} + +GQuark enum_int_to_quark(const struct enum_table *table, uint64_t v) +{ + gconstpointer q = g_hash_table_lookup(table->value_to_quark, + (gconstpointer) v); + return (GQuark) (unsigned long) q; +} + +uint64_t enum_quark_to_uint(size_t len, int byte_order, GQuark q) +{ + gconstpointer v = g_hash_table_lookup(table->quark_to_value, + (gconstpointer) (unsigned long) q); + return *(const uint64_t *) v; +} + +int64_t enum_quark_to_int(size_t len, int byte_order, GQuark q) +{ + gconstpointer v = g_hash_table_lookup(table->quark_to_value, + (gconstpointer) (unsigned long) q); + return *(const int64_t *) v; +} + +guint enum_val_hash(gconstpointer key) +{ + return g_direct_hash(key); +} + +gboolean enum_val_equal(gconstpointer a, gconstpointer b) +{ + return g_direct_equal(a, b); +} + +void enum_val_free(void *ptr) +{ +} + +void enum_signed_insert(struct enum_table *table, int64_t v, GQuark q) +{ + g_hash_table_insert(table->value_to_quark, (gpointer) v, + (gpointer) (unsigned long) q); + g_hash_table_insert(table->quark_to_value, (gpointer) (unsigned long) q, + valuep); +} + +void enum_unsigned_insert(struct enum_table *table, uint64_t v, GQuark q) +{ + g_hash_table_insert(table->value_to_quark, (gpointer) v, + (gpointer) (unsigned long) q); + g_hash_table_insert(table->quark_to_value, (gpointer) (unsigned long) q, + valuep); +} +#endif /* __WORDSIZE != 32 */ + +struct enum_table *enum_new(void) +{ + struct enum_table *table; + + table = g_new(struct enum_table, 1); + table->value_to_quark = g_hash_table_new_full(enum_val_hash, + enum_val_equal, + enum_val_free, NULL); + table->quark_to_value = g_hash_table_new(g_direct_hash, g_direct_equal); +} + +void enum_destroy(struct enum_table *table) +{ + g_hash_table_destroy(table->value_to_quark); + g_hash_table_destroy(table->quark_to_value); + g_free(table); +} diff --git a/lib/types/float.c b/lib/types/float.c new file mode 100644 index 00000000..e3311cd7 --- /dev/null +++ b/lib/types/float.c @@ -0,0 +1,220 @@ +/* + * Common Trace Format + * + * Floating point read/write functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Reference: ISO C99 standard 5.2.4 + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include +#include + +/* + * Aliasing float/double and unsigned long is not strictly permitted by strict + * aliasing, but in practice type prunning is well supported, and this permits + * us to use per-word read/writes rather than per-byte. + */ + +#if defined(__GNUC__) || defined(__MINGW32__) || defined(_MSC_VER) +#define HAS_TYPE_PRUNING +#endif + +union floatIEEE754 { + float v; +#ifdef HAS_TYPE_PRUNING + unsigned long bits[(sizeof(float) + sizeof(unsigned long) - 1) / sizeof(unsigned long)]; +#else + unsigned char bits[sizeof(float)]; +#endif +}; + +union doubleIEEE754 { + double v; +#ifdef HAS_TYPE_PRUNING + unsigned long bits[(sizeof(double) + sizeof(unsigned long) - 1) / sizeof(unsigned long)]; +#else + unsigned char bits[sizeof(double)]; +#endif +}; + +double float_read(const uint8_t *ptr, size_t len, int byte_order) +{ + int rbo = (byte_order != __FLOAT_WORD_ORDER); /* reverse byte order */ + + switch (len) { + case 32: + { + union floatIEEE754 u; + uint32_t tmp; + + if (!rbo) + return (double) *(const float *) ptr; + /* + * Need to reverse byte order. Read the opposite from our + * architecture. + */ + if (__FLOAT_WORD_ORDER == LITTLE_ENDIAN) { + /* Read big endian */ + tmp = bitfield_unsigned_read(ptr, 0, 1, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 31, 1, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 1, 8, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 23, 8, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 9, 23, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 23, LITTLE_ENDIAN, + tmp); + } else { + /* Read little endian */ + tmp = bitfield_unsigned_read(ptr, 31, 1, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 1, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 23, 8, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 1, 8, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 0, 23, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 9, 23, BIG_ENDIAN, + tmp); + } + return (double) u.v; + } + case 64: + { + union doubleIEEE754 u; + uint64_t tmp; + + if (!rbo) + return (double) *(const double *) ptr; + /* + * Need to reverse byte order. Read the opposite from our + * architecture. + */ + if (__FLOAT_WORD_ORDER == LITTLE_ENDIAN) { + /* Read big endian */ + tmp = bitfield_unsigned_read(ptr, 0, 1, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 63, 1, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 1, 11, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 52, 11, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 12, 52, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 52, LITTLE_ENDIAN, + tmp); + } else { + /* Read little endian */ + tmp = bitfield_unsigned_read(ptr, 63, 1, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 1, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 52, 11, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 1, 11, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 0, 52, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 12, 52, BIG_ENDIAN, + tmp); + } + return u.v; + } + default: + printf("float read unavailable for size %u\n", len); + assert(0); + } +} + +size_t float_write(uint8_t *ptr, size_t len, int byte_order, double v) +{ + int rbo = (byte_order != __FLOAT_WORD_ORDER); /* reverse byte order */ + + if (!ptr) + goto end; + + switch (len) { + case 32: + { + union floatIEEE754 u; + uint32_t tmp; + + if (!rbo) { + *(float *) ptr = (float) v; + break; + } + u.v = v; + /* + * Need to reverse byte order. Write the opposite from our + * architecture. + */ + if (__FLOAT_WORD_ORDER == LITTLE_ENDIAN) { + /* Write big endian */ + tmp = bitfield_unsigned_read(ptr, 31, 1, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 1, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 23, 8, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 1, 8, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 0, 23, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 9, 23, BIG_ENDIAN, + tmp); + } else { + /* Write little endian */ + tmp = bitfield_unsigned_read(ptr, 0, 1, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 31, 1, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 1, 8, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 23, 8, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 9, 23, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 23, LITTLE_ENDIAN, + tmp); + } + break; + } + case 64: + { + union doubleIEEE754 u; + uint64_t tmp; + + if (!rbo) { + *(double *) ptr = v; + break; + } + u.v = v; + /* + * Need to reverse byte order. Write the opposite from our + * architecture. + */ + if (__FLOAT_WORD_ORDER == LITTLE_ENDIAN) { + /* Write big endian */ + tmp = bitfield_unsigned_read(ptr, 63, 1, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 1, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 52, 11, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 1, 11, BIG_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 0, 52, LITTLE_ENDIAN); + bitfield_unsigned_write(&u.bits, 12, 52, BIG_ENDIAN, + tmp); + } else { + /* Write little endian */ + tmp = bitfield_unsigned_read(ptr, 0, 1, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 63, 1, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 1, 11, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 52, 11, LITTLE_ENDIAN, + tmp); + tmp = bitfield_unsigned_read(ptr, 12, 52, BIG_ENDIAN); + bitfield_unsigned_write(&u.bits, 0, 52, LITTLE_ENDIAN, + tmp); + } + break; + } + default: + printf("float write unavailable for size %u\n", len); + assert(0); + } +end: + return len; +} diff --git a/lib/types/integer.c b/lib/types/integer.c new file mode 100644 index 00000000..2310ad30 --- /dev/null +++ b/lib/types/integer.c @@ -0,0 +1,146 @@ +/* + * Common Trace Format + * + * Integers read/write functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include +#include +#include + +uint64_t uint_read(const uint8_t *ptr, size_t len, int byte_order) +{ + int rbo = (byte_order != BYTE_ORDER); /* reverse byte order */ + + switch (len) { + case 8: + { + uint8_t v; + + v = *(const uint8_t *)ptr; + return v; + } + case 16: + { + uint16_t v; + + v = *(const uint16_t *)ptr; + return rbo ? GUINT16_SWAP_LE_BE(v) : v; + } + case 32: + { + uint32_t v; + + v = *(const uint32_t *)ptr; + return rbo ? GUINT32_SWAP_LE_BE(v) : v; + } + case 64: + { + uint64_t v; + + v = *(const uint64_t *)ptr; + return rbo ? GUINT64_SWAP_LE_BE(v) : v; + } + default: + assert(0); + } +} + +int64_t int_read(const uint8_t *ptr, size_t len, int byte_order) +{ + int rbo = (byte_order != BYTE_ORDER); /* reverse byte order */ + + switch (len) { + case 8: + { + int8_t v; + + v = *(const int8_t *)ptr; + return v; + } + case 16: + { + int16_t v; + + v = *(const int16_t *)ptr; + return rbo ? GUINT16_SWAP_LE_BE(v) : v; + } + case 32: + { + int32_t v; + + v = *(const int32_t *)ptr; + return rbo ? GUINT32_SWAP_LE_BE(v) : v; + } + case 64: + { + int64_t v; + + v = *(const int64_t *)ptr; + return rbo ? GUINT64_SWAP_LE_BE(v) : v; + } + default: + assert(0); + } +} + +size_t uint_write(uint8_t *ptr, size_t len, int byte_order, uint64_t v) +{ + int rbo = (byte_order != BYTE_ORDER); /* reverse byte order */ + + if (!ptr) + goto end; + + switch (len) { + case 8: *(uint8_t *)ptr = (uint8_t) v; + break; + case 16: + *(uint16_t *)ptr = rbo ? GUINT16_SWAP_LE_BE((uint16_t) v) : + (uint16_t) v; + break; + case 32: + *(uint32_t *)ptr = rbo ? GUINT32_SWAP_LE_BE((uint32_t) v) : + (uint32_t) v; + break; + case 64: + *(uint64_t *)ptr = rbo ? GUINT64_SWAP_LE_BE(v) : v; + break; + default: + assert(0); + } +end: + return len; +} + +size_t int_write(uint8_t *ptr, size_t len, int byte_order, int64_t v) +{ + int rbo = (byte_order != BYTE_ORDER); /* reverse byte order */ + + if (!ptr) + goto end; + + switch (len) { + case 8: *(int8_t *)ptr = (int8_t) v; + break; + case 16: + *(int16_t *)ptr = rbo ? GUINT16_SWAP_LE_BE((int16_t) v) : + (int16_t) v; + break; + case 32: + *(int32_t *)ptr = rbo ? GUINT32_SWAP_LE_BE((int32_t) v) : + (int32_t) v; + break; + case 64: + *(int64_t *)ptr = rbo ? GUINT64_SWAP_LE_BE(v) : v; + break; + default: + assert(0); + } +end: + return len; +} diff --git a/lib/types/string.c b/lib/types/string.c new file mode 100644 index 00000000..c61bfcdc --- /dev/null +++ b/lib/types/string.c @@ -0,0 +1,23 @@ +/* + * Common Trace Format + * + * Strings read/write functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include + +size_t string_copy(char *dest, const char *src) +{ + size_t len = strlen(src) + 1; + + if (!dest) + goto end; + strcpy(dest, src); +end: + return len * 8; +} diff --git a/lib/types/struct.c b/lib/types/struct.c new file mode 100644 index 00000000..d2d59cf4 --- /dev/null +++ b/lib/types/struct.c @@ -0,0 +1,14 @@ +/* + * Common Trace Format + * + * Structure write/access functions. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include + + diff --git a/lib/types/types.c b/lib/types/types.c new file mode 100644 index 00000000..545bdb91 --- /dev/null +++ b/lib/types/types.c @@ -0,0 +1,17 @@ +/* + * Common Trace Format + * + * Types registry. + * + * Copyright 2010 - Mathieu Desnoyers + * + * Dual LGPL v2.1/GPL v2 license. + */ + +#include +#include + +struct type { + GQuark name; + size_t len; /* type length, in bits */ +}; diff --git a/mit-license.txt b/mit-license.txt new file mode 100644 index 00000000..5ea7f89a --- /dev/null +++ b/mit-license.txt @@ -0,0 +1,19 @@ +Copyright (c) ... + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/std-ext-lib.txt b/std-ext-lib.txt new file mode 100644 index 00000000..a21d23ec --- /dev/null +++ b/std-ext-lib.txt @@ -0,0 +1,72 @@ +Common Trace Format - Standards, Extensions and Libraries +Mathieu Desnoyers +September 26, 2010 + +This document describes the CTF library dependencies on standards, extensions +and libraries. + + +** Standards + +* C99 + +This library is C99 compliant. A non-documented non-compliance should be +reported as a bug. See the ISO/IEC 9899:TC2 publication: + + http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf + + +* IEEE 754-2008 + +The IEEE 754-2008 standard is used for binary floating point arithmetic +representation. See: + + http://grouper.ieee.org/groups/754/ + + +* GNU/C extensions + +This library uses some widely GNU/C extensions widely adopted by compilers. +For detail, see: + + http://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html#C-Extensions + + + +** Non-standard Dependencies + +In some cases, standards do not provide the required primitives to write +portable code; these are listed here. + + +* Non-standard endian.h + +endian.h is used to provide the following definitions: + +#define LITTLE_ENDIAN 1234 +#define BIG_ENDIAN 4321 +#define BYTE_ORDER /* Your architecture: BIG_ENDIAN or LITTLE_ENDIAN */ + + +* Bitfields + +The ISO/IEC 9899 standard leaves bitfields implementation defined, which is +unacceptable for portability of this library. Section 6.7.2.1 - "Structure and +union specifiers", Semantic 10 specifically indicates that padding and order of +bit-fields allocation within a unit is implementation-defined. + +This is why this library provides the bitfield.h header (under the MIT license), +which specifies bitfields write primitives that uses the same field order as the +GNU/C compiler, but does not require any padding for fields spreading across +units. This is therefore a superset of the GNU/C bitfields, which can be dealt +with by detecting C structure padding manually given the bit offset and +bit-field size as well as the unit size. + + +** Libraries + +* The GLib library of C routines + +The library glib 2 is used for its basic data structures. See + + http://library.gnome.org/devel/glib/2.24/glib-data-types.html diff --git a/tests/test-bitfield.c b/tests/test-bitfield.c new file mode 100644 index 00000000..2fc2e3a0 --- /dev/null +++ b/tests/test-bitfield.c @@ -0,0 +1,372 @@ +/* + * test-bitfield.c + * + * Common Trace Format - bitfield test program + * + * Copyright February 2009 - Mathieu Desnoyers + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#define _GNU_SOURCE +#include +#include + +unsigned int glob; + +/* + * This function is only declared to show the size of a bitfield write in + * objdump. + */ +void fct(void) +{ + ctf_bitfield_write(&glob, 12, 15, 0x12345678); +} + +/* Test array size, in bytes */ +#define TEST_LEN 128 +#define NR_TESTS 10 + +unsigned int srcrand; + +#if defined(__i386) || defined(__x86_64) + +static inline int fls(int x) +{ + int r; + asm("bsrl %1,%0\n\t" + "cmovzl %2,%0" + : "=&r" (r) : "rm" (x), "rm" (-1)); + return r + 1; +} + +#elif defined(__PPC__) + +static __inline__ int fls(unsigned int x) +{ + int lz; + + asm ("cntlzw %0,%1" : "=r" (lz) : "r" (x)); + return 32 - lz; +} + +#else + +static int fls(unsigned int x) +{ + int r = 32; + + if (!x) + return 0; + if (!(x & 0xFFFF0000U)) { + x <<= 16; + r -= 16; + } + if (!(x & 0xFF000000U)) { + x <<= 8; + r -= 8; + } + if (!(x & 0xF0000000U)) { + x <<= 4; + r -= 4; + } + if (!(x & 0xC0000000U)) { + x <<= 2; + r -= 2; + } + if (!(x & 0x80000000U)) { + x <<= 1; + r -= 1; + } + return r; +} + +#endif + +static void print_byte_array(const unsigned char *c, unsigned long len) +{ + unsigned long i; + + for (i = 0; i < len; i++) { + printf("0x%X", c[i]); + if (i != len - 1) + printf(" "); + } + printf("\n"); +} + +static void init_byte_array(unsigned char *c, + unsigned long len, + unsigned char val) +{ + unsigned long i; + + for (i = 0; i < len; i++) + c[i] = val; +} + +int run_test_unsigned(void) +{ + unsigned int src, nrbits; + union { + unsigned char c[TEST_LEN]; + unsigned short s[TEST_LEN/sizeof(unsigned short)]; + unsigned int i[TEST_LEN/sizeof(unsigned int)]; + unsigned long l[TEST_LEN/sizeof(unsigned long)]; + unsigned long long ll[TEST_LEN/sizeof(unsigned long long)]; + } target; + uint64_t readval; + unsigned int s, l; + int err = 0; + + printf("Running unsigned test with 0x%X\n", srcrand); + + src = srcrand; + nrbits = fls(src); + + for (s = 0; s < CHAR_BIT * TEST_LEN; s++) { + for (l = nrbits; l < (CHAR_BIT * TEST_LEN) - s; l++) { + init_byte_array(target.c, TEST_LEN, 0xFF); + ctf_bitfield_write(target.c, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 0); + if (readval != src) { + printf("Error (bytewise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0xFF); + ctf_bitfield_write(target.s, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 0); + if (readval != src) { + printf("Error (shortwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0xFF); + ctf_bitfield_write(target.i, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 0); + if (readval != src) { + printf("Error (intwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0xFF); + ctf_bitfield_write(target.l, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 0); + if (readval != src) { + printf("Error (longwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0xFF); + ctf_bitfield_write(target.ll, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 0); + if (readval != src) { + printf("Error (longlongwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + } + } + if (!err) + printf("Success!\n"); + else + printf("Failed!\n"); + return err; +} + +int run_test_signed(void) +{ + int src, nrbits; + union { + char c[TEST_LEN]; + short s[TEST_LEN/sizeof(short)]; + int i[TEST_LEN/sizeof(int)]; + long l[TEST_LEN/sizeof(long)]; + long long ll[TEST_LEN/sizeof(long long)]; + } target; + int64_t readval; + unsigned int s, l; + int err = 0; + + printf("Running signed test with 0x%X\n", srcrand); + + src = srcrand; + if (src & 0x80000000U) + nrbits = fls(~src) + 1; /* Find least significant bit conveying sign */ + else + nrbits = fls(src) + 1; /* Keep sign at 0 */ + + for (s = 0; s < 8 * TEST_LEN; s++) { + for (l = nrbits; l < (8 * TEST_LEN) - s; l++) { + init_byte_array(target.c, TEST_LEN, 0x0); + ctf_bitfield_write(target.c, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 1); + if (readval != src) { + printf("Error (bytewise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0x0); + ctf_bitfield_write(target.s, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 1); + if (readval != src) { + printf("Error (shortwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0x0); + ctf_bitfield_write(target.i, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 1); + if (readval != src) { + printf("Error (intwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0x0); + ctf_bitfield_write(target.l, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 1); + if (readval != src) { + printf("Error (longwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + + init_byte_array(target.c, TEST_LEN, 0x0); + ctf_bitfield_write(target.ll, s, l, src); + readval = _ctf_bitfield_read_64(target.c, s, l, BYTE_ORDER, 1); + if (readval != src) { + printf("Error (longlongwise) src %lX read %llX shift %d len %d\n", + src, readval, s, l); + print_byte_array(target.c, TEST_LEN); + err = 1; + } + } + } + if (!err) + printf("Success!\n"); + else + printf("Failed!\n"); + return err; +} + +int run_test(void) +{ + int err = 0; + int i; + + srand(time(NULL)); + + srcrand = 0; + err |= run_test_unsigned(); + srcrand = 0; + err |= run_test_signed(); + srcrand = 1; + err |= run_test_unsigned(); + srcrand = ~0U; + err |= run_test_unsigned(); + srcrand = -1; + err |= run_test_signed(); + srcrand = (int)0x80000000U; + err |= run_test_signed(); + + for (i = 0; i < NR_TESTS; i++) { + srcrand = rand(); + err |= run_test_unsigned(); + err |= run_test_signed(); + } + return err; +} + +int main(int argc, char **argv) +{ + unsigned long src; + unsigned int shift, len; + int ret; + union { + unsigned char c[8]; + unsigned short s[4]; + unsigned int i[2]; + unsigned long l[2]; + unsigned long long ll[1]; + } target; + uint64_t readval; + + if (argc > 1) + src = atoi(argv[1]); + else + src = 0x12345678; + if (argc > 2) + shift = atoi(argv[2]); + else + shift = 12; + if (argc > 3) + len = atoi(argv[3]); + else + len = 40; + + target.i[0] = 0xFFFFFFFF; + target.i[1] = 0xFFFFFFFF; + ctf_bitfield_write(target.c, shift, len, src); + printf("bytewise\n"); + print_byte_array(target.c, 8); + + target.i[0] = 0xFFFFFFFF; + target.i[1] = 0xFFFFFFFF; + ctf_bitfield_write(target.s, shift, len, src); + printf("shortwise\n"); + print_byte_array(target.c, 8); + + target.i[0] = 0xFFFFFFFF; + target.i[1] = 0xFFFFFFFF; + ctf_bitfield_write(target.i, shift, len, src); + printf("intwise\n"); + print_byte_array(target.c, 8); + + target.i[0] = 0xFFFFFFFF; + target.i[1] = 0xFFFFFFFF; + ctf_bitfield_write(target.l, shift, len, src); + printf("longwise\n"); + print_byte_array(target.c, 8); + + target.i[0] = 0xFFFFFFFF; + target.i[1] = 0xFFFFFFFF; + ctf_bitfield_write(target.ll, shift, len, src); + printf("lluwise\n"); + print_byte_array(target.c, 8); + + readval = _ctf_bitfield_read_64(target.c, shift, len, BYTE_ORDER, 0); + printf("read: %llX\n", readval); + + ret = run_test(); + + return ret; +} -- 2.34.1