add perlbindings and optional export filename to rrd_dump -- Nicola Worthington nicol...

git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@742 a5681a0c-68f1-0310-ab6d-d61299d08faa

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
index 71566c6..79c79ba 100644 (file)
--- a/CONTRIBUTORS
+++ b/CONTRIBUTORS
@@ -66,3 +66,5 @@ hendrik visage <hvisage with is.co.za>
 Philippe Simonet <philippe.simonet with swisscom.ch> (Windows Binaries)
 Alexander Lucke (lucke with dns-net.de) 
  of DNS:NET Internet Services (www.dns-net.de) http://rrdtool.org
+Hedley Simons <heds@metahusky.net>
+Nicola Worthington <nicolaw@cpan.org>

diff --git a/bindings/perl-shared/RRDs.pm b/bindings/perl-shared/RRDs.pm
index 1e11644..77aafe7 100644 (file)
--- a/bindings/perl-shared/RRDs.pm
+++ b/bindings/perl-shared/RRDs.pm
@@ -31,6 +31,8 @@ RRDs - Access RRDtool as a shared module
   RRDs::fetch ...
   RRDs::tune ...
   RRDs::times(start, end)
+  RRDs::dump ...
+  RRDs::restore ...
 
 =head1 DESCRIPTION
 

diff --git a/bindings/tcl/tclrrd.c b/bindings/tcl/tclrrd.c
index 6a5250c..e9cff80 100644 (file)
--- a/bindings/tcl/tclrrd.c
+++ b/bindings/tcl/tclrrd.c
@@ -195,7 +195,7 @@ Rrd_Dump(ClientData clientData, Tcl_Interp *interp, int argc, CONST84 char *argv
        return TCL_ERROR;
     }
 
-    rrd_dump_r(argv[1]);
+    rrd_dump_r(argv[1], NULL);
 
     /* NOTE: rrd_dump() writes to stdout. No interaction with TCL. */
 

diff --git a/doc/rrddump.pod b/doc/rrddump.pod
index d38aef5..aa2a7e7 100644 (file)
--- a/doc/rrddump.pod
+++ b/doc/rrddump.pod
@@ -6,13 +6,18 @@ rrddump - dump the contents of an RRD to XML format
 
 B<rrdtool> B<dump> I<filename.rrd> E<gt> I<filename.xml>
 
+or 
+
+B<rrdtool> B<dump> I<filename.rrd> I<filename.xml>
+
 =head1 DESCRIPTION
 
-The B<dump> function prints the contents of an B<RRD> in human
-readable (?) XML format. This format can be read by rrdrestore.
-Together they allow you to transfer your files from one computer architecture
-to another as well to manipulate the contents of an B<RRD> file in a
-somewhat more convenient manner.
+The B<dump> function writes the contents of an B<RRD> in human
+readable (?) XML format to a file or to stdout. This format can
+be read by rrdrestore. Together they allow you to transfer your
+files from one computer architecture to another as well to
+manipulate the contents of an B<RRD> file in a somewhat more
+convenient manner.
 
 
 
@@ -22,6 +27,11 @@ somewhat more convenient manner.
 
 The name of the B<RRD> you want to dump.
 
+=item I<filename.xml>
+
+The (optional) filename that you want to write the XML output to.
+If not specified, the XML will be printed to stdout.
+
 =back
 
 =head1 EXAMPLES

