src/helper/time_support.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26
  27 #ifndef TIME_SUPPORT_H
  28 #define TIME_SUPPORT_H
  29
  30 #ifdef TIME_WITH_SYS_TIME
  31 # include <sys/time.h>
  32 # include <time.h>
  33 #else
  34 # ifdef HAVE_SYS_TIME_H
  35 #  include <sys/time.h>
  36 # else
  37 #  include <time.h>
  38 # endif
  39 #endif
  40
  41 int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
  42 int timeval_add_time(struct timeval *result, long sec, long usec);
  43
  44 /** @returns gettimeofday() timeval as 64-bit in ms */
  45 int64_t timeval_ms(void);
  46
  47 struct duration {
  48         struct timeval start;
  49         struct timeval elapsed;
  50 };
  51
  52 /** Update the duration->start field to start the @a duration measurement. */
  53 int duration_start(struct duration *duration);
  54 /** Update the duration->elapsed field to finish the @a duration measurment. */
  55 int duration_measure(struct duration *duration);
  56
  57 /** @returns Elapsed time in seconds. */
  58 float duration_elapsed(struct duration *duration);
  59 /** @returns KB/sec for the elapsed @a duration and @a count bytes. */
  60 float duration_kbps(struct duration *duration, size_t count);
  61
  62 #endif  /* TIME_SUPPORT_H */