dyninstAPI/tests/src/test2.C

   1
   2 //
   3 //
   4 // libdyninst validation suite test #2
   5 //    Author: Jeff Hollingsworth (7/10/97)
   6 //
   7
   8 //  This program tests the error features of the dyninst API.
   9 //      The mutatee that goes with this file is test2.mutatee.c
  10 //
  11 //  Naming conventions:
  12 //      All functions, variables, etc are name funcXX_YY, exprXX_YY, etc.
  13 //          XX is the test number
  14 //          YY is the instance withing the test
  15 //          func1_2 is the second function used in test case #1.
  16 //
  17
  18 #include <stdio.h>
  19 #include <signal.h>
  20 #include <string.h>
  21 #ifdef i386_unknown_nt4_0
  22 #include <io.h>
  23 #define WIN32_LEAN_AND_MEAN
  24 #include <windows.h>
  25 #else
  26 #include <unistd.h>
  27 #endif
  28
  29 #include "BPatch.h"
  30 #include "BPatch_Vector.h"
  31 #include "BPatch_thread.h"
  32 #include "BPatch_snippet.h"
  33 #include "test_util.h"
  34 #include "test2.h"
  35
  36 #ifdef i386_unknown_nt4_0
  37 #define access _access
  38 #define unlink _unlink
  39 #define F_OK 0
  40 #endif
  41
  42 #ifdef i386_unknown_nt4_0
  43 #define MUTATEE_NAME    "test2.mutatee.exe"
  44 #else
  45 #define MUTATEE_NAME    "./test2.mutatee"
  46 #endif
  47
  48 int debugPrint = 0;
  49 bool expectErrors = false;
  50 bool gotError = false;
  51
  52 BPatch *bpatch;
  53
  54 // control debug printf statements
  55 #define dprintf if (debugPrint) printf
  56
  57 BPatch_thread *mutatorMAIN(char *pathname, bool useAttach)
  58 {
  59     BPatch_thread *appThread;
  60
  61     // Start the mutatee
  62     printf("Starting \"%s\"\n", pathname);
  63
  64     char *child_argv[4];
  65
  66     int n = 0;
  67     child_argv[n++] = pathname;
  68     if (useAttach) child_argv[n++] = "-attach";
  69     if (debugPrint) child_argv[n++] = "-verbose";
  70     child_argv[n] = NULL;
  71
  72     if (useAttach) {
  73         int pid = startNewProcess(pathname, child_argv);
  74         if (pid < 0 && !expectErrors) {
  75             printf("*ERROR*: unable to start tests due to error starting mutatee process\n");
  76             exit(-1);
  77         }
  78         appThread = bpatch->attachProcess(pathname, pid);
  79     } else {
  80         appThread = bpatch->createProcess(pathname, child_argv);
  81     }
  82     return appThread;
  83 }
  84
  85 void errorFunc(BPatchErrorLevel level, int num, const char **params)
  86 {
  87     char line[256];
  88
  89     const char *msg = bpatch->getEnglishErrorString(num);
  90     bpatch->formatErrorString(line, sizeof(line), msg, params);
  91
  92     gotError = true;
  93
  94     if (expectErrors) {
  95         if (debugPrint)
  96             printf("Error (expected) #%d (level %d): %s\n", num, level, line);
  97     } else {
  98         printf("Error #%d (level %d): %s\n", num, level, line);
  99     }
 100 }
 101
 102 //
 103 // main - decide our role and call the correct "main"
 104 //
 105 main(int argc, char *argv[])
 106 {
 107     BPatch_thread *ret;
 108     bool useAttach = false;
 109     bool failed = false;
 110
 111     // Create an instance of the bpatch library
 112     bpatch = new BPatch;
 113
 114     bpatch->registerErrorCallback(errorFunc);
 115
 116     int i;
 117     for (i=1; i < argc; i++) {
 118         if (!strcmp(argv[i], "-verbose")) {
 119             debugPrint = 1;
 120         } else if (!strcmp(argv[i], "-attach")) {
 121             useAttach = true;
 122         } else {
 123             fprintf(stderr, "Usage: test1 [-attach] [-verbose]\n");
 124             exit(-1);
 125         }
 126     }
 127
 128 #if defined(sparc_sun_sunos4_1_3)
 129     if (useAttach) {
 130         printf("Attach is not supported on this platform.\n");
 131         exit(1);
 132     }
 133 #endif
 134
 135     // Try failure cases
 136     expectErrors = true;
 137
 138     if (useAttach) {
 139         printf("Skipping test #1 (run an executable that does not exist)\n");
 140         printf("    not relevant with -attach option\n");
 141     } else {
 142         // try to run a program that does not exist
 143         gotError = false;
 144         ret = mutatorMAIN("./noSuchFile", useAttach);
 145         if (ret || !gotError) {
 146             failed = true;
 147             printf("**Failed** test #1 (run an executable that does not exist)\n");
 148             if (ret)
 149                 printf("    created a thread handle for a non-existant file\n");
 150             if (!gotError)
 151                 printf("    the error callback should have been called but wasn't\n");
 152         } else {
 153             printf("Passed test #1 (run an executable that does not exist)\n");
 154         }
 155     }
 156
 157     // try to run a files that is not a valid program
 158     gotError = false;
 159 #ifdef i386_unknown_nt4_0
 160     ret = mutatorMAIN("nul:", false);
 161 #else
 162     ret = mutatorMAIN("/dev/null", false);
 163 #endif
 164     if (ret || !gotError) {
 165         printf("**Failed** test #2 (try to execute a file that is not a valid program)\n");
 166         failed = true;
 167         if (ret)
 168             printf("    created a thread handle for invalid executable\n");
 169         if (!gotError)
 170             printf("    the error callback should have been called but wasn't\n");
 171     } else {
 172         printf("Passed test #2 (try to execute a file that is not a valid program)\n");
 173     }
 174
 175 #if defined(sparc_sun_sunos4_1_3)
 176     printf("Skipping test #3 (attach to an invalid pid)\n");
 177     printf("Skipping test #4 (attach to a protected pid)\n");
 178     printf("    attach is not supported on this platform\n");
 179 #else
 180     // attach to an an invalid pid
 181     gotError = false;
 182     ret = bpatch->attachProcess(MUTATEE_NAME, 65539);
 183     if (ret || !gotError) {
 184         printf("**Failed** test #3 (attach to an invalid pid)\n");
 185         failed = true;
 186         if (ret)
 187             printf("    created a thread handle for invalid executable\n");
 188         if (!gotError)
 189             printf("    the error callback should have been called but wasn't\n");
 190     } else {
 191         printf("Passed test #3 (attach to an invalid pid)\n");
 192     }
 193
 194     // attach to an a protected pid
 195     gotError = false;
 196     ret = bpatch->attachProcess(MUTATEE_NAME, 1);
 197     if (ret || !gotError) {
 198         printf("**Failed** test #4 (attach to a protected pid)\n");
 199         failed = true;
 200         if (ret)
 201             printf("    created a thread handle for invalid executable\n");
 202         if (!gotError)
 203             printf("    the error callback should have been called but wasn't\n");
 204     } else {
 205         printf("Passed test #4 (attach to a protected pid)\n");
 206     }
 207 #endif
 208
 209     // Finished trying failure cases
 210     expectErrors = false;
 211
 212     // now start a real program
 213     gotError = false;
 214     ret = mutatorMAIN(MUTATEE_NAME, false);
 215     if (!ret || gotError) {
 216         printf("*ERROR*: unable to create handle for executable\n");
 217         failed = true;
 218     }
 219
 220     BPatch_image *img = ret->getImage();
 221
 222     gotError = false;
 223     BPatch_function *func = img->findFunction("NoSuchFunction");
 224     if (func || !gotError) {
 225         printf("**Failed** test #5 (look up nonexistent function)\n");
 226         failed = true;
 227         if (func)
 228             printf("    non-null for findFunction on non-existant func\n");
 229         if (!gotError)
 230             printf("    the error callback should have been called but wasn't\n");
 231     } else {
 232         printf("Passed test #5 (look up nonexistent function)\n");
 233     }
 234
 235     ret->continueExecution();
 236
 237 #ifndef sparc_sun_solaris2_4
 238     printf("Skipping test #6 (load a dynamically linked library)\n");
 239     printf("    feature not implemented on this platform\n");
 240 #else
 241     waitUntilStopped(ret, 6, "load a dynamically linked library");
 242
 243     // see if the dlopen happended.
 244     bool found = false;
 245     BPatch_Vector<BPatch_module *> *m = img->getModules();
 246     for (i=0; i < m->size(); i++) {
 247             char name[80];
 248             (*m)[i]->getName(name, sizeof(name));
 249             if (strcmp(name, TEST_DYNAMIC_LIB) == 0) {
 250                 found = true;
 251                 break;
 252             }
 253     }
 254     if (found) {
 255         printf("Passed test #6 (load a dynamically linked library)\n");
 256     } else {
 257         printf("**Failed** test #6 (load a dynamically linked library)\n");
 258         printf("    image::getModules() did not indicate that the library had been loaded\n");
 259         failed = true;
 260     }
 261
 262     ret->continueExecution();
 263 #endif
 264
 265     ret->stopExecution();
 266
 267 #ifndef sparc_sun_sunos4_1_3
 268     printf("Skipping test #7 (dump core but do not terminate)\n");
 269     printf("    BPatch_thread::dumpCore() not implemented on this platform\n");
 270 #else
 271     // dump core, but do not terminate.
 272     // this doesn't seem to do anything - jkh 7/12/97
 273     if (access("mycore", F_OK) == 0) {
 274         printf("File \"mycore\" exists.  Deleting it.\n");
 275         if (unlink("mycore") != 0) {
 276             printf("Couldn't delete the file \"mycore\".  Exiting.\n");
 277             exit(-1);
 278         }
 279     }
 280
 281     gotError = false;
 282     ret->dumpCore("mycore", true);
 283     bool coreExists = (access("mycore", F_OK) == 0);
 284     if (gotError || !coreExists) {
 285         printf("**Failed** test #7 (dump core but do not terminate)\n");
 286         failed = true;
 287         if (gotError)
 288             printf("    error reported by dumpCore\n");
 289         if (!coreExists)
 290             printf("    the core file wasn't written\n");
 291     } else {
 292         printf("Passed test #7 (dump core but do not terminate)\n");
 293     }
 294 #endif
 295
 296 #if !defined(rs6000_ibm_aix4_1) && !defined(sparc_sun_sunos4_1_3)
 297      printf("Skipping test #8 (dump image)\n");
 298     printf("    BPatch_thread::dumpImage() not implemented on this platform\n");
 299 #else
 300     // dump image
 301     if (access("myimage", F_OK) == 0) {
 302         printf("File \"myimage\" exists.  Deleting it.\n");
 303         if (unlink("myimage") != 0) {
 304             printf("Couldn't delete the file \"myimage\".  Exiting.\n");
 305             exit(-1);
 306         }
 307     }
 308
 309     gotError = false;
 310     ret->dumpImage("myimage");
 311     bool imageExists = (access("myimage", F_OK) == 0);
 312     if (gotError || !imageExists) {
 313         printf("**Failed** test #8 (dump image)\n");
 314         failed = true;
 315         if (gotError)
 316             printf("    error reported by dumpImage\n");
 317         if (!imageExists)
 318             printf("    the image file wasn't written\n");
 319     } else {
 320         printf("Passed test #8 (dump image)\n");
 321     }
 322 #endif
 323
 324     int pid = ret->getPid();
 325
 326 #ifndef i386_unknown_nt4_0 /* Not yet implemented on NT. */
 327     // detach from the process.
 328     ret->detach(true);
 329 #endif
 330
 331     // now kill the process.
 332 #ifdef i386_unknown_nt4_0
 333     HANDLE h = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid);
 334     if (h != NULL) {
 335         TerminateProcess(h, 0);
 336         CloseHandle(h);
 337     }
 338 #else
 339     kill(pid, SIGKILL);
 340 #endif
 341
 342     delete (ret);
 343     BPatch_Vector<BPatch_thread *> *threads = bpatch->getThreads();
 344     for (i=0; i < threads->size(); i++) {
 345         if ((*threads)[i] == ret) {
 346             printf("**Failed** test #7 (delete thread)\n");
 347             printf("    thread %d was deleted, but getThreads found it\n",
 348                 ret->getPid());
 349             failed = true;
 350         }
 351     }
 352
 353     delete (bpatch);
 354
 355     if (failed) {
 356         printf("**Failed** tests\n");
 357     } else {
 358         printf("Passed all tests\n");
 359     }
 360
 361
 362     return 0;
 363 }