prepare for the release of rrdtool-1.2.9
[rrdtool.git] / src / rrd_fetch.c
index e82eb3c..404f30f 100644 (file)
@@ -1,12 +1,54 @@
 /*****************************************************************************
- * RRDtool 1.0.33  Copyright Tobias Oetiker, 1997 - 2000
+ * RRDtool 1.2.9  Copyright by Tobi Oetiker, 1997-2005
  *****************************************************************************
  * rrd_fetch.c  read date from an rrd to use for further processing
  *****************************************************************************
  * $Id$
  * $Log$
- * Revision 1.1  2001/02/25 22:25:05  oetiker
- * Initial revision
+ * Revision 1.8  2004/05/18 18:53:03  oetiker
+ * big spell checking patch -- slif@bellsouth.net
+ *
+ * Revision 1.7  2003/11/11 19:46:21  oetiker
+ * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers
+ *
+ * Revision 1.6  2003/01/16 23:27:54  oetiker
+ * fix border condition in rra selection of rrd_fetch
+ * -- Stanislav Sinyagin <ssinyagin@yahoo.com>
+ *
+ * Revision 1.5  2002/06/23 22:29:40  alex
+ * Added "step=1800" and such to "DEF"
+ * Cleaned some of the signed vs. unsigned problems
+ *
+ * Revision 1.4  2002/02/01 20:34:49  oetiker
+ * fixed version number and date/time
+ *
+ * Revision 1.3  2001/12/24 06:51:49  alex
+ * A patch of size 44Kbytes... in short:
+ *
+ * Found and repaired the off-by-one error in rrd_fetch_fn().
+ * As a result I had to remove the hacks in rrd_fetch_fn(),
+ * rrd_tool.c, vdef_calc(), data_calc(), data_proc() and
+ * reduce_data().  There may be other places which I didn't
+ * find so be careful.
+ *
+ * Enhanced debugging in rrd_fetch_fn(), it shows the RRA selection
+ * process.
+ *
+ * Added the ability to print VDEF timestamps.  At the moment it
+ * is a hack, I needed it now to fix the off-by-one error.
+ * If the format string is "%c" (and nothing else!), the time
+ * will be printed by both ctime() and as a long int.
+ *
+ * Moved some code around (slightly altering it) from rrd_graph()
+ *   initializing     now in rrd_graph_init()
+ *   options parsing  now in rrd_graph_options()
+ *   script parsing   now in rrd_graph_script()
+ *
+ * Revision 1.2  2001/12/17 12:48:43  oetiker
+ * fix overflow error ...
+ *
+ * Revision 1.1.1.1  2001/02/25 22:25:05  oetiker
+ * checkin
  *
  *****************************************************************************/
 