diff --git a/src/rrd.h b/src/rrd.h
index fc17a65..069ca2a 100644 (file)
--- a/src/rrd.h
+++ b/src/rrd.h
@@ -85,7 +85,7 @@ int    rrd_create_r(char *filename,
    specifications get used!!! */
 int    rrd_update_r(char *filename, char *_template,
                    int argc, char **argv);
-int    rrd_dump_r(char *filename);
+int    rrd_dump_r(char *filename, char *outname);
 time_t rrd_last_r(const char *filename);
 time_t rrd_first_r(const char *filename, int rraindex);
 

diff --git a/src/rrd_dump.c b/src/rrd_dump.c
index dfc776b..6569743 100644 (file)
--- a/src/rrd_dump.c
+++ b/src/rrd_dump.c
@@ -41,7 +41,6 @@
  * checkin
  *
  *****************************************************************************/
-
 #include "rrd_tool.h"
 #include "rrd_rpncalc.h"
 
@@ -59,13 +58,20 @@ rrd_dump(int argc, char **argv)
        return -1;
     }
 
-    rc = rrd_dump_r(argv[1]);
-    
+    if (argc == 3)
+    {
+      rc = rrd_dump_r(argv[1], argv[2]);
+    }
+    else
+    {
+      rc = rrd_dump_r(argv[1], NULL);                  
+    }
+
     return rc;
 }
 
 int
-rrd_dump_r(char *filename)    
+rrd_dump_r(char *filename, char *outname)    
 {   
     unsigned int i,ii,ix,iii=0;
     time_t       now;
@@ -73,6 +79,7 @@ rrd_dump_r(char *filename)
     rrd_value_t  my_cdp;
     long         rra_base, rra_start, rra_next;
     FILE        *in_file;
+               FILE                            *out_file;
     rrd_t        rrd;
     rrd_value_t  value;
     struct tm    tm;
@@ -81,10 +88,23 @@ rrd_dump_r(char *filename)
        return(-1);
     }
 
