osfmk/mach/time_value.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50
  51 #ifndef TIME_VALUE_H_
  52 #define TIME_VALUE_H_
  53
  54 #include <sys/appleapiopts.h>
  55
  56 #include <mach/machine/vm_types.h>
  57
  58 /*
  59  *      Time value returned by kernel.
  60  */
  61
  62 struct time_value {
  63         integer_t seconds;
  64         integer_t microseconds;
  65 };
  66 typedef struct time_value       time_value_t;
  67
  68 #ifdef  __APPLE_API_UNSTABLE
  69
  70 /*
  71  *      Macros to manipulate time values.  Assume that time values
  72  *      are normalized (microseconds <= 999999).
  73  */
  74 #define TIME_MICROS_MAX (1000000)
  75
  76 #define time_value_add_usec(val, micros)        {       \
  77         if (((val)->microseconds += (micros))           \
  78                 >= TIME_MICROS_MAX) {                   \
  79             (val)->microseconds -= TIME_MICROS_MAX;     \
  80             (val)->seconds++;                           \
  81         }                                               \
  82 }
  83
  84 #define time_value_add(result, addend)          {               \
  85         (result)->microseconds += (addend)->microseconds;       \
  86         (result)->seconds += (addend)->seconds;                 \
  87         if ((result)->microseconds >= TIME_MICROS_MAX) {        \
  88             (result)->microseconds -= TIME_MICROS_MAX;          \
  89             (result)->seconds++;                                \
  90         }                                                       \
  91 }
  92
  93 #endif  /* __APPLE_API_UNSTABLE */
  94
  95 #ifdef  __APPLE_API_OBSOLETE
  96
  97 /*
  98  *      Time value available through the mapped-time interface.
  99  *      Read this mapped value with
 100  *              do {
 101  *                      secs = mtime->seconds;
 102  *                      usecs = mtime->microseconds;
 103  *              } while (secs != mtime->check_seconds);
 104  */
 105
 106 typedef struct mapped_time_value {
 107         integer_t seconds;
 108         integer_t microseconds;
 109         integer_t check_seconds;
 110 } mapped_time_value_t;
 111
 112 #endif  /* __APPLE_API_OBSOLETE */
 113
 114 #endif  /* TIME_VALUE_H_ */