osfmk/mach/time_value.h

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