@@ -31,8 +73,9 @@ rrd_fetch(int argc,
     time_t   start_tmp=0, end_tmp=0;
     enum     cf_en cf_idx;
 
-    struct time_value start_tv, end_tv;
+    struct rrd_time_value start_tv, end_tv;
     char     *parsetime_error = NULL;
+    optind = 0; opterr = 0;  /* initialize getopt */
 
     /* init start and end time */
     parsetime("end-24h", &start_tv);
@@ -106,7 +149,7 @@ rrd_fetch(int argc,
        return -1;
     }
     
-    if ((cf_idx=cf_conv(argv[optind+1])) == -1 ){
+    if ((int)(cf_idx=cf_conv(argv[optind+1])) == -1 ){
        return -1;
     }
 
@@ -139,12 +182,18 @@ rrd_fetch_fn(
     int            first_part = 1;
     rrd_t     rrd;
     rrd_value_t    *data_ptr;
-    unsigned long  rows;
+    unsigned long  rows = (*end - *start) / *step;
+
+#ifdef DEBUG
+fprintf(stderr,"Entered rrd_fetch_fn() searching for the best match\n");
+fprintf(stderr,"Looking for: start %10lu end %10lu step %5lu rows  %lu\n",
+                                               *start,*end,*step,rows);
+#endif
 
     if(rrd_open(filename,&in_file,&rrd, RRD_READONLY)==-1)
        return(-1);
     
-    /* when was the realy last update of this file ? */
+    /* when was the really last update of this file ? */
 
     if (((*ds_namv) = (char **) malloc(rrd.stat_head->ds_cnt * sizeof(char*)))==NULL){
        rrd_set_error("malloc fetch ds_namv array");
@@ -153,7 +202,7 @@ rrd_fetch_fn(
        return(-1);
     }
     
-    for(i=0;i<rrd.stat_head->ds_cnt;i++){
+    for(i=0;(unsigned long)i<rrd.stat_head->ds_cnt;i++){
        if ((((*ds_namv)[i]) = malloc(sizeof(char) * DS_NAM_SIZE))==NULL){
            rrd_set_error("malloc fetch ds_namv entry");
            rrd_free(&rrd);
@@ -167,10 +216,9 @@ rrd_fetch_fn(
     }
     
     /* find the rra which best matches the requirements */
-    for(i=0;i<rrd.stat_head->rra_cnt;i++){
+    for(i=0;(unsigned)i<rrd.stat_head->rra_cnt;i++){
        if(cf_conv(rrd.rra_def[i].cf_nam) == cf_idx){
            
-              
            cal_end = (rrd.live_head->last_up - (rrd.live_head->last_up 
                          % (rrd.rra_def[i].pdp_cnt 
                             * rrd.stat_head->pdp_step)));
@@ -180,16 +228,29 @@ rrd_fetch_fn(
                            * rrd.stat_head->pdp_step));
 
            full_match = *end -*start;
+#ifdef DEBUG
+fprintf(stderr,"Considering: start %10lu end %10lu step %5lu ",
+                                                       cal_start,cal_end,
+                       rrd.stat_head->pdp_step * rrd.rra_def[i].pdp_cnt);
+#endif
+           /* we need step difference in either full or partial case */
+           tmp_step_diff = labs(*step - (rrd.stat_head->pdp_step
+                                          * rrd.rra_def[i].pdp_cnt));
            /* best full match */
            if(cal_end >= *end 
               && cal_start <= *start){
-               tmp_step_diff = labs(*step - (rrd.stat_head->pdp_step
-                                        * rrd.rra_def[i].pdp_cnt));
                if (first_full || (tmp_step_diff < best_step_diff)){
                    first_full=0;
                    best_step_diff = tmp_step_diff;
                    best_full_rra=i;
-               } 
+#ifdef DEBUG
+fprintf(stderr,"best full match so far\n");
+#endif
+               } else {
+#ifdef DEBUG
+fprintf(stderr,"full match, not best\n");
+#endif
+               }
                
            } else {
                /* best partial match */
@@ -198,17 +259,27 @@ rrd_fetch_fn(
                    tmp_match -= (cal_start-*start);
                if (cal_end<*end)
                    tmp_match -= (*end-cal_end);                
-               if (first_part || best_match < tmp_match){
+               if (first_part ||
+                    (best_match < tmp_match) ||
+                    (best_match == tmp_match && 
+                     tmp_step_diff < best_step_diff)){ 
+#ifdef DEBUG
+fprintf(stderr,"best partial so far\n");
+#endif
                    first_part=0;
                    best_match = tmp_match;
+                   best_step_diff = tmp_step_diff;
                    best_part_rra =i;
-               } 
+               } else {
+#ifdef DEBUG
+fprintf(stderr,"partial match, not best\n");
+#endif
+               }
            }
        }
     }
 
     /* lets see how the matching went. */
-    
     if (first_full==0)
        chosen_rra = best_full_rra;
     else if (first_part==0)
@@ -221,21 +292,26 @@ rrd_fetch_fn(
     }
        
     /* set the wish parameters to their real values */
-    
     *step = rrd.stat_head->pdp_step * rrd.rra_def[chosen_rra].pdp_cnt;
     *start -= (*start % *step);
     if (*end % *step) *end += (*step - *end % *step);
-    rows = (*end - *start) / *step +1;
+    rows = (*end - *start) / *step;
 
 #ifdef DEBUG
-    fprintf(stderr,"start %lu end %lu step %lu rows  %lu\n",
-           *start,*end,*step,rows);
+    fprintf(stderr,"We found:    start %10lu end %10lu step %5lu rows  %lu\n",
+                                               *start,*end,*step,rows);
 #endif
 
+/* Start and end are now multiples of the step size.  The amount of
+** steps we want is (end-start)/step and *not* an extra one.
+** Reasoning:  if step is s and we want to graph from t to t+s,
+** we need exactly ((t+s)-t)/s rows.  The row to collect from the
+** database is the one with time stamp (t+s) which means t to t+s.
+*/
     *ds_cnt =   rrd.stat_head->ds_cnt; 
     if (((*data) = malloc(*ds_cnt * rows * sizeof(rrd_value_t)))==NULL){
        rrd_set_error("malloc fetch data area");
-       for (i=0;i<*ds_cnt;i++)
+       for (i=0;(unsigned long)i<*ds_cnt;i++)
              free((*ds_namv)[i]);
        free(*ds_namv);
        rrd_free(&rrd);
@@ -257,8 +333,9 @@ rrd_fetch_fn(
                    - (rrd.live_head->last_up % *step));
     rra_start_time = (rra_end_time
                 - ( *step * (rrd.rra_def[chosen_rra].row_cnt-1)));
-    start_offset = (*start - rra_start_time) / (long)*step;
-    end_offset = (rra_end_time - *end ) / (long)*step; 
+    /* here's an error by one if we don't be careful */
+    start_offset =(long)(*start + *step - rra_start_time) / (long)*step;
+    end_offset = (long)(rra_end_time - *end ) / (long)*step; 
 #ifdef DEBUG
     fprintf(stderr,"rra_start %lu, rra_end %lu, start_off %li, end_off %li\n",
            rra_start_time,rra_end_time,start_offset,end_offset);
@@ -276,7 +353,7 @@ rrd_fetch_fn(
                      * *ds_cnt
                      * sizeof(rrd_value_t))),SEEK_SET) != 0){
        rrd_set_error("seek error in RRA");
-       for (i=0;i<*ds_cnt;i++)
+       for (i=0;(unsigned)i<*ds_cnt;i++)
              free((*ds_namv)[i]);
        free(*ds_namv);
        rrd_free(&rrd);
@@ -293,14 +370,14 @@ rrd_fetch_fn(
     /* step trough the array */
 
     for (i=start_offset;
-        i<(long)(rrd.rra_def[chosen_rra].row_cnt-end_offset);
+        i< (signed)rrd.rra_def[chosen_rra].row_cnt - end_offset;
         i++){
        /* no valid data yet */
        if (i<0) {
 #ifdef DEBUG
            fprintf(stderr,"pre fetch %li -- ",i);
 #endif
-           for(ii=0;ii<*ds_cnt;ii++){
+           for(ii=0;(unsigned)ii<*ds_cnt;ii++){
                *(data_ptr++) = DNAN;
 #ifdef DEBUG
                fprintf(stderr,"%10.2f ",*(data_ptr-1));
@@ -308,11 +385,11 @@ rrd_fetch_fn(
            }
        } 
        /* past the valid data area */
-       else if (i>=rrd.rra_def[chosen_rra].row_cnt) {
+       else if (i >= (signed)rrd.rra_def[chosen_rra].row_cnt) {
 #ifdef DEBUG
            fprintf(stderr,"post fetch %li -- ",i);
 #endif
-           for(ii=0;ii<*ds_cnt;ii++){
+           for(ii=0;(unsigned)ii<*ds_cnt;ii++){
                *(data_ptr++) = DNAN;
 #ifdef DEBUG
                fprintf(stderr,"%10.2f ",*(data_ptr-1));
@@ -321,13 +398,13 @@ rrd_fetch_fn(
        } else {
            /* OK we are inside the valid area but the pointer has to 
             * be wrapped*/
-           if (rra_pointer >= rrd.rra_def[chosen_rra].row_cnt) {
+           if (rra_pointer >= (signed)rrd.rra_def[chosen_rra].row_cnt) {
                rra_pointer -= rrd.rra_def[chosen_rra].row_cnt;
                if(fseek(in_file,(rra_base+rra_pointer
                               * *ds_cnt
                               * sizeof(rrd_value_t)),SEEK_SET) != 0){
                    rrd_set_error("wrap seek in RRA did fail");
-                   for (ii=0;ii<*ds_cnt;ii++)
+                   for (ii=0;(unsigned)ii<*ds_cnt;ii++)
                        free((*ds_namv)[ii]);
                    free(*ds_namv);
                    rrd_free(&rrd);
@@ -345,7 +422,7 @@ rrd_fetch_fn(
                     sizeof(rrd_value_t),
                     *ds_cnt,in_file) != rrd.stat_head->ds_cnt){
                rrd_set_error("fetching cdp from rra");
-               for (ii=0;ii<*ds_cnt;ii++)
+               for (ii=0;(unsigned)ii<*ds_cnt;ii++)
                    free((*ds_namv)[ii]);
                free(*ds_namv);
                rrd_free(&rrd);