15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2005, Google Inc. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// --- 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: Craig Silverstein 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This verifies that GetPC works correctly. This test uses a minimum 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// of Google infrastructure, to make it very easy to port to various 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// O/Ses and CPUs and test that GetPC is working. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "config.h" 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "getpc.h" // should be first to get the _GNU_SOURCE dfn 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdio.h> 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdlib.h> 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <signal.h> 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/time.h> // for setitimer 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Needs to be volatile so compiler doesn't try to optimize it away 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static volatile void* getpc_retval = NULL; // what GetPC returns 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static volatile bool prof_handler_called = false; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void prof_handler(int sig, siginfo_t*, void* signal_ucontext) { 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!prof_handler_called) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) getpc_retval = GetPC(*reinterpret_cast<ucontext_t*>(signal_ucontext)); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prof_handler_called = true; // only store the retval once 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void RoutineCallingTheSignal() { 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct sigaction sa; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sa.sa_sigaction = prof_handler; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sa.sa_flags = SA_RESTART | SA_SIGINFO; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sigemptyset(&sa.sa_mask); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (sigaction(SIGPROF, &sa, NULL) != 0) { 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) perror("sigaction"); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) exit(1); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct itimerval timer; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) timer.it_interval.tv_sec = 0; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) timer.it_interval.tv_usec = 1000; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) timer.it_value = timer.it_interval; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setitimer(ITIMER_PROF, &timer, 0); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Now we need to do some work for a while, that doesn't call any 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // other functions, so we can be guaranteed that when the SIGPROF 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fires, we're the routine executing. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int r = 0; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (int i = 0; !prof_handler_called; ++i) { 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (int j = 0; j < i; j++) { 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r ^= i; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r <<= 1; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r ^= j; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) r >>= 1; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Now make sure the above loop doesn't get optimized out 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) srand(r); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is an upper bound of how many bytes the instructions for 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// RoutineCallingTheSignal might be. There's probably a more 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// principled way to do this, but I don't know how portable it would be. 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (The function is 372 bytes when compiled with -g on Mac OS X 10.4. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// I can imagine it would be even bigger in 64-bit architectures.) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const int kRoutineSize = 512 * sizeof(void*)/4; // allow 1024 for 64-bit 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int main(int argc, char** argv) { 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RoutineCallingTheSignal(); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Annoyingly, C++ disallows casting pointer-to-function to 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pointer-to-object, so we use a C-style cast instead. 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* expected = (char*)&RoutineCallingTheSignal; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* actual = (char*)getpc_retval; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For ia64, ppc64, and parisc64, the function pointer is actually 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a struct. For instance, ia64's dl-fptr.h: 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // struct fdesc { /* An FDESC is a function descriptor. */ 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ElfW(Addr) ip; /* code entry point */ 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ElfW(Addr) gp; /* global pointer */ 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // }; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We want the code entry point. 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(__ia64) || defined(__ppc64) // NOTE: ppc64 is UNTESTED 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) expected = ((char**)expected)[0]; // this is "ip" 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (actual < expected || actual > expected + kRoutineSize) { 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) printf("Test FAILED: actual PC: %p, expected PC: %p\n", actual, expected); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 1; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) printf("PASS\n"); 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 121