Bring objects.pl output even closer to new format.
[openssl.git] / crypto / o_time.c
1 /* crypto/o_time.c -*- mode:C; c-file-style: "eay" -*- */
2 /*
3  * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
4  * 2001.
5  */
6 /*
7  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
8  * 2008.
9  */
10 /* ====================================================================
11  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in
22  *    the documentation and/or other materials provided with the
23  *    distribution.
24  *
25  * 3. All advertising materials mentioning features or use of this
26  *    software must display the following acknowledgment:
27  *    "This product includes software developed by the OpenSSL Project
28  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
29  *
30  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
31  *    endorse or promote products derived from this software without
32  *    prior written permission. For written permission, please contact
33  *    licensing@OpenSSL.org.
34  *
35  * 5. Products derived from this software may not be called "OpenSSL"
36  *    nor may "OpenSSL" appear in their names without prior written
37  *    permission of the OpenSSL Project.
38  *
39  * 6. Redistributions of any form whatsoever must retain the following
40  *    acknowledgment:
41  *    "This product includes software developed by the OpenSSL Project
42  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
43  *
44  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
45  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
47  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
48  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
53  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
55  * OF THE POSSIBILITY OF SUCH DAMAGE.
56  * ====================================================================
57  *
58  * This product includes cryptographic software written by Eric Young
59  * (eay@cryptsoft.com).  This product includes software written by Tim
60  * Hudson (tjh@cryptsoft.com).
61  *
62  */
63
64 #include <openssl/e_os2.h>
65 #include <string.h>
66 #include "o_time.h"
67
68 #ifdef OPENSSL_SYS_VMS
69 # if __CRTL_VER >= 70000000 && \
70      (defined _POSIX_C_SOURCE || !defined _ANSI_C_SOURCE)
71 #  define VMS_GMTIME_OK
72 # endif
73 # ifndef VMS_GMTIME_OK
74 #  include <libdtdef.h>
75 #  include <lib$routines.h>
76 #  include <lnmdef.h>
77 #  include <starlet.h>
78 #  include <descrip.h>
79 #  include <stdlib.h>
80 # endif                         /* ndef VMS_GMTIME_OK */
81 #endif
82
83 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result)
84 {
85     struct tm *ts = NULL;
86
87 #if defined(OPENSSL_THREADS) && !defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_SYS_OS2) && (!defined(OPENSSL_SYS_VMS) || defined(gmtime_r)) && !defined(OPENSSL_SYS_MACOSX) && !defined(OPENSSL_SYS_SUNOS)
88     /*
89      * should return &data, but doesn't on some systems, so we don't even
90      * look at the return value
91      */
92     gmtime_r(timer, result);
93     ts = result;
94 #elif !defined(OPENSSL_SYS_VMS) || defined(VMS_GMTIME_OK)
95     ts = gmtime(timer);
96     if (ts == NULL)
97         return NULL;
98
99     memcpy(result, ts, sizeof(struct tm));
100     ts = result;
101 #endif
102 #if defined( OPENSSL_SYS_VMS) && !defined( VMS_GMTIME_OK)
103     if (ts == NULL) {
104         static $DESCRIPTOR(tabnam, "LNM$DCL_LOGICAL");
105         static $DESCRIPTOR(lognam, "SYS$TIMEZONE_DIFFERENTIAL");
106         char logvalue[256];
107         unsigned int reslen = 0;
108         struct {
109             short buflen;
110             short code;
111             void *bufaddr;
112             unsigned int *reslen;
113         } itemlist[] = {
114             {
115                 0, LNM$_STRING, 0, 0
116             },
117             {
118                 0, 0, 0, 0
119             },
120         };
121         int status;
122         time_t t;
123
124         /* Get the value for SYS$TIMEZONE_DIFFERENTIAL */
125         itemlist[0].buflen = sizeof(logvalue);
126         itemlist[0].bufaddr = logvalue;
127         itemlist[0].reslen = &reslen;
128         status = sys$trnlnm(0, &tabnam, &lognam, 0, itemlist);
129         if (!(status & 1))
130             return NULL;
131         logvalue[reslen] = '\0';
132
133         t = *timer;
134
135 /* The following is extracted from the DEC C header time.h */
136         /*
137          **  Beginning in OpenVMS Version 7.0 mktime, time, ctime, strftime
138          **  have two implementations.  One implementation is provided
139          **  for compatibility and deals with time in terms of local time,
140          **  the other __utc_* deals with time in terms of UTC.
141          */
142         /*
143          * We use the same conditions as in said time.h to check if we should
144          * assume that t contains local time (and should therefore be
145          * adjusted) or UTC (and should therefore be left untouched).
146          */
147 # if __CRTL_VER < 70000000 || defined _VMS_V6_SOURCE
148         /* Get the numerical value of the equivalence string */
149         status = atoi(logvalue);
150
151         /* and use it to move time to GMT */
152         t -= status;
153 # endif
154
155         /* then convert the result to the time structure */
156
157         /*
158          * Since there was no gmtime_r() to do this stuff for us, we have to
159          * do it the hard way.
160          */
161         {
162             /*-
163              * The VMS epoch is the astronomical Smithsonian date,
164                if I remember correctly, which is November 17, 1858.
165                Furthermore, time is measure in thenths of microseconds
166                and stored in quadwords (64 bit integers).  unix_epoch
167                below is January 1st 1970 expressed as a VMS time.  The
168                following code was used to get this number:
169
170                #include <stdio.h>
171                #include <stdlib.h>
172                #include <lib$routines.h>
173                #include <starlet.h>
174
175                main()
176                {
177                  unsigned long systime[2];
178                  unsigned short epoch_values[7] =
179                    { 1970, 1, 1, 0, 0, 0, 0 };
180
181                  lib$cvt_vectim(epoch_values, systime);
182
183                  printf("%u %u", systime[0], systime[1]);
184                }
185             */
186             unsigned long unix_epoch[2] = { 1273708544, 8164711 };
187             unsigned long deltatime[2];
188             unsigned long systime[2];
189             struct vms_vectime {
190                 short year, month, day, hour, minute, second, centi_second;
191             } time_values;
192             long operation;
193
194             /*
195              * Turn the number of seconds since January 1st 1970 to an
196              * internal delta time. Note that lib$cvt_to_internal_time() will
197              * assume that t is signed, and will therefore break on 32-bit
198              * systems some time in 2038.
199              */
200             operation = LIB$K_DELTA_SECONDS;
201             status = lib$cvt_to_internal_time(&operation, &t, deltatime);
202
203             /*
204              * Add the delta time with the Unix epoch and we have the current
205              * UTC time in internal format
206              */
207             status = lib$add_times(unix_epoch, deltatime, systime);
208
209             /* Turn the internal time into a time vector */
210             status = sys$numtim(&time_values, systime);
211
212             /* Fill in the struct tm with the result */
213             result->tm_sec = time_values.second;
214             result->tm_min = time_values.minute;
215             result->tm_hour = time_values.hour;
216             result->tm_mday = time_values.day;
217             result->tm_mon = time_values.month - 1;
218             result->tm_year = time_values.year - 1900;
219
220             operation = LIB$K_DAY_OF_WEEK;
221             status = lib$cvt_from_internal_time(&operation,
222                                                 &result->tm_wday, systime);
223             result->tm_wday %= 7;
224
225             operation = LIB$K_DAY_OF_YEAR;
226             status = lib$cvt_from_internal_time(&operation,
227                                                 &result->tm_yday, systime);
228             result->tm_yday--;
229
230             result->tm_isdst = 0; /* There's no way to know... */
231
232             ts = result;
233         }
234     }
235 #endif
236     return ts;
237 }
238
239 /*
240  * Take a tm structure and add an offset to it. This avoids any OS issues
241  * with restricted date types and overflows which cause the year 2038
242  * problem.
243  */
244
245 #define SECS_PER_DAY (24 * 60 * 60)
246
247 static long date_to_julian(int y, int m, int d);
248 static void julian_to_date(long jd, int *y, int *m, int *d);
249
250 int OPENSSL_gmtime_adj(struct tm *tm, int off_day, long offset_sec)
251 {
252     int offset_hms, offset_day;
253     long time_jd;
254     int time_year, time_month, time_day;
255     /* split offset into days and day seconds */
256     offset_day = offset_sec / SECS_PER_DAY;
257     /* Avoid sign issues with % operator */
258     offset_hms = offset_sec - (offset_day * SECS_PER_DAY);
259     offset_day += off_day;
260     /* Add current time seconds to offset */
261     offset_hms += tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
262     /* Adjust day seconds if overflow */
263     if (offset_hms >= SECS_PER_DAY) {
264         offset_day++;
265         offset_hms -= SECS_PER_DAY;
266     } else if (offset_hms < 0) {
267         offset_day--;
268         offset_hms += SECS_PER_DAY;
269     }
270
271     /*
272      * Convert date of time structure into a Julian day number.
273      */
274
275     time_year = tm->tm_year + 1900;
276     time_month = tm->tm_mon + 1;
277     time_day = tm->tm_mday;
278
279     time_jd = date_to_julian(time_year, time_month, time_day);
280
281     /* Work out Julian day of new date */
282     time_jd += offset_day;
283
284     if (time_jd < 0)
285         return 0;
286
287     /* Convert Julian day back to date */
288
289     julian_to_date(time_jd, &time_year, &time_month, &time_day);
290
291     if (time_year < 1900 || time_year > 9999)
292         return 0;
293
294     /* Update tm structure */
295
296     tm->tm_year = time_year - 1900;
297     tm->tm_mon = time_month - 1;
298     tm->tm_mday = time_day;
299
300     tm->tm_hour = offset_hms / 3600;
301     tm->tm_min = (offset_hms / 60) % 60;
302     tm->tm_sec = offset_hms % 60;
303
304     return 1;
305
306 }
307
308 /*
309  * Convert date to and from julian day Uses Fliegel & Van Flandern algorithm
310  */
311 static long date_to_julian(int y, int m, int d)
312 {
313     return (1461 * (y + 4800 + (m - 14) / 12)) / 4 +
314         (367 * (m - 2 - 12 * ((m - 14) / 12))) / 12 -
315         (3 * ((y + 4900 + (m - 14) / 12) / 100)) / 4 + d - 32075;
316 }
317
318 static void julian_to_date(long jd, int *y, int *m, int *d)
319 {
320     long L = jd + 68569;
321     long n = (4 * L) / 146097;
322     long i, j;
323
324     L = L - (146097 * n + 3) / 4;
325     i = (4000 * (L + 1)) / 1461001;
326     L = L - (1461 * i) / 4 + 31;
327     j = (80 * L) / 2447;
328     *d = L - (2447 * j) / 80;
329     L = j / 11;
330     *m = j + 2 - (12 * L);
331     *y = 100 * (n - 49) + i + L;
332 }
333
334 #ifdef OPENSSL_TIME_TEST
335
336 # include <stdio.h>
337
338 /*
339  * Time checking test code. Check times are identical for a wide range of
340  * offsets. This should be run on a machine with 64 bit time_t or it will
341  * trigger the very errors the routines fix.
342  */
343
344 int main(int argc, char **argv)
345 {
346     long offset;
347     for (offset = 0; offset < 1000000; offset++) {
348         check_time(offset);
349         check_time(-offset);
350         check_time(offset * 1000);
351         check_time(-offset * 1000);
352     }
353 }
354
355 int check_time(long offset)
356 {
357     struct tm tm1, tm2;
358     time_t t1, t2;
359     time(&t1);
360     t2 = t1 + offset;
361     OPENSSL_gmtime(&t2, &tm2);
362     OPENSSL_gmtime(&t1, &tm1);
363     OPENSSL_gmtime_adj(&tm1, 0, offset);
364     if ((tm1.tm_year == tm2.tm_year) &&
365         (tm1.tm_mon == tm2.tm_mon) &&
366         (tm1.tm_mday == tm2.tm_mday) &&
367         (tm1.tm_hour == tm2.tm_hour) &&
368         (tm1.tm_min == tm2.tm_min) && (tm1.tm_sec == tm2.tm_sec))
369         return 1;
370     fprintf(stderr, "TIME ERROR!!\n");
371     fprintf(stderr, "Time1: %d/%d/%d, %d:%02d:%02d\n",
372             tm2.tm_mday, tm2.tm_mon + 1, tm2.tm_year + 1900,
373             tm2.tm_hour, tm2.tm_min, tm2.tm_sec);
374     fprintf(stderr, "Time2: %d/%d/%d, %d:%02d:%02d\n",
375             tm1.tm_mday, tm1.tm_mon + 1, tm1.tm_year + 1900,
376             tm1.tm_hour, tm1.tm_min, tm1.tm_sec);
377     return 0;
378 }
379
380 #endif