1 /* Copyright (C) 2002-2014 Free Software Foundation, Inc.
2 Contributed by Andy Vaught
4 This file is part of the GNU Fortran runtime library (libgfortran).
6 Libgfortran is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
11 Libgfortran is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 Under Section 7 of GPL version 3, you are granted additional
17 permissions described in the GCC Runtime Library Exception, version
18 3.1, as published by the Free Software Foundation.
20 You should have received a copy of the GNU General Public License and
21 a copy of the GCC Runtime Library Exception along with this program;
22 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 <http://www.gnu.org/licenses/>. */
26 #include "libgfortran.h"
38 #ifdef HAVE_SYS_TIME_H
42 /* <sys/time.h> has to be included before <sys/resource.h> to work
43 around PR 30518; otherwise, MacOS 10.3.9 headers are just broken. */
44 #ifdef HAVE_SYS_RESOURCE_H
45 #include <sys/resource.h>
62 /* Termination of a program: F2008 2.3.5 talks about "normal
63 termination" and "error termination". Normal termination occurs as
64 a result of e.g. executing the end program statement, and executing
65 the STOP statement. It includes the effect of the C exit()
68 Error termination is initiated when the ERROR STOP statement is
69 executed, when ALLOCATE/DEALLOCATE fails without STAT= being
70 specified, when some of the co-array synchronization statements
71 fail without STAT= being specified, and some I/O errors if
72 ERR/IOSTAT/END/EOR is not present, and finally EXECUTE_COMMAND_LINE
73 failure without CMDSTAT=.
75 2.3.5 also explains how co-images synchronize during termination.
77 In libgfortran we have two ways of ending a program. exit(code) is
78 a normal exit; calling exit() also causes open units to be
79 closed. No backtrace or core dump is needed here. When something
80 goes wrong, we have sys_abort() which tries to print the backtrace
81 if -fbacktrace is enabled, and then dumps core; whether a core file
82 is generated is system dependent. When aborting, we don't flush and
83 close open units, as program memory might be corrupted and we'd
84 rather risk losing dirty data in the buffers rather than corrupting
89 /* Error conditions. The tricky part here is printing a message when
90 * it is the I/O subsystem that is severely wounded. Our goal is to
91 * try and print something making the fewest assumptions possible,
92 * then try to clean up before actually exiting.
94 * The following exit conditions are defined:
95 * 0 Normal program exit.
96 * 1 Terminated because of operating system error.
97 * 2 Error in the runtime library
98 * 3 Internal error in runtime library
100 * Other error returns are reserved for the STOP statement with a numeric code.
104 /* Write a null-terminated C string to standard error. This function
105 is async-signal-safe. */
108 estr_write (const char *str
)
110 return write (STDERR_FILENO
, str
, strlen (str
));
114 /* st_vprintf()-- vsnprintf-like function for error output. We use a
115 stack allocated buffer for formatting; since this function might be
116 called from within a signal handler, printing directly to stderr
117 with vfprintf is not safe since the stderr locking might lead to a
120 #define ST_VPRINTF_SIZE 512
123 st_vprintf (const char *format
, va_list ap
)
126 char buffer
[ST_VPRINTF_SIZE
];
128 #ifdef HAVE_VSNPRINTF
129 written
= vsnprintf(buffer
, ST_VPRINTF_SIZE
, format
, ap
);
131 written
= vsprintf(buffer
, format
, ap
);
133 if (written
>= ST_VPRINTF_SIZE
- 1)
135 /* The error message was longer than our buffer. Ouch. Because
136 we may have messed up things badly, report the error and
138 #define ERROR_MESSAGE "Internal error: buffer overrun in st_vprintf()\n"
139 write (STDERR_FILENO
, buffer
, ST_VPRINTF_SIZE
- 1);
140 write (STDERR_FILENO
, ERROR_MESSAGE
, strlen(ERROR_MESSAGE
));
147 written
= write (STDERR_FILENO
, buffer
, written
);
153 st_printf (const char * format
, ...)
157 va_start (ap
, format
);
158 written
= st_vprintf (format
, ap
);
164 /* sys_abort()-- Terminate the program showing backtrace and dumping
170 /* If backtracing is enabled, print backtrace and disable signal
172 if (options
.backtrace
== 1
173 || (options
.backtrace
== -1 && compile_options
.backtrace
== 1))
175 estr_write ("\nProgram aborted. Backtrace:\n");
177 signal (SIGABRT
, SIG_DFL
);
184 /* gfc_xtoa()-- Integer to hexadecimal conversion. */
187 gfc_xtoa (GFC_UINTEGER_LARGEST n
, char *buffer
, size_t len
)
192 assert (len
>= GFC_XTOA_BUF_SIZE
);
197 p
= buffer
+ GFC_XTOA_BUF_SIZE
- 1;
204 digit
+= 'A' - '0' - 10;
214 /* Hopefully thread-safe wrapper for a strerror() style function. */
217 gf_strerror (int errnum
,
218 char * buf
__attribute__((unused
)),
219 size_t buflen
__attribute__((unused
)))
221 #ifdef HAVE_STRERROR_L
222 locale_t myloc
= newlocale (LC_CTYPE_MASK
| LC_MESSAGES_MASK
, "",
224 char *p
= strerror_l (errnum
, myloc
);
227 #elif defined(HAVE_STRERROR_R)
228 #ifdef HAVE_USELOCALE
229 /* Some targets (Darwin at least) have the POSIX 2008 extended
230 locale functions, but not strerror_l. So reset the per-thread
232 uselocale (LC_GLOBAL_LOCALE
);
234 /* POSIX returns an "int", GNU a "char*". */
236 __builtin_choose_expr (__builtin_classify_type (strerror_r (0, buf
, 0))
238 /* GNU strerror_r() */
239 strerror_r (errnum
, buf
, buflen
),
240 /* POSIX strerror_r () */
241 (strerror_r (errnum
, buf
, buflen
), buf
));
242 #elif defined(HAVE_STRERROR_R_2ARGS)
243 strerror_r (errnum
, buf
);
246 /* strerror () is not necessarily thread-safe, but should at least
247 be available everywhere. */
248 return strerror (errnum
);
253 /* show_locus()-- Print a line number and filename describing where
254 * something went wrong */
257 show_locus (st_parameter_common
*cmp
)
261 if (!options
.locus
|| cmp
== NULL
|| cmp
->filename
== NULL
)
266 filename
= filename_from_unit (cmp
->unit
);
268 if (filename
!= NULL
)
270 st_printf ("At line %d of file %s (unit = %d, file = '%s')\n",
271 (int) cmp
->line
, cmp
->filename
, (int) cmp
->unit
, filename
);
276 st_printf ("At line %d of file %s (unit = %d)\n",
277 (int) cmp
->line
, cmp
->filename
, (int) cmp
->unit
);
282 st_printf ("At line %d of file %s\n", (int) cmp
->line
, cmp
->filename
);
286 /* recursion_check()-- It's possible for additional errors to occur
287 * during fatal error processing. We detect this condition here and
288 * exit with code 4 immediately. */
290 #define MAGIC 0x20DE8101
293 recursion_check (void)
295 static int magic
= 0;
297 /* Don't even try to print something at this point */
305 #define STRERR_MAXSZ 256
307 /* os_error()-- Operating system error. We get a message from the
308 * operating system, show it and leave. Some operating system errors
309 * are caught and processed by the library. If not, we come here. */
312 os_error (const char *message
)
314 char errmsg
[STRERR_MAXSZ
];
316 estr_write ("Operating system error: ");
317 estr_write (gf_strerror (errno
, errmsg
, STRERR_MAXSZ
));
319 estr_write (message
);
326 /* void runtime_error()-- These are errors associated with an
327 * invalid fortran program. */
330 runtime_error (const char *message
, ...)
335 estr_write ("Fortran runtime error: ");
336 va_start (ap
, message
);
337 st_vprintf (message
, ap
);
342 iexport(runtime_error
);
344 /* void runtime_error_at()-- These are errors associated with a
345 * run time error generated by the front end compiler. */
348 runtime_error_at (const char *where
, const char *message
, ...)
354 estr_write ("\nFortran runtime error: ");
355 va_start (ap
, message
);
356 st_vprintf (message
, ap
);
361 iexport(runtime_error_at
);
365 runtime_warning_at (const char *where
, const char *message
, ...)
370 estr_write ("\nFortran runtime warning: ");
371 va_start (ap
, message
);
372 st_vprintf (message
, ap
);
376 iexport(runtime_warning_at
);
379 /* void internal_error()-- These are this-can't-happen errors
380 * that indicate something deeply wrong. */
383 internal_error (st_parameter_common
*cmp
, const char *message
)
387 estr_write ("Internal Error: ");
388 estr_write (message
);
391 /* This function call is here to get the main.o object file included
392 when linking statically. This works because error.o is supposed to
393 be always linked in (and the function call is in internal_error
394 because hopefully it doesn't happen too often). */
395 stupid_function_name_for_static_linking();
401 /* translate_error()-- Given an integer error code, return a string
402 * describing the error. */
405 translate_error (int code
)
420 p
= "Successful return";
424 p
= "Operating system error";
427 case LIBERROR_BAD_OPTION
:
428 p
= "Bad statement option";
431 case LIBERROR_MISSING_OPTION
:
432 p
= "Missing statement option";
435 case LIBERROR_OPTION_CONFLICT
:
436 p
= "Conflicting statement options";
439 case LIBERROR_ALREADY_OPEN
:
440 p
= "File already opened in another unit";
443 case LIBERROR_BAD_UNIT
:
444 p
= "Unattached unit";
447 case LIBERROR_FORMAT
:
451 case LIBERROR_BAD_ACTION
:
452 p
= "Incorrect ACTION specified";
455 case LIBERROR_ENDFILE
:
456 p
= "Read past ENDFILE record";
459 case LIBERROR_BAD_US
:
460 p
= "Corrupt unformatted sequential file";
463 case LIBERROR_READ_VALUE
:
464 p
= "Bad value during read";
467 case LIBERROR_READ_OVERFLOW
:
468 p
= "Numeric overflow on read";
471 case LIBERROR_INTERNAL
:
472 p
= "Internal error in run-time library";
475 case LIBERROR_INTERNAL_UNIT
:
476 p
= "Internal unit I/O error";
479 case LIBERROR_DIRECT_EOR
:
480 p
= "Write exceeds length of DIRECT access record";
483 case LIBERROR_SHORT_RECORD
:
484 p
= "I/O past end of record on unformatted file";
487 case LIBERROR_CORRUPT_FILE
:
488 p
= "Unformatted file structure has been corrupted";
492 p
= "Unknown error code";
500 /* generate_error()-- Come here when an error happens. This
501 * subroutine is called if it is possible to continue on after the error.
502 * If an IOSTAT or IOMSG variable exists, we set it. If IOSTAT or
503 * ERR labels are present, we return, otherwise we terminate the program
504 * after printing a message. The error code is always required but the
505 * message parameter can be NULL, in which case a string describing
506 * the most recent operating system error is used. */
509 generate_error (st_parameter_common
*cmp
, int family
, const char *message
)
511 char errmsg
[STRERR_MAXSZ
];
513 /* If there was a previous error, don't mask it with another
514 error message, EOF or EOR condition. */
516 if ((cmp
->flags
& IOPARM_LIBRETURN_MASK
) == IOPARM_LIBRETURN_ERROR
)
519 /* Set the error status. */
520 if ((cmp
->flags
& IOPARM_HAS_IOSTAT
))
521 *cmp
->iostat
= (family
== LIBERROR_OS
) ? errno
: family
;
525 (family
== LIBERROR_OS
) ? gf_strerror (errno
, errmsg
, STRERR_MAXSZ
) :
526 translate_error (family
);
528 if (cmp
->flags
& IOPARM_HAS_IOMSG
)
529 cf_strcpy (cmp
->iomsg
, cmp
->iomsg_len
, message
);
531 /* Report status back to the compiler. */
532 cmp
->flags
&= ~IOPARM_LIBRETURN_MASK
;
536 cmp
->flags
|= IOPARM_LIBRETURN_EOR
;
537 if ((cmp
->flags
& IOPARM_EOR
))
542 cmp
->flags
|= IOPARM_LIBRETURN_END
;
543 if ((cmp
->flags
& IOPARM_END
))
548 cmp
->flags
|= IOPARM_LIBRETURN_ERROR
;
549 if ((cmp
->flags
& IOPARM_ERR
))
554 /* Return if the user supplied an iostat variable. */
555 if ((cmp
->flags
& IOPARM_HAS_IOSTAT
))
558 /* Terminate the program */
562 estr_write ("Fortran runtime error: ");
563 estr_write (message
);
567 iexport(generate_error
);
570 /* generate_warning()-- Similar to generate_error but just give a warning. */
573 generate_warning (st_parameter_common
*cmp
, const char *message
)
579 estr_write ("Fortran runtime warning: ");
580 estr_write (message
);
585 /* Whether, for a feature included in a given standard set (GFC_STD_*),
586 we should issue an error or a warning, or be quiet. */
589 notification_std (int std
)
593 if (!compile_options
.pedantic
)
594 return NOTIFICATION_SILENT
;
596 warning
= compile_options
.warn_std
& std
;
597 if ((compile_options
.allow_std
& std
) != 0 && !warning
)
598 return NOTIFICATION_SILENT
;
600 return warning
? NOTIFICATION_WARNING
: NOTIFICATION_ERROR
;
604 /* Possibly issue a warning/error about use of a nonstandard (or deleted)
605 feature. An error/warning will be issued if the currently selected
606 standard does not contain the requested bits. */
609 notify_std (st_parameter_common
*cmp
, int std
, const char * message
)
613 if (!compile_options
.pedantic
)
616 warning
= compile_options
.warn_std
& std
;
617 if ((compile_options
.allow_std
& std
) != 0 && !warning
)
624 estr_write ("Fortran runtime error: ");
625 estr_write (message
);
632 estr_write ("Fortran runtime warning: ");
633 estr_write (message
);