├── .gitignore ├── LICENSE ├── README.md ├── tests ├── Makefile ├── bisect.c ├── quicksort.c ├── test1.S ├── test2.S ├── test3.S └── test4.S ├── tracer ├── bts │ ├── Makefile │ ├── bts_trace.cc │ ├── bts_trace.h │ ├── monitor.cc │ ├── monitor.h │ ├── perf.cc │ └── perf.h ├── common │ ├── Makefile │ ├── bbmap.cc │ ├── bbmap.h │ ├── bbtrace.proto │ ├── common.h │ ├── exception.cc │ ├── exception.h │ ├── logging.h │ ├── serialize.cc │ └── serialize.h └── pin │ ├── images.H │ ├── images.cpp │ ├── linux_exception.H │ ├── linux_exception.cpp │ ├── makefile │ ├── makefile.rules │ └── pintrace.cpp └── viewer ├── bbtrace.proto └── trace.py /.gitignore: -------------------------------------------------------------------------------- 1 | *pyc 2 | tracer/pin/bbtrace.pb.* 3 | tracer/pin/obj-intel64 4 | tracer/pin/pin.log 5 | tracer/common/bbtrace.pb.* 6 | tracer/common/*.o 7 | tracer/common/libtracer.a 8 | tracer/bts/*.o 9 | tracer/bts/bts_trace 10 | tracer/bts/bts_trace 11 | tests/bisect 12 | tests/quicksort 13 | tests/test? 14 | viewer/bbtrace_pb2.py 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | FuzzTrace is a "general-purpose" tracing tool for closed-source applications, 2 | aimed at generating a concise execution trace that can be used to support the 3 | fuzz-testing activity or other analyses. 4 | 5 | At the time of writing, we provide two tracing back-ends, based on Intel BTS 6 | and PIN respectively. In any case, the execution trace is serialized to a 7 | [protobuf](https://code.google.com/p/protobuf/) object, that can then be 8 | processed off-line. Available back-ends are briefly described in the next 9 | paragraphs, together with some usage examples. 10 | 11 | On a Debian/Ubuntu system, use the following commands to install the required 12 | dependencies (these are common to all the back-ends available): 13 | 14 | roby@gimli:~$ sudo apt-get install protobuf-compiler python-protobuf libprotobuf-dev 15 | 16 | ## Back-ends ## 17 | 18 | ### BTS-based execution tracers ### 19 | 20 | The BTS back-end is an efficient tracer that leverages Intel "Branch Trace 21 | Store" (BTS) technology. The source code for this back-end is located under 22 | `tracer/bts`. To compile this back-end module enter directory `tracer/bin` and 23 | run `make`. 24 | 25 | Hopefully, everything will go fine. You should now be able to trace your target 26 | application using the `bts_trace` binary: 27 | 28 | roby@gimli:~/projects/fuzztrace/tracer/bts$ ./bts_trace -f /dev/shm/trace.bin -- /bin/ls -la >/dev/null 29 | [*] Got 108684 events (4967 CFG edges) 30 | [*] Serializing to /dev/shm/trace.bin 31 | 32 | ### PIN-based execution tracers ### 33 | 34 | The PIN back-end is a 35 | [PIN](https://software.intel.com/en-us/articles/pin-a-dynamic-binary-instrumentation-tool) 36 | extension to monitor the execution of a binary application and record its 37 | "execution trace". FuzzTrace/PIN lives in directory `fuzztrace/tracer/pin`. To 38 | compile the PIN module, set the `PIN_ROOT` environment variable and launch 39 | `make` from the `tracer/pin` directory, e.g.: 40 | 41 | roby@gimli:~/apps/pin$ export PIN_ROOT=$(pwd) 42 | roby@gimli:~/apps/pin$ cd ~/projects/fuzztrace/tracer/pin 43 | roby@gimli:~/projects/fuzztrace/tracer/pin$ make 44 | 45 | 46 | You should be able to trace your target program using the `pintrace` PIN tool: 47 | 48 | roby@gimli:~/projects/fuzztrace/tracer/pin$ ${PIN_ROOT}/pin.sh -t obj-intel64/pintrace.so -f /dev/shm/trace.bin -- /bin/ls 49 | 50 | ## Trace viewer ## 51 | 52 | The `viewer` directory provides a basic trace viewer, which parses a saved 53 | execution traces and displays recorded branches. 54 | 55 | Before using the viewer, compile the `bbtrace.proto` file: 56 | 57 | roby@gimli:~/projects/fuzztrace/viewer$ protoc --python_out=. bbtrace.proto 58 | 59 | After that, usage is quite straightforward: 60 | 61 | roby@gimli:~/projects/fuzztrace/viewer$ python trace.py /dev/shm/trace.bin 62 | #### Trace '/dev/shm/trace.bin' #### 63 | [/dev/shm/trace.bin] cmd: test, data: 0 bytes, time: 2015-01-29 22:47:52, hash: 3c31f, edges(s): 708, exception(s): 0 64 | 65 | - CFG edges 66 | [00402168 -> 00402178] 1 hit 67 | [00402178 -> 0040217d] 1 hit 68 | [0040217d -> 00412513] 1 hit 69 | [00402190 -> 004124e0] 1 hit 70 | ... 71 | 72 | 73 | -------------------------------------------------------------------------------- /tests/Makefile: -------------------------------------------------------------------------------- 1 | TESTS_ASM := $(basename $(wildcard *.S)) 2 | TESTS_C := $(basename $(wildcard *.c)) 3 | TESTS = $(TESTS_ASM) $(TESTS_C) 4 | TRACES = $(TESTS:=.trace) 5 | 6 | tests: $(TESTS) 7 | all: tests 8 | clean: 9 | -rm $(TESTS) 10 | 11 | traces: $(TRACES) 12 | 13 | $(TRACES): %.trace: % 14 | ../tracer/bts/bts_trace -f /dev/shm/$@ ./$^ 15 | 16 | $(TESTS_ASM): %: %.S 17 | $(CC) -nostdlib -o $@ $^ 18 | 19 | $(TESTS_C): %: %.c 20 | $(CC) -o $@ $^ 21 | -------------------------------------------------------------------------------- /tests/bisect.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #define ARRAY_SIZE 1024 6 | 7 | static int bisect(int v[], int size, int key) { 8 | int start, end, middle, pos; 9 | 10 | start = 0; 11 | end = size-1; 12 | pos = -1; 13 | while (start <= end) { 14 | middle = (end+start)/2; 15 | 16 | #if 0 17 | printf("Searching [%d - %d] for key %d, middle %d\n", 18 | start, end, key, middle); 19 | #endif 20 | 21 | if (v[middle] > key) { 22 | end = middle-1; 23 | } else if (v[middle] < key) { 24 | start = middle+1; 25 | } else { 26 | pos = middle; 27 | break; 28 | } 29 | } 30 | 31 | return pos; 32 | } 33 | 34 | static void dump_array(int v[], int size) { 35 | const int blocksize = 32; 36 | int i, blockno; 37 | 38 | assert((size % blocksize) == 0); 39 | 40 | for (blockno=0; blockno 1) { 68 | elem = atoi(argv[1]); 69 | } else { 70 | elem = 42; 71 | printf("No element specified, searching for %d\n", elem); 72 | } 73 | 74 | srandom(time(NULL)); 75 | for (i=0; i 2 | #include 3 | 4 | #define ARRAY_SIZE 1024 5 | 6 | static void swap(void *x, void *y, size_t l) { 7 | char *a = x, *b = y, c; 8 | while(l--) { 9 | c = *a; 10 | *a++ = *b; 11 | *b++ = c; 12 | } 13 | } 14 | 15 | int count = 0; 16 | static void sort(char *array, size_t size, int (*cmp)(void*,void*), int begin, int end) { 17 | count++; 18 | if (end > begin) { 19 | void *pivot = array + begin; 20 | int l = begin + size; 21 | int r = end; 22 | while(l < r) { 23 | if (cmp(array+l,pivot) <= 0) { 24 | l += size; 25 | } else if ( cmp(array+r, pivot) > 0 ) { 26 | r -= size; 27 | } else if ( l < r ) { 28 | swap(array+l, array+r, size); 29 | } 30 | } 31 | l -= size; 32 | swap(array+begin, array+l, size); 33 | sort(array, size, cmp, begin, l); 34 | sort(array, size, cmp, r, end); 35 | } 36 | } 37 | 38 | void quicksort(void *array, size_t nitems, size_t size, int (*cmp)(void*,void*)) { 39 | sort(array, size, cmp, 0, nitems*size); 40 | } 41 | 42 | typedef int type; 43 | 44 | int type_cmp(void *a, void *b){ return (*(type*)a)-(*(type*)b); } 45 | 46 | int main(void) { 47 | int array[ARRAY_SIZE]; 48 | int len=sizeof(array)/sizeof(type); 49 | char *sep=""; 50 | int i; 51 | 52 | srandom(time(NULL)); 53 | for (i=0; i 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include "common/logging.h" 26 | #include "./monitor.h" 27 | #include "./perf.h" 28 | 29 | struct perf_global_status gbl_status = { 30 | NULL, // mmap 31 | NULL, // data 32 | 0, // data_size 33 | 0, // fd_evt 34 | 0, // prev_head 35 | 0, // n_events 36 | 0, // pid_child 37 | 0 // data_ready 38 | }; 39 | 40 | static pid_t child_start(char **argv) { 41 | pid_t pid; 42 | int ret; 43 | 44 | pid = fork(); 45 | assert(pid >= 0); 46 | if (pid == 0) { 47 | // Child 48 | ret = ptrace(PTRACE_TRACEME, 0, 0, 0); 49 | assert(ret != -1); 50 | 51 | raise(SIGTRAP); 52 | execvp(argv[0], argv); 53 | 54 | // Unreachable 55 | assert(0); 56 | } 57 | 58 | // Parent 59 | return pid; 60 | } 61 | 62 | static void show_help(char **argv) { 63 | fprintf(stderr, "Syntax: %s [-f ] cmdline\n", argv[0]); 64 | } 65 | 66 | // Signal handler to process perf events. 67 | static void sig_handler(int signum, siginfo_t *siginfo, void *dummy) { 68 | if (signum == SIGIO) { 69 | kill(gbl_status.pid_child, SIGTRAP); 70 | gbl_status.data_ready++; 71 | } 72 | } 73 | 74 | int main(int argc, char **argv) { 75 | struct perf_event_attr pe; 76 | struct sigaction sa; 77 | pid_t pid_child; 78 | int opt; 79 | std::string s_outfile; 80 | 81 | while ((opt = getopt(argc, argv, "f:h")) != -1) { 82 | switch (opt) { 83 | case 'f': 84 | s_outfile = optarg; 85 | break; 86 | default: 87 | case 'h': 88 | show_help(argv); 89 | exit(1); 90 | } 91 | } 92 | 93 | // Allocate work area for processing events 94 | gbl_status.data_size = MMAP_PAGES*getpagesize(); 95 | gbl_status.data = (unsigned char*) malloc(gbl_status.data_size); 96 | assert(gbl_status.data > 0); 97 | 98 | memset(gbl_status.data, 0, gbl_status.data_size); 99 | 100 | // Prepare the child process 101 | pid_child = child_start(argv+optind); 102 | LOG_DEBUG("Started child with pid %d", pid_child); 103 | gbl_status.pid_child = pid_child; 104 | 105 | // Setup signals 106 | memset(&sa, 0, sizeof(struct sigaction)); 107 | sa.sa_sigaction = sig_handler; 108 | sa.sa_flags = SA_SIGINFO; 109 | if (sigaction(SIGIO, &sa, NULL) < 0) { 110 | LOG_FATAL("Error setting up signal handler"); 111 | } 112 | 113 | // Initialize perf structure 114 | perf_init(&pe, MMAP_PAGES); 115 | 116 | gbl_status.fd_evt = perf_event_open(&pe, pid_child, -1, -1, 0); 117 | if (gbl_status.fd_evt == -1) { 118 | perror("perf_event_open"); 119 | exit(EXIT_FAILURE); 120 | } 121 | 122 | // Allocate mmap'ed area 123 | gbl_status.mmap = mmap(NULL, (MMAP_PAGES+1)*getpagesize(), 124 | PROT_READ | PROT_WRITE, MAP_SHARED, gbl_status.fd_evt, 0); 125 | assert(gbl_status.mmap != reinterpret_cast(-1)); 126 | 127 | fcntl(gbl_status.fd_evt, F_SETFL, O_RDWR|O_NONBLOCK|O_ASYNC); 128 | fcntl(gbl_status.fd_evt, F_SETSIG, SIGIO); 129 | fcntl(gbl_status.fd_evt, F_SETOWN, getpid()); 130 | 131 | // Monitor child until it terminates 132 | monitor_loop(pid_child, s_outfile); 133 | 134 | ioctl(gbl_status.fd_evt, PERF_EVENT_IOC_DISABLE, 0); 135 | close(gbl_status.fd_evt); 136 | munmap(gbl_status.mmap, (MMAP_PAGES+1)*getpagesize()); 137 | 138 | return 0; 139 | } 140 | -------------------------------------------------------------------------------- /tracer/bts/bts_trace.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _BTS_TRACE_H_ 6 | #define _BTS_TRACE_H_ 7 | 8 | #define __STDC_FORMAT_MACROS 9 | 10 | #include 11 | #include 12 | #include 13 | 14 | #define MMAP_PAGES 512 15 | 16 | // Global status of perf_event monitor 17 | struct perf_global_status { 18 | void *mmap; // Pointer to mmap'ed area 19 | unsigned char *data; // Backup copy of BTS data for processing 20 | int data_size; // Size of mmap'ed data area (without hdr) 21 | int fd_evt; 22 | uint64_t prev_head; 23 | int n_events; 24 | int pid_child; 25 | volatile sig_atomic_t data_ready; 26 | }; 27 | 28 | extern struct perf_global_status gbl_status; 29 | 30 | #endif // _BTS_TRACE_H_ 31 | -------------------------------------------------------------------------------- /tracer/bts/monitor.cc: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include "./monitor.h" 6 | 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | 16 | #include 17 | #include 18 | 19 | #include "common/common.h" 20 | #include "common/serialize.h" 21 | #include "./bts_trace.h" 22 | #include "./perf.h" 23 | 24 | static const int MAX_STACKTRACE_SIZE = 16; 25 | 26 | static ExecutionTrace gbl_execution_trace; 27 | 28 | static inline bool is_kernel_addr(target_addr addr) { 29 | return (addr >> 47) != 0; 30 | } 31 | 32 | // Memory mapping of a new executable section. Extract details of the 33 | // mmap()'ped region and add to the global structure 34 | static void monitor_add_mmap(struct perf_event_mmap *mmap_event) { 35 | MemoryRegion region; 36 | region.base = mmap_event->addr; 37 | region.size = mmap_event->len; 38 | region.filename = mmap_event->filename; 39 | gbl_execution_trace.memory_regions.push_back(region); 40 | 41 | LOG_DEBUG("mmap()'ing image '%s' at range [0x%lx-0x%lx]", 42 | region.filename.c_str(), region.base, region.base+region.size-1); 43 | } 44 | 45 | // Add a new branch event 46 | static void monitor_add_sample(struct perf_event_bts_sample *bts_sample) { 47 | const target_addr bb_previous = bts_sample->bts.from; 48 | const target_addr bb_current = bts_sample->bts.to; 49 | 50 | #ifdef DEBUG_MODE 51 | fprintf(stderr, "[tid %d] from: 0x%016" PRIx64 ", to: 0x%016" PRIx64 "\n", 52 | bts_sample->bts.tid, bb_previous, bb_current); 53 | #endif 54 | 55 | // Skip kernel addresses 56 | if (is_kernel_addr(bb_previous) || is_kernel_addr(bb_current)) { 57 | return; 58 | } 59 | 60 | gbl_execution_trace.basic_blocks.AddEdge(bb_previous, bb_current); 61 | gbl_status.n_events++; 62 | } 63 | 64 | static void monitor_process_events(void) { 65 | struct perf_event_mmap_page *control_page; 66 | struct perf_event_header *event; 67 | uint64_t head, prev_head_wrap; 68 | void *data_mmap; 69 | int size, offset; 70 | 71 | control_page = (struct perf_event_mmap_page*) gbl_status.mmap; 72 | data_mmap = (unsigned char*) gbl_status.mmap + getpagesize(); 73 | 74 | if (control_page == NULL) { 75 | LOG_WARN("Skipping invalid control page"); 76 | return; 77 | } 78 | 79 | head = control_page->data_head; 80 | rmb(); 81 | 82 | size = head - gbl_status.prev_head; 83 | 84 | prev_head_wrap = gbl_status.prev_head % gbl_status.data_size; 85 | 86 | LOG_DEBUG("Current head 0x%016" PRIx64 ", previous head 0x%016" PRIx64 87 | ", size %d data_size %d prev_head_wrap 0x%016" PRIx64, head, 88 | gbl_status.prev_head, size, gbl_status.data_size, prev_head_wrap); 89 | 90 | 91 | // Copy (possibly wrapped) data to the work area 92 | memcpy(gbl_status.data, (unsigned char*) data_mmap + prev_head_wrap, 93 | gbl_status.data_size - prev_head_wrap); 94 | memcpy(gbl_status.data + gbl_status.data_size - prev_head_wrap, 95 | (unsigned char*) data_mmap, prev_head_wrap); 96 | 97 | offset = 0; 98 | while (offset < size) { 99 | event = (struct perf_event_header *) &gbl_status.data[offset]; 100 | 101 | switch (event->type) { 102 | case PERF_RECORD_MMAP: 103 | monitor_add_mmap(reinterpret_cast(event)); 104 | break; 105 | 106 | case PERF_RECORD_LOST: 107 | LOG_DEBUG("Lost %lu events", ((struct perf_record_lost*) event)->lost); 108 | break; 109 | 110 | case PERF_RECORD_THROTTLE: 111 | case PERF_RECORD_UNTHROTTLE: 112 | LOG_DEBUG("Received a (un)throttle event, ignoring"); 113 | break; 114 | 115 | case PERF_RECORD_SAMPLE: 116 | assert(event->size == sizeof(struct perf_event_bts_sample)); 117 | monitor_add_sample(reinterpret_cast< 118 | struct perf_event_bts_sample *>(event)); 119 | break; 120 | 121 | case PERF_RECORD_FORK: { 122 | LOG_DEBUG("Process %d (thread %d) created", 123 | reinterpret_cast(event)->pid, 124 | reinterpret_cast(event)->tid); 125 | break; 126 | } 127 | 128 | case PERF_RECORD_EXIT: { 129 | LOG_DEBUG("Process %d (thread %d) has exited", 130 | reinterpret_cast(event)->pid, 131 | reinterpret_cast(event)->tid); 132 | break; 133 | } 134 | 135 | default: 136 | LOG_FATAL("Unsupported perf record %d", event->type); 137 | } 138 | 139 | // Skip event 140 | offset += event->size; 141 | } 142 | 143 | assert(offset == size); 144 | 145 | mb(); 146 | control_page->data_tail = head; 147 | gbl_status.prev_head = head; 148 | } 149 | 150 | static void monitor_handle_signal(pid_t pid, int status) { 151 | LOG_DEBUG("Read signal info (pid %d)", pid); 152 | siginfo_t si; 153 | int ret = ptrace(PTRACE_GETSIGINFO, pid, NULL, &si); 154 | assert(ret != -1); 155 | 156 | // Exception type 157 | ExceptionType exc_type; 158 | target_addr exc_faulty; 159 | 160 | switch (si.si_signo) { 161 | case SIGSEGV: 162 | exc_type = ExceptionAccessViolation; 163 | exc_faulty = reinterpret_cast(si.si_addr); 164 | break; 165 | default: 166 | exc_type = ExceptionUnknown; 167 | exc_faulty = 0; 168 | break; 169 | } 170 | 171 | LOG_DEBUG("Reading child registers (pid %d)", pid); 172 | struct user_regs_struct regs; 173 | ret = ptrace(PTRACE_GETREGS, pid, NULL, ®s); 174 | assert(ret != -1); 175 | 176 | std::shared_ptr 177 | exc(new Exception(pid, exc_type, regs.rip, exc_faulty, 0)); 178 | 179 | // Generate a stack trace for this process 180 | target_addr fp = regs.rsp; 181 | LOG_DEBUG("Starting stack walking at 0x%016lx", fp); 182 | 183 | for (int i = 0; i < MAX_STACKTRACE_SIZE; i++) { 184 | // Read the return address of current stack frame 185 | target_addr retaddr = ptrace(PTRACE_PEEKTEXT, pid, 186 | fp+sizeof(target_addr), 0); 187 | if (retaddr == static_cast(-1)) { 188 | LOG_DEBUG("Failed reading %d-th return address @0x%lx, giving up", 189 | i, fp+sizeof(target_addr)); 190 | break; 191 | } 192 | 193 | // Save this return address 194 | exc->stacktrace_push(retaddr); 195 | LOG_DEBUG("ret%d @0x%lx -> 0x%lx", i, fp+sizeof(target_addr), retaddr); 196 | 197 | // Read the address of the next stack frame 198 | fp = ptrace(PTRACE_PEEKTEXT, pid, fp, 0); 199 | if (fp == static_cast(-1)) { 200 | LOG_DEBUG("Failed reading %d-th frame pointer @0x%lx, giving up", i, fp); 201 | break; 202 | } 203 | } 204 | 205 | gbl_execution_trace.exceptions.push_back(exc); 206 | } 207 | 208 | void monitor_loop(pid_t pid_child, const std::string s_outfile) { 209 | int ret, status; 210 | pid_t pid; 211 | 212 | // Wait until child terminates 213 | while (1) { 214 | pid = waitpid(pid_child, &status, 0); 215 | if (pid == -1 && errno == EINTR) { 216 | continue; 217 | } 218 | 219 | assert(pid == pid_child); 220 | 221 | // Process any pending event 222 | if (gbl_status.data_ready > 0) { 223 | gbl_status.data_ready--; 224 | monitor_process_events(); 225 | } 226 | 227 | if (WIFEXITED(status)) { 228 | LOG_DEBUG("Child terminated with status %d", WEXITSTATUS(status)); 229 | break; 230 | } else if (WIFSIGNALED(status)) { 231 | LOG_DEBUG("Child terminated by signal #%d", WTERMSIG(status)); 232 | break; 233 | } else if (WIFSTOPPED(status) && WSTOPSIG(status) != SIGTRAP) { 234 | LOG_DEBUG("Child stopped by signal #%d", WSTOPSIG(status)); 235 | monitor_handle_signal(pid_child, status); 236 | break; 237 | } 238 | 239 | // Resume child process 240 | ret = ptrace(PTRACE_CONT, pid_child, 0, 0); 241 | assert(ret != -1); 242 | } 243 | 244 | // Process final events before terminating 245 | monitor_process_events(); 246 | 247 | // Serialize to file 248 | LOG_INFO("Got %d events (%d CFG edges)", gbl_status.n_events, 249 | gbl_execution_trace.basic_blocks.size()); 250 | 251 | if (s_outfile.length() > 0) { 252 | LOG_INFO("Serializing to %s", s_outfile.c_str()); 253 | serialize_trace(s_outfile, gbl_execution_trace); 254 | } 255 | } 256 | -------------------------------------------------------------------------------- /tracer/bts/monitor.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _MONITOR_H_ 6 | #define _MONITOR_H_ 7 | 8 | #include 9 | 10 | #include 11 | #include 12 | 13 | void monitor_loop(pid_t pid_child, const std::string s_outfile); 14 | 15 | #endif // _MONITOR_H_ 16 | -------------------------------------------------------------------------------- /tracer/bts/perf.cc: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include "./perf.h" 6 | 7 | #include 8 | #include 9 | 10 | #include "common/logging.h" 11 | #include "./bts_trace.h" 12 | 13 | /* There is no glibc wrapper for syscall perf_event_open(), so we provide a 14 | simple wrapper here */ 15 | int64_t perf_event_open(struct perf_event_attr *attr, pid_t pid, 16 | int cpu, int group_fd, uint64_t flags) { 17 | return syscall(__NR_perf_event_open, attr, pid, cpu, group_fd, flags); 18 | } 19 | 20 | void perf_init(struct perf_event_attr *attr, int mmap_pages) { 21 | memset(attr, 0, sizeof(struct perf_event_attr)); 22 | attr->type = PERF_TYPE_HARDWARE; 23 | attr->size = sizeof(struct perf_event_attr); 24 | attr->config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS; 25 | 26 | attr->branch_sample_type = PERF_SAMPLE_BRANCH_USER | PERF_SAMPLE_BRANCH_ANY; 27 | 28 | attr->disabled = 1; 29 | attr->enable_on_exec = 1; 30 | attr->exclude_kernel = 1; 31 | attr->exclude_hv = 1; 32 | attr->exclude_idle = 1; 33 | attr->precise_ip = 2; 34 | attr->wakeup_watermark = mmap_pages*getpagesize()/32/4; 35 | attr->watermark = 1; 36 | attr->mmap = 1; 37 | 38 | attr->sample_period = 1; 39 | attr->sample_type = PERF_SAMPLE_IP | PERF_SAMPLE_TID | PERF_SAMPLE_ADDR; 40 | } 41 | -------------------------------------------------------------------------------- /tracer/bts/perf.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _PERF_H_ 6 | #define _PERF_H_ 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | struct sample_id { 13 | uint64_t id; 14 | }; 15 | 16 | struct perf_record_lost { 17 | struct perf_event_header header; 18 | uint64_t id; 19 | uint64_t lost; 20 | struct sample_id sample_id; 21 | }; 22 | 23 | // A branch trace record in perf_event 24 | struct perf_event_bts { 25 | uint64_t from; 26 | uint32_t pid, tid; 27 | uint64_t to; 28 | }; 29 | 30 | // A perf_event branch trace sample 31 | struct perf_event_bts_sample { 32 | struct perf_event_header header; 33 | struct perf_event_bts bts; 34 | }; 35 | 36 | // mmap()'ing of executable areas 37 | struct perf_event_mmap { 38 | struct perf_event_header header; 39 | uint32_t pid, tid; 40 | uint64_t addr; 41 | uint64_t len; 42 | uint64_t pgoff; 43 | char filename[]; 44 | struct sample_id sample_id; 45 | }; 46 | 47 | // Process exit event 48 | struct perf_event_exit { 49 | struct perf_event_header header; 50 | uint32_t pid, tid; 51 | uint64_t time; 52 | struct sample_id sample_id; 53 | }; 54 | 55 | // Process fork event 56 | struct perf_event_fork { 57 | struct perf_event_header header; 58 | uint32_t pid, ppid; 59 | uint32_t tid, ptid; 60 | uint64_t time; 61 | struct sample_id sample_id; 62 | }; 63 | 64 | int64_t perf_event_open(struct perf_event_attr *attr, pid_t pid, 65 | int cpu, int group_fd, uint64_t flags); 66 | void perf_init(struct perf_event_attr *attr, int mmap_pages); 67 | 68 | #if defined(__i386__) 69 | #define rmb() asm volatile("lock; addl $0,0(%%esp)" ::: "memory") 70 | #define mb() asm volatile("lock; addl $0,0(%%esp)" ::: "memory") 71 | 72 | #elif defined(__x86_64) 73 | #define rmb() asm volatile("lfence":::"memory") 74 | #define mb() asm volatile("mfence":::"memory") 75 | #endif 76 | 77 | #endif // _PERF_H_ 78 | -------------------------------------------------------------------------------- /tracer/common/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all clean 2 | 3 | CFLAGS=-Wall -std=c++11 -fPIC 4 | LDFLAGS= 5 | 6 | all: libtracer.a 7 | clean: 8 | -rm $(objs) $(protobuf-files) 9 | 10 | objs = bbtrace.pb.o bbmap.o exception.o serialize.o 11 | protobuf-files = bbtrace.pb.cc bbtrace.pb.h 12 | 13 | libtracer.a: $(objs) 14 | ar -rcs -o $@ $^ $(LDFLAGS) 15 | 16 | %.o: %.cc logging.h 17 | $(CXX) $(CFLAGS) -c -o $@ $< 18 | 19 | bbtrace.pb.h bbtrace.pb.cc: bbtrace.proto 20 | protoc --cpp_out=. $< 21 | -------------------------------------------------------------------------------- /tracer/common/bbmap.cc: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include "./bbmap.h" 6 | 7 | #include 8 | 9 | void BBMap::AddEdge(target_addr prev, target_addr next) { 10 | bbmap_edge edge(prev, next); 11 | 12 | if (bb_map_.find(edge) == bb_map_.end()) { 13 | bb_map_[edge] = 1; 14 | } else { 15 | bb_map_[edge] += 1; 16 | } 17 | } 18 | 19 | uint32_t BBMap::ComputeHash() const { 20 | uint32_t hash = 0; 21 | for (bbmap_iterator it = map_begin(); it != map_end(); it++) { 22 | bbmap_edge edge = it->first; 23 | hash ^= edge.first ^ edge.second; 24 | } 25 | return hash; 26 | } 27 | -------------------------------------------------------------------------------- /tracer/common/bbmap.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | // Execution monitor. 5 | // 6 | 7 | #ifndef _COMMON_BBMAP_H 8 | #define _COMMON_BBMAP_H 9 | 10 | #include 11 | #include 12 | 13 | #include "./common.h" 14 | 15 | typedef std::pair bbmap_edge; 16 | typedef std::map::const_iterator bbmap_iterator; 17 | 18 | class BBMap { 19 | public: 20 | explicit BBMap() {} 21 | 22 | // Record the execution of a CFG edge, identified by a pair of basic block 23 | // addresses 24 | void AddEdge(target_addr prev, target_addr next); 25 | 26 | // Return a 32-bit hash of this basic block map 27 | uint32_t ComputeHash() const; 28 | 29 | // Iterate over the (edge, #hit) pairs 30 | bbmap_iterator map_begin() const { return bb_map_.begin(); } 31 | bbmap_iterator map_end() const { return bb_map_.end(); } 32 | int size() const { return bb_map_.size(); } 33 | 34 | private: 35 | std::map bb_map_; 36 | }; 37 | 38 | #endif // _COMMON_BBMAP_H 39 | -------------------------------------------------------------------------------- /tracer/common/bbtrace.proto: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | package bbtrace; 6 | 7 | message TraceHeader { 8 | enum TraceMagic { 9 | TRACE_MAGIC = 0x0b0b0b0b; 10 | } 11 | 12 | required fixed32 magic = 1; 13 | required uint64 timestamp = 2; 14 | required uint32 hash = 3; 15 | } 16 | 17 | message Edge { 18 | required uint64 prev = 1; 19 | required uint64 next = 2; 20 | required uint64 hit = 3; 21 | } 22 | 23 | // Information about "interesting" exceptions observed during program execution 24 | // (these may both be handled by the application, or cause program termination) 25 | message Exception { 26 | enum ExceptionType { 27 | TYPE_UNKNOWN = 0; 28 | TYPE_VIOLATION = 1; 29 | } 30 | 31 | enum ExceptionAccess { 32 | ACCESS_UNKNOWN = 0; 33 | ACCESS_READ = 1; 34 | ACCESS_WRITE = 2; 35 | ACCESS_EXECUTE = 3; 36 | } 37 | 38 | required uint32 tid = 1; 39 | required ExceptionType type = 2 [default = TYPE_UNKNOWN]; 40 | 41 | // Program counter 42 | required uint64 pc = 3; 43 | 44 | // Faulty address 45 | required uint64 faultyaddr = 4; 46 | 47 | // Access type 48 | required ExceptionAccess access = 5 [default = ACCESS_UNKNOWN]; 49 | 50 | // Stack trace 51 | repeated uint64 stacktrace = 6; 52 | } 53 | 54 | // Memory-mapped regions 55 | message MemoryRegion { 56 | required uint64 base = 1; 57 | required uint32 size = 2; 58 | required string name = 3; 59 | } 60 | 61 | message Trace { 62 | required TraceHeader header = 1; 63 | repeated Edge edge = 2; 64 | repeated Exception exception = 3; 65 | repeated MemoryRegion region = 4; 66 | } 67 | -------------------------------------------------------------------------------- /tracer/common/common.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _COMMON_COMMON_H 6 | #define _COMMON_COMMON_H 7 | 8 | #include "cstdint" 9 | 10 | #include "./logging.h" 11 | 12 | #if __x86_64__ 13 | typedef uint64_t target_addr; 14 | #else 15 | typedef uint32_t target_addr; 16 | #endif 17 | 18 | #endif // _COMMON_COMMON_H 19 | -------------------------------------------------------------------------------- /tracer/common/exception.cc: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include "./exception.h" 6 | 7 | Exception::Exception(int tid, ExceptionType type, target_addr pc, 8 | target_addr faulty_addr, int faulty_type) 9 | : tid_(tid), type_(type), pc_(pc), faulty_addr_(faulty_addr), 10 | faulty_type_(faulty_type) { 11 | } 12 | -------------------------------------------------------------------------------- /tracer/common/exception.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | // OS-independent exception handling. 5 | // 6 | 7 | #ifndef _COMMON_EXCEPTION_H 8 | #define _COMMON_EXCEPTION_H 9 | 10 | #include 11 | #include 12 | 13 | #include "./common.h" 14 | 15 | typedef std::vector::const_iterator stacktrace_iterator; 16 | 17 | enum ExceptionType { 18 | ExceptionUnknown = 0, 19 | ExceptionAccessViolation = 1, 20 | }; 21 | 22 | enum ExceptionFaultyType { 23 | ExceptionFaultyUnknown = 0, 24 | ExceptionFaultyRead = 1, 25 | ExceptionFaultyWrite = 2, 26 | ExceptionFaultyExecute = 3, 27 | }; 28 | 29 | class Exception { 30 | public: 31 | explicit Exception(int tid, ExceptionType type, target_addr pc, 32 | target_addr faulty_addr, int faulty_type); 33 | 34 | // Getters 35 | int tid() const { return tid_; } 36 | ExceptionType type() const { return type_; } 37 | target_addr pc() const { return pc_; } 38 | target_addr faulty_addr() const { return faulty_addr_; } 39 | int faulty_type() const { return faulty_type_; } 40 | 41 | // Push a new entry to the stack trace 42 | void stacktrace_push(target_addr addr) { 43 | stacktrace_.push_back(addr); 44 | } 45 | 46 | stacktrace_iterator stacktrace_begin() const { return stacktrace_.begin(); } 47 | stacktrace_iterator stacktrace_end() const { return stacktrace_.end(); } 48 | 49 | private: 50 | int tid_; // Thread ID 51 | ExceptionType type_; // Exception type 52 | target_addr pc_; // Program counter 53 | target_addr faulty_addr_; // Faulty address 54 | int faulty_type_; // Type of faulty access 55 | std::vector stacktrace_; // Stack trace (list of retaddr) 56 | }; 57 | 58 | typedef std::vector > exceptions_list; 59 | typedef exceptions_list::const_iterator exceptions_iterator; 60 | 61 | #endif // _COMMON_EXCEPTION_H 62 | -------------------------------------------------------------------------------- /tracer/common/logging.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _COMMON_LOGGING_H_ 6 | #define _COMMON_LOGGING_H_ 7 | 8 | #include 9 | #include 10 | 11 | // #define DEBUG_MODE 12 | 13 | #define _msg(tag, fmt, ...) \ 14 | fprintf(stderr, "[" tag "] " fmt "\n", ## __VA_ARGS__) 15 | 16 | #ifdef DEBUG_MODE 17 | #define LOG_DEBUG(fmt, ...) _msg("D", fmt, ## __VA_ARGS__) 18 | #else 19 | #define LOG_DEBUG(fmt, ...) 20 | #endif 21 | 22 | #define LOG_INFO(fmt, ...) _msg("*", fmt, ## __VA_ARGS__) 23 | #define LOG_WARN(fmt, ...) _msg("!", fmt, ## __VA_ARGS__) 24 | #define LOG_FATAL(fmt, ...) { \ 25 | _msg("#", fmt, ## __VA_ARGS__); \ 26 | exit(-1); \ 27 | } 28 | 29 | #endif // _COMMON_LOGGING_H_ 30 | -------------------------------------------------------------------------------- /tracer/common/serialize.cc: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include 6 | #include 7 | 8 | #include "./bbtrace.pb.h" 9 | #include "./serialize.h" 10 | 11 | // Populate a protobuf Edge object 12 | static inline void serialize_populate_edge(bbtrace::Edge *output, 13 | const bbmap_edge &edge, 14 | unsigned int hit) { 15 | output->set_prev(edge.first); 16 | output->set_next(edge.second); 17 | output->set_hit(hit); 18 | } 19 | 20 | // Populate a protobuf Exception object 21 | static inline void 22 | serialize_populate_exception(bbtrace::Exception *output, 23 | const std::shared_ptr &exc) { 24 | output->set_tid(exc->tid()); 25 | output->set_pc(exc->pc()); 26 | output->set_faultyaddr(exc->faulty_addr()); 27 | 28 | // Set exception type 29 | switch (exc->type()) { 30 | case ExceptionAccessViolation: 31 | output->set_type(bbtrace::Exception::TYPE_VIOLATION); 32 | break; 33 | default: 34 | output->set_type(bbtrace::Exception::TYPE_UNKNOWN); 35 | break; 36 | } 37 | 38 | // Set faulty access type 39 | switch (exc->faulty_type()) { 40 | case ExceptionFaultyRead: 41 | output->set_access(bbtrace::Exception::ACCESS_READ); 42 | break; 43 | case ExceptionFaultyWrite: 44 | output->set_access(bbtrace::Exception::ACCESS_WRITE); 45 | break; 46 | case ExceptionFaultyExecute: 47 | output->set_access(bbtrace::Exception::ACCESS_EXECUTE); 48 | break; 49 | default: 50 | output->set_access(bbtrace::Exception::ACCESS_UNKNOWN); 51 | break; 52 | } 53 | 54 | // Stack trace 55 | for (stacktrace_iterator it_stack = exc->stacktrace_begin(); 56 | it_stack != exc->stacktrace_end(); it_stack++) { 57 | output->add_stacktrace(*it_stack); 58 | } 59 | } 60 | 61 | // Populate a protobuf Exception object 62 | static inline void 63 | serialize_populate_region(bbtrace::MemoryRegion *output, 64 | const MemoryRegion ®ion) { 65 | output->set_base(region.base); 66 | output->set_size(region.size); 67 | output->set_name(region.filename); 68 | } 69 | 70 | void serialize_trace(const std::string &filename, 71 | const ExecutionTrace &execution_trace) { 72 | bbtrace::Trace trace; 73 | 74 | // Create the trace header 75 | bbtrace::TraceHeader *header = trace.mutable_header(); 76 | header->set_magic(bbtrace::TraceHeader::TRACE_MAGIC); 77 | header->set_timestamp(time(NULL)); 78 | header->set_hash(execution_trace.basic_blocks.ComputeHash()); 79 | 80 | // Output basic block information 81 | for (bbmap_iterator it = execution_trace.basic_blocks.map_begin(); 82 | it != execution_trace.basic_blocks.map_end(); it++) { 83 | bbtrace::Edge *edge = trace.add_edge(); 84 | serialize_populate_edge(edge, it->first, it->second); 85 | } 86 | 87 | // Output recorded exceptions 88 | for (exceptions_iterator it = execution_trace.exceptions.begin(); 89 | it != execution_trace.exceptions.end(); it++) { 90 | bbtrace::Exception *exception = trace.add_exception(); 91 | serialize_populate_exception(exception, *it); 92 | } 93 | 94 | // Output memory-mapped regions 95 | for (auto it = execution_trace.memory_regions.begin(); 96 | it != execution_trace.memory_regions.end(); it++) { 97 | bbtrace::MemoryRegion *region = trace.add_region(); 98 | serialize_populate_region(region, *it); 99 | } 100 | 101 | std::fstream outstream(filename.c_str(), 102 | std::ios::out | std::ios::trunc | std::ios::binary); 103 | trace.SerializeToOstream(&outstream); 104 | } 105 | -------------------------------------------------------------------------------- /tracer/common/serialize.h: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | // Serialize trace data to file. 5 | // 6 | 7 | #ifndef _COMMON_SERIALIZE_H 8 | #define _COMMON_SERIALIZE_H 9 | 10 | #include 11 | #include 12 | 13 | #include "./common.h" 14 | #include "./bbmap.h" 15 | #include "./exception.h" 16 | 17 | typedef struct { 18 | target_addr base; 19 | unsigned int size; 20 | std::string filename; 21 | } MemoryRegion; 22 | 23 | typedef struct { 24 | // Map of basic block edges 25 | BBMap basic_blocks; 26 | 27 | // Tracked exceptions 28 | exceptions_list exceptions; 29 | 30 | // Mapped memory regions 31 | std::vector memory_regions; 32 | } ExecutionTrace; 33 | 34 | void serialize_trace(const std::string &filename, 35 | const ExecutionTrace &execution_trace); 36 | 37 | #endif // _COMMON_SERIALIZE_H 38 | -------------------------------------------------------------------------------- /tracer/pin/images.H: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #ifndef _IMAGES_H 6 | #define _IMAGES_H 7 | 8 | #include "pin.H" 9 | 10 | BOOL Images_IsInterestingAddress(ADDRINT addr); 11 | 12 | // Image loading callback 13 | VOID Images_CallbackNewImage(IMG img, VOID *v); 14 | 15 | #endif // _IMAGES_H 16 | -------------------------------------------------------------------------------- /tracer/pin/images.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | #include "images.H" 11 | #include "common/serialize.h" 12 | 13 | extern ExecutionTrace gbl_execution_trace; 14 | 15 | // Blacklisted image names 16 | static const std::string gbl_bad_images[] = { 17 | #if 0 18 | "/lib/x86_64-linux-gnu/libacl.so.1", 19 | "/lib/x86_64-linux-gnu/libattr.so.1", 20 | "/lib/x86_64-linux-gnu/libc.so.6", 21 | "/lib/x86_64-linux-gnu/libdl.so.2", 22 | "/lib/x86_64-linux-gnu/libpcre.so.3", 23 | "/lib/x86_64-linux-gnu/libselinux.so.1", 24 | "/lib64/ld-linux-x86-64.so.2", 25 | #endif 26 | }; 27 | 28 | // Vector of std::string for blacklisted memory images 29 | static const std::vector gbl_img_blacklist( 30 | gbl_bad_images, 31 | gbl_bad_images + sizeof(gbl_bad_images) / sizeof(gbl_bad_images[0]) 32 | ); 33 | 34 | // Lower/upper bounds of active images (i.e., those we are interested to trace) 35 | static std::vector > gbl_img_active; 36 | 37 | BOOL Images_IsInterestingAddress(ADDRINT addr) { 38 | BOOL b = FALSE; 39 | for (std::vector >::iterator it = 40 | gbl_img_active.begin(); 41 | it != gbl_img_active.end(); 42 | it++) { 43 | if (addr >= it->first && addr <= it->second) { 44 | b = TRUE; 45 | break; 46 | } 47 | } 48 | return b; 49 | } 50 | 51 | VOID Images_CallbackNewImage(IMG img, VOID *v) { 52 | // Check if the image is blacklisted 53 | const std::string name = IMG_Name(img); 54 | if (std::find(gbl_img_blacklist.begin(), gbl_img_blacklist.end(), name) 55 | != gbl_img_blacklist.end()) { 56 | return; 57 | } 58 | 59 | // Otherwise, add the image address range to the global "gbl_img_active" 60 | // vector, to keep track of which instructions must be processed 61 | std::pair range(IMG_LowAddress(img), IMG_HighAddress(img)); 62 | gbl_img_active.push_back(range); 63 | 64 | MemoryRegion region; 65 | region.base = IMG_LowAddress(img); 66 | region.size = IMG_HighAddress(img) - IMG_LowAddress(img); 67 | region.filename = IMG_Name(img); 68 | gbl_execution_trace.memory_regions.push_back(region); 69 | } 70 | -------------------------------------------------------------------------------- /tracer/pin/linux_exception.H: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | // Exception handling, Linux version. 5 | // 6 | 7 | #ifndef _LINUX_EXCEPTION_H 8 | #define _LINUX_EXCEPTION_H 9 | 10 | #include "pin.H" 11 | #include "common/exception.h" 12 | 13 | Exception* Linux_BuildException(THREADID tid, INT32 sig, 14 | const EXCEPTION_INFO *pExceptInfo); 15 | 16 | #endif // _LINUX_EXCEPTION_H 17 | -------------------------------------------------------------------------------- /tracer/pin/linux_exception.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | 5 | #include 6 | #include 7 | 8 | #include "linux_exception.H" 9 | 10 | Exception* Linux_BuildException(THREADID tid, INT32 sig, 11 | const EXCEPTION_INFO *pExceptInfo) { 12 | assert(sig == SIGSEGV); 13 | assert(pExceptInfo != NULL); 14 | assert(PIN_GetExceptionClass(PIN_GetExceptionCode(pExceptInfo)) == 15 | EXCEPTCLASS_ACCESS_FAULT); 16 | 17 | ADDRINT pc = PIN_GetExceptionAddress(pExceptInfo); 18 | 19 | // TODO(roby): check PIN_GetFaultyAccessAddress() return value 20 | ADDRINT faulty_addr = 0; 21 | PIN_GetFaultyAccessAddress(pExceptInfo, &faulty_addr); 22 | 23 | FAULTY_ACCESS_TYPE faulty_type = PIN_GetFaultyAccessType(pExceptInfo); 24 | 25 | Exception *exception = 26 | new Exception(tid, ExceptionAccessViolation, pc, faulty_addr, faulty_type); 27 | 28 | return exception; 29 | } 30 | -------------------------------------------------------------------------------- /tracer/pin/makefile: -------------------------------------------------------------------------------- 1 | ############################################################## 2 | # 3 | # DO NOT EDIT THIS FILE! 4 | # 5 | ############################################################## 6 | 7 | # If the tool is built out of the kit, PIN_ROOT must be specified in the make invocation and point to the kit root. 8 | ifdef PIN_ROOT 9 | CONFIG_ROOT := $(PIN_ROOT)/source/tools/Config 10 | else 11 | CONFIG_ROOT := ../Config 12 | endif 13 | include $(CONFIG_ROOT)/makefile.config 14 | include makefile.rules 15 | include $(TOOLS_ROOT)/Config/makefile.default.rules 16 | 17 | ############################################################## 18 | # 19 | # DO NOT EDIT THIS FILE! 20 | # 21 | ############################################################## 22 | -------------------------------------------------------------------------------- /tracer/pin/makefile.rules: -------------------------------------------------------------------------------- 1 | TEST_TOOL_ROOTS := 2 | TEST_ROOTS := 3 | SANITY_SUBSET := 4 | TOOL_ROOTS := pintrace 5 | SA_TOOL_ROOTS := 6 | APP_ROOTS := 7 | OBJECT_ROOTS := 8 | DLL_ROOTS := 9 | LIB_ROOTS := 10 | 11 | TOOL_CXXFLAGS += -I../ -std=c++11 12 | TOOL_LPATHS += -L../common/ 13 | TOOL_LIBS += -lprotobuf -ltracer 14 | TOOL_OBJS = \ 15 | $(OBJDIR)pintrace$(OBJ_SUFFIX) \ 16 | $(OBJDIR)images$(OBJ_SUFFIX) 17 | 18 | # Windows-specific objects 19 | ifeq ($(TARGET_OS),windows) 20 | TOOL_OBJS += $(OBJDIR)win_exception$(OBJ_SUFFIX) 21 | endif 22 | 23 | # Linux-specific objects 24 | ifeq ($(TARGET_OS),linux) 25 | TOOL_OBJS += $(OBJDIR)linux_exception$(OBJ_SUFFIX) 26 | endif 27 | 28 | libtracer=../common/libtracer.a 29 | 30 | .PHONY: $(libtracer) 31 | $(libtracer): 32 | @$(MAKE) -C $(dir $(libtracer)) 33 | 34 | $(OBJDIR)pintrace$(PINTOOL_SUFFIX): $(libtracer) $(TOOL_OBJS) 35 | $(LINKER) $(TOOL_LDFLAGS) $(LINK_EXE)$@ $(TOOL_OBJS) $(TOOL_LPATHS) $(TOOL_LIBS) 36 | -------------------------------------------------------------------------------- /tracer/pin/pintrace.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Copyright 2015, Roberto Paleari (@rpaleari) and Aristide Fattori (@joystick) 3 | // 4 | // Basic BB tracer. 5 | // 6 | 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | #include "pin.H" 14 | 15 | #include "common/bbmap.h" 16 | #include "common/exception.h" 17 | #include "common/serialize.h" 18 | #include "images.H" 19 | 20 | #ifdef _WIN32 21 | // Windows 22 | #include "win_exception.H" 23 | #else 24 | // Linux 25 | #include 26 | #include "linux_exception.H" 27 | #endif 28 | 29 | static const std::string DEFAULT_OUTFILE = "/dev/shm/trace.bin"; 30 | static const int MAX_STACKTRACE_SIZE = 16; 31 | 32 | // Globals 33 | ExecutionTrace gbl_execution_trace; 34 | 35 | // Map to keep track of last observed basic block, for each application thread 36 | static std::map gbl_last_bb; 37 | 38 | // Command line switches 39 | KNOB gbl_outfile(KNOB_MODE_WRITEONCE, "pintool", "f", DEFAULT_OUTFILE, 40 | "specify file name for FuzzTrace output"); 41 | 42 | // Print help message 43 | INT32 Usage() { 44 | cerr << KNOB_BASE::StringKnobSummary() << endl; 45 | return -1; 46 | } 47 | 48 | static void build_stacktrace(const CONTEXT *context, Exception *exc) { 49 | // Generate a stack trace for this process 50 | ADDRINT retaddr; 51 | ADDRINT fp = PIN_GetContextReg(context, REG_GBP); 52 | 53 | for (int i = 0; i < MAX_STACKTRACE_SIZE; i++) { 54 | // Read the return address of current stack frame 55 | size_t nbytes = 56 | PIN_SafeCopy(&retaddr, 57 | reinterpret_cast(fp + sizeof(ADDRINT)), 58 | sizeof(ADDRINT)); 59 | 60 | if (nbytes != sizeof(ADDRINT)) { 61 | break; 62 | } 63 | 64 | // Save this return address 65 | exc->stacktrace_push(retaddr); 66 | // printf("ret%d @0x%lx -> 0x%lx\n", i, fp+sizeof(ADDRINT), retaddr); 67 | 68 | // Read the address of the next stack frame 69 | nbytes = 70 | PIN_SafeCopy(&fp, reinterpret_cast(fp), sizeof(ADDRINT)); 71 | 72 | if (nbytes != sizeof(ADDRINT)) { 73 | break; 74 | } 75 | } 76 | } 77 | 78 | // Instrumentation callback 79 | VOID CallbackTrace(TRACE trace, VOID *v) { 80 | // Visit every basic block in the trace 81 | for (BBL bbl = TRACE_BblHead(trace); BBL_Valid(bbl); bbl = BBL_Next(bbl)) { 82 | ADDRINT bb_current = BBL_Address(bbl); 83 | 84 | if (!Images_IsInterestingAddress(bb_current)) { 85 | continue; 86 | } 87 | 88 | // Compute the (bb_previous, bb_current) pair, that determines the brach 89 | // that has been taken by the application 90 | THREADID tid = PIN_ThreadId(); 91 | 92 | // If we have no previous BB, skip 93 | if (gbl_last_bb.find(tid) != gbl_last_bb.end()) { 94 | ADDRINT bb_previous = gbl_last_bb[tid]; 95 | gbl_execution_trace.basic_blocks.AddEdge(bb_previous, bb_current); 96 | } 97 | 98 | gbl_last_bb[tid] = bb_current; 99 | } 100 | } 101 | 102 | #ifdef _WIN32 103 | // Windows-only 104 | VOID CallbackContextChangeWindows(THREADID tid, CONTEXT_CHANGE_REASON reason, 105 | const CONTEXT *from, CONTEXT *to, INT32 info, 106 | VOID *v) { 107 | if (reason != CONTEXT_CHANGE_REASON_EXCEPTION) { 108 | return; 109 | } 110 | } 111 | #else 112 | // Linux-only 113 | BOOL CallbackSignalLinux(THREADID tid, INT32 sig, CONTEXT *ctxt, 114 | BOOL hasHandler, const EXCEPTION_INFO *pExceptInfo, 115 | VOID *v) { 116 | Exception *exception = Linux_BuildException(tid, sig, pExceptInfo); 117 | build_stacktrace(ctxt, exception); 118 | gbl_execution_trace.exceptions.push_back(std::shared_ptr 119 | (exception)); 120 | 121 | // Always pass the exception to the application 122 | return TRUE; 123 | } 124 | #endif 125 | 126 | // Termination callback 127 | VOID CallbackFini(INT32 code, VOID *v) { 128 | string filename = gbl_outfile.Value(); 129 | 130 | serialize_trace(filename, gbl_execution_trace); 131 | } 132 | 133 | int main(int argc, char **argv) { 134 | // Initialize PIN library and check command-line 135 | if (PIN_Init(argc, argv)) { 136 | return Usage(); 137 | } 138 | 139 | IMG_AddInstrumentFunction(Images_CallbackNewImage, 0); 140 | TRACE_AddInstrumentFunction(CallbackTrace, 0); 141 | 142 | #ifdef _WIN32 143 | // Callback for context changes (e.g., exceptions). Windows only. 144 | PIN_AddContextChangeFunction(CallbackContextChangeWindows, 0); 145 | #else 146 | // Callback for SEGVs. Linux only. 147 | PIN_InterceptSignal(SIGSEGV, CallbackSignalLinux, 0); 148 | #endif 149 | 150 | // Callback for application termination 151 | PIN_AddFiniFunction(CallbackFini, 0); 152 | 153 | // Start the program, never returns 154 | PIN_StartProgram(); 155 | 156 | return 0; 157 | } 158 | -------------------------------------------------------------------------------- /viewer/bbtrace.proto: -------------------------------------------------------------------------------- 1 | ../tracer/common/bbtrace.proto -------------------------------------------------------------------------------- /viewer/trace.py: -------------------------------------------------------------------------------- 1 | """ 2 | Execution trace object. 3 | 4 | Copyright 2014, Roberto Paleari (@rpaleari) 5 | """ 6 | 7 | import datetime 8 | import hashlib 9 | import logging 10 | import os 11 | import struct 12 | 13 | import bbtrace_pb2 14 | 15 | class MemoryRegion(object): 16 | """Mapped memory region, possibly associated to a filename.""" 17 | def __init__(self, obj): 18 | self.base = obj.base 19 | self.size = obj.size 20 | self.name = obj.name 21 | 22 | def get_lower(self): 23 | return self.base 24 | 25 | def get_upper(self): 26 | return self.base + self.size - 1 27 | 28 | def get_name(self): 29 | return self.name 30 | 31 | def has(self, addr): 32 | """Check if the specified address belongs to this region.""" 33 | return self.get_lower() <= addr <= self.get_upper() 34 | 35 | class CrashException(object): 36 | """Exception observed during program execution.""" 37 | def __init__(self, obj, timestamp): 38 | """Constructor for the CrashException class.""" 39 | self.timestamp = timestamp 40 | self.exc_type = obj.type 41 | self.exc_pc = obj.pc 42 | self.faultyaddr = obj.faultyaddr 43 | self.access = obj.access 44 | self.hashz = None 45 | 46 | # Update hash value for this exception 47 | self.__update_hash() 48 | assert self.hashz is not None 49 | 50 | def is_valid(self): 51 | """Return True if this exception object is valid.""" 52 | if self.hashz is None: 53 | return False 54 | 55 | return True 56 | 57 | def __update_hash(self): 58 | """Update the hash value that uniquely characterizes this object.""" 59 | md5 = hashlib.md5() 60 | md5.update("%d" % self.exc_type) 61 | md5.update("%x" % self.exc_pc) 62 | md5.update("%x" % self.faultyaddr) 63 | md5.update("%d" % self.access) 64 | self.hashz = md5.hexdigest() 65 | 66 | def __str__(self): 67 | s = "type: %d, pc: 0x%x, addr: 0x%x, access: %d" % ( 68 | self.exc_type, self.exc_pc, self.faultyaddr, self.access) 69 | return s 70 | 71 | class ExecutionTrace(object): 72 | """Single execution of a target process.""" 73 | 74 | MAP_EXCEPTION_TYPE = { 75 | bbtrace_pb2.Exception.TYPE_UNKNOWN: "unknown", 76 | bbtrace_pb2.Exception.TYPE_VIOLATION: "violation", 77 | } 78 | 79 | MAP_EXCEPTION_ACCESS = { 80 | bbtrace_pb2.Exception.ACCESS_UNKNOWN: "unknown", 81 | bbtrace_pb2.Exception.ACCESS_READ: "read", 82 | bbtrace_pb2.Exception.ACCESS_WRITE: "write", 83 | bbtrace_pb2.Exception.ACCESS_EXECUTE: "execute", 84 | } 85 | 86 | def __init__(self, cmdline, tracefile, inputdata = None, deps = None): 87 | """Constructor for the ExecutionTrace class. 88 | 89 | Keyword arguments: 90 | cmdline -- process command line (list of arguments). 91 | tracefile -- name of the trace file (must exist). 92 | inputdata -- data feed to the program via stdin (can be None). 93 | deps -- other file names this execution depends on (can be None). 94 | """ 95 | self.cmdline = cmdline 96 | self.inputdata = inputdata 97 | self.deps = set() 98 | 99 | # Ensure all dependecies actually exist 100 | if deps is not None: 101 | assert all([os.path.exists(x) for x in deps]) 102 | self.deps |= deps 103 | 104 | # Read data 105 | self.tracefile = tracefile 106 | f = open(tracefile, "rb") 107 | data = f.read() 108 | f.close() 109 | 110 | # Parse object 111 | obj = bbtrace_pb2.Trace() 112 | obj.ParseFromString(data) 113 | assert obj.header.magic == bbtrace_pb2.TraceHeader.TRACE_MAGIC 114 | 115 | self.timestamp = datetime.datetime.fromtimestamp(obj.header.timestamp) 116 | self.hashz = "%x" % obj.header.hash 117 | 118 | # Prepare the list of CFG edges observed in this execution 119 | # NOTE: We ignore the execution order of CFG edges 120 | self.edges = list(set([(e.prev, e.next, e.hit) for e in obj.edge])) 121 | self.edges.sort() 122 | 123 | # Create the list of CrashException object, representing exceptions 124 | # risen during this execution 125 | self.exceptions = [] 126 | for e in obj.exception: 127 | exception = CrashException(e, self.timestamp) 128 | self.exceptions.append(exception) 129 | 130 | # Parse memory-mapped regions 131 | self.regions = [] 132 | for m in obj.region: 133 | region = MemoryRegion(m) 134 | self.regions.append(region) 135 | self.regions.sort(cmp=lambda a,b: cmp(a.base, b.base)) 136 | 137 | @staticmethod 138 | def exception_type_str(n): 139 | return ExecutionTrace.MAP_EXCEPTION_TYPE.get(n) 140 | 141 | @staticmethod 142 | def exception_access_str(n): 143 | return ExecutionTrace.MAP_EXCEPTION_ACCESS.get(n) 144 | 145 | def purge(self): 146 | """Deletes all the dependency files of this execution trace.""" 147 | if os.path.isfile(self.tracefile): 148 | logging.debug("Removing trace file %s", self.tracefile) 149 | os.unlink(self.tracefile) 150 | 151 | for dep in self.deps: 152 | logging.debug("Removing dependency file %s", dep) 153 | os.unlink(dep) 154 | 155 | def is_valid(self): 156 | """Return True if this execution trace is valid.""" 157 | if not os.path.isfile(self.tracefile): 158 | return False 159 | 160 | for dep in self.deps: 161 | if not os.path.isfile(dep): 162 | return False 163 | 164 | return True 165 | 166 | def update_hash(self): 167 | """Re-compute the hash value for this execution trace.""" 168 | # Compute the hash as MD5 of CFG edges 169 | md5 = hashlib.md5() 170 | for bb_prev, bb_next, hit in self.edges: 171 | md5.update(struct.pack("L", bb_prev)) 172 | md5.update(struct.pack("L", bb_next)) 173 | self.hashz = md5.hexdigest() 174 | 175 | def __str__(self): 176 | """Return a concise string representation of this execution trace.""" 177 | s = ("[%s] cmd: %s, data: %d bytes, time: %s, " 178 | "hash: %s, edges(s): %d, exception(s): %d" % 179 | (self.tracefile, " ".join(self.cmdline), 180 | len(self.inputdata) if self.inputdata is not None else 0, 181 | self.timestamp, self.hashz, len(self.edges), 182 | len(self.exceptions))) 183 | return s 184 | 185 | def pretty_print(self): 186 | """ 187 | Print this Trace object to standard output. 188 | 189 | Compared to __str__(), this method provides a more verbose 190 | representation of the object. 191 | """ 192 | 193 | print "#### Trace '%s' ####" % self.tracefile 194 | print trace 195 | print 196 | 197 | print " - CFG edges" 198 | for e_prev, e_next, e_hit in trace.edges: 199 | print " [%08x -> %08x] %d hit" % (e_prev, e_next, e_hit) 200 | 201 | if len(trace.exceptions) > 0: 202 | print 203 | print " - Exceptions" 204 | for exc in trace.exceptions: 205 | print (" type: %s, pc: 0x%08x, faultyaddr: 0x%08x, " 206 | "access: %s" % ( 207 | ExecutionTrace.exception_type_str(exc.exc_type), 208 | exc.exc_pc, exc.faultyaddr, 209 | ExecutionTrace.exception_access_str(exc.access))) 210 | 211 | if len(trace.regions) > 0: 212 | print 213 | print " - Memory regions" 214 | for region in trace.regions: 215 | print " [0x%08x, 0x%08x] %s" % (region.get_lower(), 216 | region.get_upper(), 217 | region.get_name()) 218 | 219 | 220 | if __name__ == "__main__": 221 | # Parse an execution trace and print it out, optionally performing a "diff" 222 | # between two traces 223 | import argparse 224 | import sys 225 | 226 | # Parse command-line arguments 227 | parser = argparse.ArgumentParser( 228 | formatter_class=argparse.ArgumentDefaultsHelpFormatter) 229 | parser.add_argument("-d", "--diff", default=False, action="store_true", 230 | help="perform a diff between two trace files") 231 | parser.add_argument("tracefiles", metavar="TRACE", nargs="+", 232 | help="trace files") 233 | args = parser.parse_args() 234 | 235 | # Parse trace files 236 | traces = [] 237 | for filename in args.tracefiles: 238 | trace = ExecutionTrace(["test",], filename) 239 | traces.append(trace) 240 | 241 | if args.diff: 242 | assert len(traces) == 2 243 | print ("#### Comparing %s vs %s ####" % 244 | (traces[0].tracefile, traces[1].tracefile)) 245 | print 246 | 247 | edge0 = set([(e_prev, e_next) for e_prev, e_next, _ in traces[0].edges]) 248 | edge1 = set([(e_prev, e_next) for e_prev, e_next, _ in traces[1].edges]) 249 | 250 | for filename, setz in ( 251 | (traces[0].tracefile, edge0 - edge1), 252 | (traces[1].tracefile, edge1 - edge0), 253 | ): 254 | print "- Only in %s, %d edge(s)" % (filename, len(setz)) 255 | edges = list(setz) 256 | edges.sort() 257 | for edge_prev, edge_next in edges: 258 | print "- 0x%08x -> 0x%08x" % (edge_prev, edge_next) 259 | print 260 | 261 | else: 262 | # Just print traces to stdout 263 | for trace in traces: 264 | trace.pretty_print() 265 | --------------------------------------------------------------------------------