Fixes for interactive control:

- callgrind_control was not working, because it checks the
  "command syntax version" to be at most 1 before doing anything.
  But callgrind used Valgrinds version for this (3.2.0). Now we
  define a separate version COMMAND_VERSION for the syntax format
  of control and result files.
  Strictly, such a version is not needed for interaction of
  callgrind and the script callgrind_control itself, as they are
  delivered in the same package. But there are also external
  controlling tools (most notable KCachegrind)

- Some systems make it difficult for callgrind_control to
  automatically detect running callgrind processes. To make
  interactivity work, one has to provide the cwd with -w.
  For commands expecting a result from callgrind, this result
  was delivered in the wrong result file.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5861

diff --git a/callgrind/callgrind_control.in b/callgrind/callgrind_control.in
index 869c9b3af397a2319c51ddf4d9f15fa07c399e15..7ce632116af51d5acad720ca4d053133cfc06c10 100644 (file)
--- a/callgrind/callgrind_control.in
+++ b/callgrind/callgrind_control.in
@@ -37,7 +37,7 @@ sub getCallgrindPids {
     open MAP, "<$mapfile";
     $found = 0;
     while(<MAP>) {
-      # works both for VG 3.0 and VG 3.1
+      # works both for VG 3.0 and VG 3.1+
       if (/callgrind/) { $found = 1; }
     }
     close MAP;
@@ -54,7 +54,7 @@ sub getCallgrindPids {
     close INFO;
 
     if ($mversion{$pid} > 1) {
-      #print " Unsupported Callgrind Major Version $mversion.\n\n";
+      print " $pid: Unsupported command interface (version $mversion) ?!\n\n";
       next;
     }
 
@@ -290,12 +290,11 @@ foreach $arg (@ARGV) {
 if ($workingDir ne "") {
     # Generate dummy information for dummy pid 0
     $pid = "0";
-    $mversion{$pid} = "@VERSION@";
+    $mversion{$pid} = "1.0";
     $cmd{$pid} = "???";
     $base{$pid} = $workingDir;
     $control{$pid} = "$workingDir/callgrind.cmd";
-    # do not wait for any result...
-    $result{$pid} = "";
+    $result{$pid} = "$workingDir/callgrind.res";
 
     # Only handle this faked callgrind run
     @pids = ($pid);
@@ -328,7 +327,7 @@ if ($printStatus || $printBacktrace || $requestEvents) {
 
 foreach $pid (@pids) {
   $pidstr = "PID $pid: ";
-  print $pidstr.$cmd{$pid};
+  if ($pid >0) { print $pidstr.$cmd{$pid}; }
 
   if ($command eq "") {
     if ($printLong) {
@@ -355,6 +354,7 @@ foreach $pid (@pids) {
     }
   }
 
+  #print "Reading ".$result{$pid}. "...\n";
   if ($result{$pid} eq "") { $waitForAnswer=0; }
   if (!$waitForAnswer) { print "  OK.\n"; next; }
 

diff --git a/callgrind/command.c b/callgrind/command.c
index 23c14d9025372dec61ee4fdc527217506d957b37..fcd2cca6dd7dd4cb7f9541b8c81fef360f9af07d 100644 (file)
--- a/callgrind/command.c
+++ b/callgrind/command.c
@@ -34,11 +34,17 @@
 
 #include <pub_tool_threadstate.h> // VG_N_THREADS
 
+// Version for the syntax in command/result files for interactive control
+#define COMMAND_VERSION "1.0"
+
 static Char outbuf[FILENAME_LEN + FN_NAME_LEN + OBJ_NAME_LEN];
 
 static Char* command_file = 0;
 static Char* command_file2 = 0;
+static Char* current_command_file = 0;
 static Char* result_file = 0;
+static Char* result_file2 = 0;
+static Char* current_result_file = 0;
 static Char* info_file = 0;
 static Char* dump_base = 0;
 
@@ -60,7 +66,6 @@ void CLG_(init_command)(Char* dir, Char* dumps)
   /* This is for compatibility with the "Force Now" Button of current
    * KCachegrind releases, as it doesn't use ".pid" to distinguish
    * different callgrind instances from same base directory.
-   * Should be removed sometimes in the future (29.10.03)
    */
   command_file2 = (char*) CLG_MALLOC(size);
   CLG_ASSERT(command_file2 != 0);
@@ -73,6 +78,14 @@ void CLG_(init_command)(Char* dir, Char* dumps)
   VG_(sprintf)(result_file, "%s/%s.%d",
               dir, DEFAULT_RESULTNAME, VG_(getpid)());
 
+  /* If we get a command from a command file without .pid, use
+   * a result file without .pid suffix
+   */
+  result_file2 = (char*) CLG_MALLOC(size);
+  CLG_ASSERT(result_file2 != 0);
+  VG_(sprintf)(result_file2, "%s/%s",
+               dir, DEFAULT_RESULTNAME);
+
   info_file = (char*) CLG_MALLOC(VG_(strlen)(DEFAULT_INFONAME) + 10);
   CLG_ASSERT(info_file != 0);
   VG_(sprintf)(info_file, "%s.%d", DEFAULT_INFONAME, VG_(getpid)());
@@ -105,15 +118,11 @@ void CLG_(init_command)(Char* dir, Char* dumps)
                 "# It is used to enable controlling the supervision of\n"
                 "#  '%s'\n"
                 "# by external tools.\n\n",
-#if VG_CORE_INTERFACE_VERSION < 9
-                VG_(client_argv[0])
-#else
                 VG_(args_the_exename)
-#endif
        );
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     
-    VG_(sprintf)(buf, "version: " VERSION "\n");
+    VG_(sprintf)(buf, "version: " COMMAND_VERSION "\n");
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     
     VG_(sprintf)(buf, "base: %s\n", dir);
@@ -130,13 +139,6 @@ void CLG_(init_command)(Char* dir, Char* dumps)
     
     VG_(strcpy)(buf, "cmd:");
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
-#if VG_CORE_INTERFACE_VERSION < 9
-    for (i = 0; i < VG_(client_argc); i++) {
-       if (!VG_(client_argv[i])) continue;
-       VG_(sprintf)(buf, " %s", VG_(client_argv[i]));
-       VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
-    }
-#else
     VG_(sprintf)(buf, " %s", VG_(args_the_exename));
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     for (i = 0; i < VG_(args_for_client).used; i++) {
@@ -144,7 +146,6 @@ void CLG_(init_command)(Char* dir, Char* dumps)
        VG_(sprintf)(buf, " %s", VG_(args_for_client).strs[i]);
        VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     }
-#endif
     VG_(write)(fd, "\n", 1);
     VG_(close)(fd);
   }
@@ -166,7 +167,8 @@ static Int createRes(Int fd)
     if (fd > -2) return fd;
 
     /* fd == -2: No error, but we need to create the file */
-    res = VG_(open)(result_file,
+    CLG_ASSERT(current_result_file != 0);
+    res = VG_(open)(current_result_file,
                   VKI_O_CREAT|VKI_O_WRONLY|VKI_O_TRUNC,
                   VKI_S_IRUSR|VKI_S_IWUSR);
 
@@ -179,7 +181,7 @@ static Int createRes(Int fd)
     return fd;
 }
 
-/* Run Info: Fixed information for a callgrind run */
+/* Run Info: Persistant information of the callgrind run */
 static Int dump_info(Int fd)
 {
     Char* buf = outbuf;
@@ -187,8 +189,12 @@ static Int dump_info(Int fd)
     
     if ( (fd = createRes(fd)) <0) return fd;
 
+    /* creator */
+    VG_(sprintf)(buf, "creator: callgrind-" VERSION "\n");
+    VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
+
     /* version */
-    VG_(sprintf)(buf, "version: " VERSION "\n");
+    VG_(sprintf)(buf, "version: " COMMAND_VERSION "\n");
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     
     /* "pid:" line */
@@ -202,13 +208,6 @@ static Int dump_info(Int fd)
     /* "cmd:" line */
     VG_(strcpy)(buf, "cmd:");
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
-#if VG_CORE_INTERFACE_VERSION < 9
-    for (i = 0; i < VG_(client_argc); i++) {
-       if (!VG_(client_argv[i])) continue;
-       VG_(sprintf)(buf, " %s", VG_(client_argv[i]));
-       VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
-    }
-#else
     VG_(sprintf)(buf, " %s", VG_(args_the_exename));
     VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     for (i = 0; i < VG_(args_for_client).used; i++) {
@@ -216,7 +215,7 @@ static Int dump_info(Int fd)
        VG_(sprintf)(buf, " %s", VG_(args_for_client).strs[i]);
        VG_(write)(fd, (void*)buf, VG_(strlen)(buf));
     }
-#endif
+    VG_(write)(fd, "\n", 1);
 
     return fd;
 }
@@ -355,17 +354,17 @@ void CLG_(check_command)()
     static Char cmdBuffer[512];
     Char *cmdPos = 0, *cmdNextLine = 0;
     Int fd, bytesRead = 0, do_kill = 0;
-    static Char* cfile = 0;
     SysRes res;
 
     if (!command_inited) return;
 
     /* toggle between 2 command files, with/without ".pid" postfix */
-    cfile = ((cfile == command_file) || (cfile == 0)) ? 
-      command_file2 : command_file;
-    
+    current_command_file = (current_command_file == command_file2) ? 
+                           command_file : command_file2;
+    current_result_file  = (current_command_file == command_file2) ?
+                           result_file2 : result_file;    
     
-    res = VG_(open)(cfile, VKI_O_RDONLY,0);
+    res = VG_(open)(current_command_file, VKI_O_RDONLY,0);
     if (!res.isError) {
        fd = (Int) res.val;
        bytesRead = VG_(read)(fd,cmdBuffer,500);
@@ -505,12 +504,12 @@ void CLG_(check_command)()
     }
 
     /* If command executed, delete command file */
-    if (cmdPos) VG_(unlink)(cfile);
+    if (cmdPos) VG_(unlink)(current_command_file);
     if (fd>=0) VG_(close)(fd);     
 
     if (do_kill) {
       VG_(message)(Vg_UserMsg,
-                  "Killed because of command from %s", cfile);
+                  "Killed because of command from %s", current_command_file);
       CLG_(fini)(0);
       VG_(exit)(1);
     }