-    puts("<!-- Round Robin Database Dump -->");
-    puts("<rrd>");
-    printf("\t<version> %s </version>\n",RRD_VERSION);
-    printf("\t<step> %lu </step> <!-- Seconds -->\n",rrd.stat_head->pdp_step);
+    out_file = NULL;
+    if (outname)
+    {
+      if (!(out_file = fopen(outname, "w")))
+      {
+        return (-1);     
+      }
+    }
+    else 
+    {
+      out_file = stdout;
+    }
+               
+    fputs("<!-- Round Robin Database Dump -->", out_file);
+    fputs("<rrd>", out_file);
+    fprintf(out_file, "\t<version> %s </version>\n",RRD_VERSION);
+    fprintf(out_file, "\t<step> %lu </step> <!-- Seconds -->\n",rrd.stat_head->pdp_step);
 #if HAVE_STRFTIME
     localtime_r(&rrd.live_head->last_up, &tm);
     strftime(somestring,200,"%Y-%m-%d %H:%M:%S %Z",
@@ -92,44 +112,44 @@ rrd_dump_r(char *filename)
 #else
 # error "Need strftime"
 #endif
-    printf("\t<lastupdate> %ld </lastupdate> <!-- %s -->\n\n",
+    fprintf(out_file, "\t<lastupdate> %ld </lastupdate> <!-- %s -->\n\n",
           rrd.live_head->last_up,somestring);
     for(i=0;i<rrd.stat_head->ds_cnt;i++){
-       printf("\t<ds>\n");
-       printf("\t\t<name> %s </name>\n",rrd.ds_def[i].ds_nam);
-       printf("\t\t<type> %s </type>\n",rrd.ds_def[i].dst);
+       fprintf(out_file, "\t<ds>\n");
+       fprintf(out_file, "\t\t<name> %s </name>\n",rrd.ds_def[i].ds_nam);
+       fprintf(out_file, "\t\t<type> %s </type>\n",rrd.ds_def[i].dst);
     if (dst_conv(rrd.ds_def[i].dst) != DST_CDEF) {
-       printf("\t\t<minimal_heartbeat> %lu </minimal_heartbeat>\n",rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt);
+       fprintf(out_file, "\t\t<minimal_heartbeat> %lu </minimal_heartbeat>\n",rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt);
        if (isnan(rrd.ds_def[i].par[DS_min_val].u_val)){
-         printf("\t\t<min> NaN </min>\n");
+         fprintf(out_file, "\t\t<min> NaN </min>\n");
        } else {
-         printf("\t\t<min> %0.10e </min>\n",rrd.ds_def[i].par[DS_min_val].u_val);
+         fprintf(out_file, "\t\t<min> %0.10e </min>\n",rrd.ds_def[i].par[DS_min_val].u_val);
        }
        if (isnan(rrd.ds_def[i].par[DS_max_val].u_val)){
-         printf("\t\t<max> NaN </max>\n");
+         fprintf(out_file, "\t\t<max> NaN </max>\n");
        } else {
-         printf("\t\t<max> %0.10e </max>\n",rrd.ds_def[i].par[DS_max_val].u_val);
+         fprintf(out_file, "\t\t<max> %0.10e </max>\n",rrd.ds_def[i].par[DS_max_val].u_val);
        }
     } else { /* DST_CDEF */
          char *str;
          rpn_compact2str((rpn_cdefds_t *) &(rrd.ds_def[i].par[DS_cdef]),rrd.ds_def,&str);
-         printf("\t\t<cdef> %s </cdef>\n", str);
+         fprintf(out_file, "\t\t<cdef> %s </cdef>\n", str);
          free(str);
        }
-       printf("\n\t\t<!-- PDP Status -->\n");
-       printf("\t\t<last_ds> %s </last_ds>\n",rrd.pdp_prep[i].last_ds);
+       fprintf(out_file, "\n\t\t<!-- PDP Status -->\n");
+       fprintf(out_file, "\t\t<last_ds> %s </last_ds>\n",rrd.pdp_prep[i].last_ds);
        if (isnan(rrd.pdp_prep[i].scratch[PDP_val].u_val)){
-         printf("\t\t<value> NaN </value>\n");
+         fprintf(out_file, "\t\t<value> NaN </value>\n");
        } else {
-         printf("\t\t<value> %0.10e </value>\n",rrd.pdp_prep[i].scratch[PDP_val].u_val);
+         fprintf(out_file, "\t\t<value> %0.10e </value>\n",rrd.pdp_prep[i].scratch[PDP_val].u_val);
        }
-       printf("\t\t<unknown_sec> %lu </unknown_sec>\n",
+       fprintf(out_file, "\t\t<unknown_sec> %lu </unknown_sec>\n",
               rrd.pdp_prep[i].scratch[PDP_unkn_sec_cnt].u_cnt);
        
-       printf("\t</ds>\n\n");
+       fprintf(out_file, "\t</ds>\n\n");
     }
 
-    puts("<!-- Round Robin Archives -->");
+    fputs("<!-- Round Robin Archives -->", out_file);
 
     rra_base=ftell(in_file);    
     rra_next = rra_base;
@@ -141,43 +161,43 @@ rrd_dump_r(char *filename)
        rra_next +=  ( rrd.stat_head->ds_cnt
                       * rrd.rra_def[i].row_cnt
                       * sizeof(rrd_value_t));
-       printf("\t<rra>\n");
-       printf("\t\t<cf> %s </cf>\n",rrd.rra_def[i].cf_nam);
-       printf("\t\t<pdp_per_row> %lu </pdp_per_row> <!-- %lu seconds -->\n\n",
+       fprintf(out_file, "\t<rra>\n");
+       fprintf(out_file, "\t\t<cf> %s </cf>\n",rrd.rra_def[i].cf_nam);
+       fprintf(out_file, "\t\t<pdp_per_row> %lu </pdp_per_row> <!-- %lu seconds -->\n\n",
               rrd.rra_def[i].pdp_cnt, rrd.rra_def[i].pdp_cnt
               *rrd.stat_head->pdp_step);
        /* support for RRA parameters */
-       printf("\t\t<params>\n");
+       fprintf(out_file, "\t\t<params>\n");
        switch(cf_conv(rrd.rra_def[i].cf_nam)) {
        case CF_HWPREDICT:
-          printf("\t\t<hw_alpha> %0.10e </hw_alpha>\n", 
+          fprintf(out_file, "\t\t<hw_alpha> %0.10e </hw_alpha>\n", 
                  rrd.rra_def[i].par[RRA_hw_alpha].u_val);
-          printf("\t\t<hw_beta> %0.10e </hw_beta>\n", 
+          fprintf(out_file, "\t\t<hw_beta> %0.10e </hw_beta>\n", 
                  rrd.rra_def[i].par[RRA_hw_beta].u_val);
-          printf("\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
+          fprintf(out_file, "\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
                  rrd.rra_def[i].par[RRA_dependent_rra_idx].u_cnt);
           break;
        case CF_SEASONAL:
        case CF_DEVSEASONAL:
-          printf("\t\t<seasonal_gamma> %0.10e </seasonal_gamma>\n", 
+          fprintf(out_file, "\t\t<seasonal_gamma> %0.10e </seasonal_gamma>\n", 
                  rrd.rra_def[i].par[RRA_seasonal_gamma].u_val);
-          printf("\t\t<seasonal_smooth_idx> %lu </seasonal_smooth_idx>\n",
+          fprintf(out_file, "\t\t<seasonal_smooth_idx> %lu </seasonal_smooth_idx>\n",
                  rrd.rra_def[i].par[RRA_seasonal_smooth_idx].u_cnt);
-          printf("\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
+          fprintf(out_file, "\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
                  rrd.rra_def[i].par[RRA_dependent_rra_idx].u_cnt);
           break;
        case CF_FAILURES:
-          printf("\t\t<delta_pos> %0.10e </delta_pos>\n", 
+          fprintf(out_file, "\t\t<delta_pos> %0.10e </delta_pos>\n", 
                  rrd.rra_def[i].par[RRA_delta_pos].u_val);
-          printf("\t\t<delta_neg> %0.10e </delta_neg>\n", 
+          fprintf(out_file, "\t\t<delta_neg> %0.10e </delta_neg>\n", 
                  rrd.rra_def[i].par[RRA_delta_neg].u_val);
-          printf("\t\t<window_len> %lu </window_len>\n",
+          fprintf(out_file, "\t\t<window_len> %lu </window_len>\n",
                  rrd.rra_def[i].par[RRA_window_len].u_cnt);
-          printf("\t\t<failure_threshold> %lu </failure_threshold>\n",
+          fprintf(out_file, "\t\t<failure_threshold> %lu </failure_threshold>\n",
                  rrd.rra_def[i].par[RRA_failure_threshold].u_cnt);
                  /* fall thru */
        case CF_DEVPREDICT:
-          printf("\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
+          fprintf(out_file, "\t\t<dependent_rra_idx> %lu </dependent_rra_idx>\n",
                  rrd.rra_def[i].par[RRA_dependent_rra_idx].u_cnt);
           break;
        case CF_AVERAGE:
@@ -185,14 +205,14 @@ rrd_dump_r(char *filename)
        case CF_MINIMUM:
        case CF_LAST:
        default:
-          printf("\t\t<xff> %0.10e </xff>\n", rrd.rra_def[i].par[RRA_cdp_xff_val].u_val);
+          fprintf(out_file, "\t\t<xff> %0.10e </xff>\n", rrd.rra_def[i].par[RRA_cdp_xff_val].u_val);
           break;
        }
-       printf("\t\t</params>\n");
-       printf("\t\t<cdp_prep>\n");
+       fprintf(out_file, "\t\t</params>\n");
+       fprintf(out_file, "\t\t<cdp_prep>\n");
        for(ii=0;ii<rrd.stat_head->ds_cnt;ii++){
                unsigned long ivalue;
-               printf("\t\t\t<ds>\n");
+               fprintf(out_file, "\t\t\t<ds>\n");
                /* support for exporting all CDP parameters */
                /* parameters common to all CFs */
                    /* primary_val and secondary_val do not need to be saved between updates
@@ -201,63 +221,63 @@ rrd_dump_r(char *filename)
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt
                           +ii].scratch[CDP_primary_val].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<primary_value> NaN </primary_value>\n");
+                          fprintf(out_file, "\t\t\t<primary_value> NaN </primary_value>\n");
                        } else {
-                          printf("\t\t\t<primary_value> %0.10e </primary_value>\n", value);
+                          fprintf(out_file, "\t\t\t<primary_value> %0.10e </primary_value>\n", value);
                        }
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_secondary_val].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<secondary_value> NaN </secondary_value>\n");
+                          fprintf(out_file, "\t\t\t<secondary_value> NaN </secondary_value>\n");
                        } else {
-                          printf("\t\t\t<secondary_value> %0.10e </secondary_value>\n", value);
+                          fprintf(out_file, "\t\t\t<secondary_value> %0.10e </secondary_value>\n", value);
                        }
                switch(cf_conv(rrd.rra_def[i].cf_nam)) {
                case CF_HWPREDICT:
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_intercept].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<intercept> NaN </intercept>\n");
+                          fprintf(out_file, "\t\t\t<intercept> NaN </intercept>\n");
                        } else {
-                          printf("\t\t\t<intercept> %0.10e </intercept>\n", value);
+                          fprintf(out_file, "\t\t\t<intercept> %0.10e </intercept>\n", value);
                        }
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_last_intercept].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<last_intercept> NaN </last_intercept>\n");
+                          fprintf(out_file, "\t\t\t<last_intercept> NaN </last_intercept>\n");
                        } else {
-                          printf("\t\t\t<last_intercept> %0.10e </last_intercept>\n", value);
+                          fprintf(out_file, "\t\t\t<last_intercept> %0.10e </last_intercept>\n", value);
                        }
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_slope].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<slope> NaN </slope>\n");
+                          fprintf(out_file, "\t\t\t<slope> NaN </slope>\n");
                        } else {
-                          printf("\t\t\t<slope> %0.10e </slope>\n", value);
+                          fprintf(out_file, "\t\t\t<slope> %0.10e </slope>\n", value);
                        }
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_last_slope].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<last_slope> NaN </last_slope>\n");
+                          fprintf(out_file, "\t\t\t<last_slope> NaN </last_slope>\n");
                        } else {
-                          printf("\t\t\t<last_slope> %0.10e </last_slope>\n", value);
+                          fprintf(out_file, "\t\t\t<last_slope> %0.10e </last_slope>\n", value);
                        }
                        ivalue = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_null_count].u_cnt;
-                       printf("\t\t\t<nan_count> %lu </nan_count>\n", ivalue);
+                       fprintf(out_file, "\t\t\t<nan_count> %lu </nan_count>\n", ivalue);
                        ivalue = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_last_null_count].u_cnt;
-                       printf("\t\t\t<last_nan_count> %lu </last_nan_count>\n", ivalue);
+                       fprintf(out_file, "\t\t\t<last_nan_count> %lu </last_nan_count>\n", ivalue);
                        break;
                case CF_SEASONAL:
                case CF_DEVSEASONAL:
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_seasonal].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<seasonal> NaN </seasonal>\n");
+                          fprintf(out_file, "\t\t\t<seasonal> NaN </seasonal>\n");
                        } else {
-                          printf("\t\t\t<seasonal> %0.10e </seasonal>\n", value);
+                          fprintf(out_file, "\t\t\t<seasonal> %0.10e </seasonal>\n", value);
                        }
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_hw_last_seasonal].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<last_seasonal> NaN </last_seasonal>\n");
+                          fprintf(out_file, "\t\t\t<last_seasonal> NaN </last_seasonal>\n");
                        } else {
-                          printf("\t\t\t<last_seasonal> %0.10e </last_seasonal>\n", value);
+                          fprintf(out_file, "\t\t\t<last_seasonal> %0.10e </last_seasonal>\n", value);
                        }
                ivalue = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_init_seasonal].u_cnt;
-                       printf("\t\t\t<init_flag> %lu </init_flag>\n", ivalue);
+                       fprintf(out_file, "\t\t\t<init_flag> %lu </init_flag>\n", ivalue);
                        break;
                case CF_DEVPREDICT:
                        break;
@@ -266,12 +286,12 @@ rrd_dump_r(char *filename)
             unsigned short vidx;
                        char *violations_array = (char *) ((void*) 
                           rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch);
-                       printf("\t\t\t<history> ");
+                       fprintf(out_file, "\t\t\t<history> ");
                        for (vidx = 0; vidx < rrd.rra_def[i].par[RRA_window_len].u_cnt; ++vidx)
                        {
-                               printf("%d",violations_array[vidx]);
+                               fprintf(out_file, "%d",violations_array[vidx]);
                        }
-                       printf(" </history>\n");
+                       fprintf(out_file, " </history>\n");
                        }
                        break;
                case CF_AVERAGE:
@@ -281,19 +301,19 @@ rrd_dump_r(char *filename)
                default:
                value = rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_val].u_val;
                        if (isnan(value)) {
-                          printf("\t\t\t<value> NaN </value>\n");
+                          fprintf(out_file, "\t\t\t<value> NaN </value>\n");
                        } else {
-                          printf("\t\t\t<value> %0.10e </value>\n", value);
+                          fprintf(out_file, "\t\t\t<value> %0.10e </value>\n", value);
                        }
-                   printf("\t\t\t<unknown_datapoints> %lu </unknown_datapoints>\n",
+                   fprintf(out_file, "\t\t\t<unknown_datapoints> %lu </unknown_datapoints>\n",
                       rrd.cdp_prep[i*rrd.stat_head->ds_cnt+ii].scratch[CDP_unkn_pdp_cnt].u_cnt);
                        break;
                }
-        printf("\t\t\t</ds>\n");        
+        fprintf(out_file, "\t\t\t</ds>\n");     
     }
-       printf("\t\t</cdp_prep>\n");
+       fprintf(out_file, "\t\t</cdp_prep>\n");
 
-       printf("\t\t<database>\n");
+       fprintf(out_file, "\t\t<database>\n");
        fseek(in_file,(rra_start
                       +(rrd.rra_ptr[i].cur_row+1)
                       * rrd.stat_head->ds_cnt
@@ -318,23 +338,27 @@ rrd_dump_r(char *filename)
 #else
 # error "Need strftime"
 #endif
-           printf("\t\t\t<!-- %s / %d --> <row>",somestring,(int)now);
+           fprintf(out_file, "\t\t\t<!-- %s / %d --> <row>",somestring,(int)now);
            for(iii=0;iii<rrd.stat_head->ds_cnt;iii++){                  
                fread(&my_cdp,sizeof(rrd_value_t),1,in_file);           
                if (isnan(my_cdp)){
-                 printf("<v> NaN </v>");
+                 fprintf(out_file, "<v> NaN </v>");
                } else {
-                 printf("<v> %0.10e </v>",my_cdp);
+                 fprintf(out_file, "<v> %0.10e </v>",my_cdp);
                };
            }
-           printf("</row>\n");
+           fprintf(out_file, "</row>\n");
        }
-       printf("\t\t</database>\n\t</rra>\n");
+       fprintf(out_file, "\t\t</database>\n\t</rra>\n");
        
     }
-    printf("</rrd>\n");
+    fprintf(out_file, "</rrd>\n");
     rrd_free(&rrd);
     fclose(in_file);
+    if (out_file != stdout)
+    {
+      fclose(out_file);
+    }
     return(0);
 }