runtime/objc-errors.mm

   1 /*
   2  * Copyright (c) 1999-2003, 2005-2007 Apple Inc.  All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  *      objc-errors.m
  25  *      Copyright 1988-2001, NeXT Software, Inc., Apple Computer, Inc.
  26  */
  27
  28 #include "objc-private.h"
  29
  30 #if TARGET_OS_WIN32
  31
  32 #include <conio.h>
  33
  34 void _objc_inform_on_crash(const char *fmt, ...)
  35 {
  36 }
  37
  38 void _objc_inform(const char *fmt, ...)
  39 {
  40     va_list args;
  41     va_start(args, fmt);
  42     _vcprintf(fmt, args);
  43     va_end(args);
  44     _cprintf("\n");
  45 }
  46
  47 void _objc_fatal(const char *fmt, ...)
  48 {
  49     va_list args;
  50     va_start(args, fmt);
  51     _vcprintf(fmt, args);
  52     va_end(args);
  53     _cprintf("\n");
  54
  55     abort();
  56 }
  57
  58 void __objc_error(id rcv, const char *fmt, ...)
  59 {
  60     va_list args;
  61     va_start(args, fmt);
  62     _vcprintf(fmt, args);
  63     va_end(args);
  64
  65     abort();
  66 }
  67
  68 void _objc_error(id rcv, const char *fmt, va_list args)
  69 {
  70     _vcprintf(fmt, args);
  71
  72     abort();
  73 }
  74
  75 #else
  76
  77 #include <vproc_priv.h>
  78
  79 OBJC_EXPORT void        (*_error)(id, const char *, va_list);
  80
  81 static void _objc_trap(void) __attribute__((noreturn));
  82
  83 // Add "message" to any forthcoming crash log.
  84 static void _objc_crashlog(const char *message)
  85 {
  86     char *newmsg;
  87
  88 #if 0
  89     {
  90         // for debugging at BOOT time.
  91         extern char **_NSGetProgname(void);
  92         FILE *crashlog = fopen("/_objc_crash.log", "a");
  93         setbuf(crashlog, NULL);
  94         fprintf(crashlog, "[%s] %s\n", *_NSGetProgname(), message);
  95         fclose(crashlog);
  96         sync();
  97     }
  98 #endif
  99
 100     static mutex_t crashlog_lock = MUTEX_INITIALIZER;
 101     mutex_lock(&crashlog_lock);
 102
 103     char *oldmsg = (char *)CRGetCrashLogMessage();
 104
 105     if (!oldmsg) {
 106         newmsg = strdup(message);
 107     } else {
 108         asprintf(&newmsg, "%s\n%s", oldmsg, message);
 109     }
 110
 111     if (newmsg) {
 112         // Strip trailing newline
 113         char *c = &newmsg[strlen(newmsg)-1];
 114         if (*c == '\n') *c = '\0';
 115
 116         if (oldmsg) free(oldmsg);
 117         CRSetCrashLogMessage(newmsg);
 118     }
 119
 120     mutex_unlock(&crashlog_lock);
 121 }
 122
 123 // Returns true if logs should be sent to stderr as well as syslog.
 124 // Copied from CFUtilities.c
 125 static bool also_do_stderr(void)
 126 {
 127     struct stat st;
 128     int ret = fstat(STDERR_FILENO, &st);
 129     if (ret < 0) return false;
 130     mode_t m = st.st_mode & S_IFMT;
 131     if (m == S_IFREG  ||  m == S_IFSOCK) return true;
 132     if (!(m == S_IFIFO  ||  m == S_IFCHR)) return false;
 133
 134     // if it could be a pipe back to launchd, fail
 135     int64_t val = 0;
 136     vproc_swap_integer(NULL, VPROC_GSK_IS_MANAGED, NULL, &val);
 137     if (val) return false;
 138
 139     return true;
 140 }
 141
 142 // Print "message" to the console.
 143 static void _objc_syslog(const char *message)
 144 {
 145     syslog(LOG_ERR, "%s", message);
 146
 147     if (also_do_stderr()) {
 148         write(STDERR_FILENO, message, strlen(message));
 149     }
 150 }
 151
 152 /*
 153  * _objc_error is the default *_error handler.
 154  */
 155 #if __OBJC2__
 156 __attribute__((noreturn))
 157 #else
 158 // used by ExceptionHandling.framework
 159 #endif
 160 void _objc_error(id self, const char *fmt, va_list ap)
 161 {
 162     char *buf1;
 163     char *buf2;
 164
 165     vasprintf(&buf1, fmt, ap);
 166     asprintf(&buf2, "objc[%d]: %s: %s\n",
 167              getpid(), object_getClassName(self), buf1);
 168     _objc_syslog(buf2);
 169     _objc_crashlog(buf2);
 170
 171     _objc_trap();
 172 }
 173
 174 /*
 175  * this routine handles errors that involve an object (or class).
 176  */
 177 void __objc_error(id rcv, const char *fmt, ...)
 178 {
 179     va_list vp;
 180
 181     va_start(vp,fmt);
 182 #if !__OBJC2__
 183     (*_error)(rcv, fmt, vp);
 184 #endif
 185     _objc_error (rcv, fmt, vp);  /* In case (*_error)() returns. */
 186     va_end(vp);
 187 }
 188
 189 /*
 190  * this routine handles severe runtime errors...like not being able
 191  * to read the mach headers, allocate space, etc...very uncommon.
 192  */
 193 void _objc_fatal(const char *fmt, ...)
 194 {
 195     va_list ap;
 196     char *buf1;
 197     char *buf2;
 198
 199     va_start(ap,fmt);
 200     vasprintf(&buf1, fmt, ap);
 201     va_end (ap);
 202
 203     asprintf(&buf2, "objc[%d]: %s\n", getpid(), buf1);
 204     _objc_syslog(buf2);
 205     _objc_crashlog(buf2);
 206
 207     _objc_trap();
 208 }
 209
 210 /*
 211  * this routine handles soft runtime errors...like not being able
 212  * add a category to a class (because it wasn't linked in).
 213  */
 214 void _objc_inform(const char *fmt, ...)
 215 {
 216     va_list ap;
 217     char *buf1;
 218     char *buf2;
 219
 220     va_start (ap,fmt);
 221     vasprintf(&buf1, fmt, ap);
 222     va_end (ap);
 223
 224     asprintf(&buf2, "objc[%d]: %s\n", getpid(), buf1);
 225     _objc_syslog(buf2);
 226
 227     free(buf2);
 228     free(buf1);
 229 }
 230
 231
 232 /*
 233  * Like _objc_inform(), but prints the message only in any
 234  * forthcoming crash log, not to the console.
 235  */
 236 void _objc_inform_on_crash(const char *fmt, ...)
 237 {
 238     va_list ap;
 239     char *buf1;
 240     char *buf2;
 241
 242     va_start (ap,fmt);
 243     vasprintf(&buf1, fmt, ap);
 244     va_end (ap);
 245
 246     asprintf(&buf2, "objc[%d]: %s\n", getpid(), buf1);
 247     _objc_crashlog(buf2);
 248
 249     free(buf2);
 250     free(buf1);
 251 }
 252
 253
 254 /*
 255  * Like calling both _objc_inform and _objc_inform_on_crash.
 256  */
 257 void _objc_inform_now_and_on_crash(const char *fmt, ...)
 258 {
 259     va_list ap;
 260     char *buf1;
 261     char *buf2;
 262
 263     va_start (ap,fmt);
 264     vasprintf(&buf1, fmt, ap);
 265     va_end (ap);
 266
 267     asprintf(&buf2, "objc[%d]: %s\n", getpid(), buf1);
 268     _objc_crashlog(buf2);
 269     _objc_syslog(buf2);
 270
 271     free(buf2);
 272     free(buf1);
 273 }
 274
 275
 276 /* Kill the process in a way that generates a crash log.
 277  * This is better than calling exit(). */
 278 static void _objc_trap(void)
 279 {
 280     __builtin_trap();
 281 }
 282
 283 /* Try to keep _objc_warn_deprecated out of crash logs
 284  * caused by _objc_trap(). rdar://4546883 */
 285 __attribute__((used))
 286 static void _objc_trap2(void)
 287 {
 288     __builtin_trap();
 289 }
 290
 291 #endif
 292
 293
 294 BREAKPOINT_FUNCTION(
 295     void _objc_warn_deprecated(void)
 296 );
 297
 298 void _objc_inform_deprecated(const char *oldf, const char *newf)
 299 {
 300     if (PrintDeprecation) {
 301         if (newf) {
 302             _objc_inform("The function %s is obsolete. Use %s instead. Set a breakpoint on _objc_warn_deprecated to find the culprit.", oldf, newf);
 303         } else {
 304             _objc_inform("The function %s is obsolete. Do not use it. Set a breakpoint on _objc_warn_deprecated to find the culprit.", oldf);
 305         }
 306     }
 307     _objc_warn_deprecated();
 308 }