xref: /openbsd-src/usr.bin/make/timestamp.h (revision 4c1e55dc91edd6e69ccc60ce855900fbc12cf34f)
1 #ifndef TIMESTAMP_H
2 #define TIMESTAMP_H
3 
4 /*	$OpenBSD: timestamp.h,v 1.7 2011/12/10 04:12:36 guenther Exp $ */
5 
6 /*
7  * Copyright (c) 2001 Marc Espie.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OPENBSD
22  * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /* This module handles time stamps on files in a relatively high-level way.
32  * Most of the interface is achieved through inlineable code.
33  *
34  * TIMESTAMP: 			opaque data type to store a date.
35  * ts_set_out_of_date(t):	set up t so that it is out-of-date.
36  * b = is_out_of_date(t):	check whether t is out-of-date.
37  * ts_set_from_stat(s, t):	grab date out of stat(2) buffer.
38  * b = is_strictly_before(t1, t2):
39  *				check whether t1 is before t2.
40  * stamp = timestamp2time_t(t):	extract time_t from timestamp.
41  * ts_set_from_time_t(d, t):	create timestamp from time_t.
42  * ts_set_from_now(n):		grab current date.
43  */
44 
45 /* sysresult = set_times(name):	set modification times on a file.
46  * 				system call results.
47  */
48 
49 #define Init_Timestamp()	ts_set_from_now(now)
50 
51 #ifndef TIMESTAMP_TYPE
52 #include "timestamp_t.h"
53 #endif
54 #ifdef USE_TIMESPEC
55 #define ts_set_out_of_date(t)	(t).tv_sec = INT_MIN, (t).tv_nsec = 0
56 #define is_out_of_date(t)	((t).tv_sec == INT_MIN && (t).tv_nsec == 0)
57 #define ts_set_from_stat(s, t) \
58 do { \
59 	(t).tv_sec = (s).st_mtime; \
60 	(t).tv_nsec = (s).st_mtimensec; \
61 	if (is_out_of_date(t)) \
62 		(t).tv_nsec++; \
63 } while (0)
64 #define is_strictly_before(t1, t2)	timespeccmp(&(t1), &(t2), <)
65 #define ts_set_from_time_t(d, t) \
66 do { \
67 	(t).tv_sec = d; \
68 	(t).tv_nsec = 0; \
69 	if (is_out_of_date(t)) \
70 		(t).tv_nsec++; \
71 } while (0)
72 #define ts_set_from_now(n)	clock_gettime(CLOCK_REALTIME, &(n))
73 #define timestamp2time_t(t)	((t).tv_sec)
74 #else
75 #define is_out_of_date(t)	((t) == INT_MIN)
76 #define ts_set_out_of_date(t)	(t) = INT_MIN
77 #define ts_set_from_stat(s, t) \
78 do { \
79 	(t) = (s).st_mtime; \
80 	if (is_out_of_date(t)) \
81 		(t)++; \
82 } while (0)
83 #define is_strictly_before(t1, t2)	((t1) < (t2))
84 #define ts_set_from_time_t(d, t) \
85 do { \
86 	(t) = d; \
87 	if (is_out_of_date(t)) \
88 		(t)++; \
89 } while (0)
90 #define ts_set_from_now(n) time(&(n))
91 #define timestamp2time_t(t)	(t)
92 #endif
93 
94 extern int set_times(const char *);
95 
96 extern TIMESTAMP now;		/* The time at the start of this whole
97 				 * process */
98 extern char *time_to_string(TIMESTAMP t);
99 
100 
101 #endif
102