source: trunk/src/kernel32/misc.cpp@ 3483

Last change on this file since 3483 was 3483, checked in by sandervl, 25 years ago

added exception stack dump code; GetLocaleInfoA fixes
File size: 19.5 KB
Line 
1/* $Id: misc.cpp,v 1.22 2000-05-02 20:53:13 sandervl Exp $ */
2
3/*
4 * Project Odin Software License can be found in LICENSE.TXT
5 * Logging procedures
6 *
7 * Copyright 1998 Sander van Leeuwen (sandervl@xs4all.nl)
8 * Copyright 1998 Joel Troster
9 * Copyright 1998 Peter FitzSimmons
10 *
11 */
12
13
14/*****************************************************************************
15 * Includes *
16 *****************************************************************************/
17
18#define INCL_BASE
19#define INCL_WIN
20#define INCL_WINERRORS
21#define INCL_DOSFILEMGR
22#include <os2wrap.h> //Odin32 OS/2 api wrappers
23#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <stdarg.h>
27#include <win32type.h>
28#include <misc.h>
29#include "initterm.h"
30#include "logging.h"
31#include <wprocess.h>
32
33/*****************************************************************************
34 * PMPRINTF Version *
35 *****************************************************************************/
36
37#ifdef PMPRINTF
38
39/* ----- Customization variables ----- */
40#define PRINTFID ""
41#define PRINTFMAXLEN 300
42#define PRINTFLINELEN 100
43#define PRINTFTHREADS 54
44#define PRINTFQNAME "\\QUEUES\\PRINTF32"
45
46/* ----- Includes and externals ----- */
47#include <stddef.h> /* .. */
48#include <time.h> /* .. */
49
50extern ULONG flAllocMem; /*Tue 03.03.1998: knut */
51
52/* ----- Local defines ----- */
53#define PRINTFIDSIZE sizeof(PRINTFID)
54#define PRINTFMAXBUF PRINTFIDSIZE+PRINTFLINELEN
55
56
57/*****************************************************************************
58 * Structures *
59 *****************************************************************************/
60
61/* ----- Per-thread output buffer and current indices into line ---- */
62struct perthread {
63 LONG lineindex; /* where next char */
64 LONG tidemark; /* rightmost char */
65 int bell; /* TRUE if line has bell */
66 UCHAR line[PRINTFMAXBUF]; /* accumulator */
67 };
68
69/* ----- Local static variables ----- */
70static ULONG ourpid=0; /* our process ID */
71static ULONG servepid=0; /* process IDs of the server */
72static HQUEUE qhandle=0; /* handle for the queue */
73static struct perthread *tps[PRINTFTHREADS+1]; /* -> per-thread data */
74
75/* ----- Local subroutine ----- */
76static int printf_(struct perthread *);
77
78
79/* ----------------------------------------------------------------- */
80/* The "printf" function. Note this has a variable number of */
81/* arguments. */
82/* ----------------------------------------------------------------- */
83int SYSTEM EXPORT WriteLog(char *f, ...)
84 {
85 TIB *ptib; /* process/thread id structures */
86 PIB *ppib; /* .. */
87 TID ourtid; /* thread ID */
88 struct perthread *tp; /* pointer to per-thread data */
89 int rc; /* returncode */
90 ULONG urc; /* returncode */
91
92 urc=DosOpenQueue(&servepid, &qhandle, PRINTFQNAME); /* Open the Q */
93 /* Non-0 RC means Q does not exist or cannot be opened */
94 if (urc==343) return 0; /* queue does not exist, so quit */
95 if (urc!=0) return -1; /* report any other error */
96
97 /* First determine our thread ID (and hence get access to the */
98 /* correct per-thread data. If the per-thread data has not been */
99 /* allocated, then allocate it now. It is never freed, once */
100 /* allocated, as PRINTF is not notified of end-of-thread. */
101 DosGetInfoBlocks(&ptib,&ppib); /* get process/thread info */
102 ourtid=ptib->tib_ptib2->tib2_ultid; /* .. and copy TID */
103 if (ourtid>PRINTFTHREADS) /* too many threads .. */
104 return 0; /* .. so quit, quietly */
105 tp=tps[ourtid]; /* copy to local pointer */
106 if (tp==NULL) { /* uninitialized (NULL=0) */
107 /* allocate a per-thread structure */
108 tp=(struct perthread *)malloc(sizeof(struct perthread));
109 if (tp==NULL) return -1; /* out of memory -- return error */
110 tps[ourtid]=tp; /* save for future calls */
111 strcpy(tp->line,PRINTFID); /* initialize: line.. */
112 tp->lineindex=PRINTFIDSIZE-1; /* ..where next char */
113 tp->tidemark =PRINTFIDSIZE-2; /* ..rightmost char */
114 tp->bell=FALSE; /* ..if line has bell */
115 if (ourpid==0) ourpid=ppib->pib_ulpid; /* save PID for all to use */
116 }
117
118 { /* Block for declarations -- only needed if queue exists, etc. */
119 LONG count; /* count of characters formatted */
120 UCHAR buffer[PRINTFMAXLEN+1]; /* formatting area */
121 LONG i, newind; /* work */
122 UCHAR ch; /* .. */
123 va_list argptr; /* -> variable argument list */
124
125 va_start(argptr, f); /* get pointer to argument list */
126 count=vsprintf(buffer, f, argptr);
127 va_end(argptr); /* done with variable arguments */
128
129 if (count<0) return count-1000;/* bad start */
130
131 if (count>PRINTFMAXLEN) {
132 /* Disaster -- we are probably "dead", but just in case we */
133 /* are not, carry on with truncated data. */
134 count=PRINTFMAXLEN;
135 }
136 buffer[count]='\0'; /* ensure terminated */
137 /* OK, ready to go with the data now in BUFFER */
138 /* We copy from the formatted string to the output (line) buffer, */
139 /* taking note of certain control characters and sending a line */
140 /* the queue whenever we see a LF control, or when the line */
141 /* fills (causing a forced break). */
142 for (i=0; ; i++) {
143 ch=buffer[i]; if (!ch) break;
144 switch(ch) {
145 case '\r': /* carriage return */
146 tp->lineindex=PRINTFIDSIZE-1; /* back to start of line */
147 break;
148 case '\n': /* new line */
149 case '\f': /* form feed */
150 rc=printf_(tp); /* print a line */
151 if (rc!=0) return rc; /* error */
152 break;
153 case '\t': /* tab */
154 newind=tp->lineindex-PRINTFIDSIZE+1; /* offset into data */
155 newind=tp->lineindex+5-newind%5; /* new index requested */
156 if (newind>=PRINTFMAXBUF) newind=PRINTFMAXBUF; /* clamp */
157 for (; tp->lineindex<newind; tp->lineindex++) {
158 if (tp->lineindex>tp->tidemark) { /* beyond current end */
159 tp->line[tp->lineindex]=' '; /* add space */
160 tp->tidemark=tp->lineindex;
161 }
162 }
163 break;
164 case '\v': /* vertical tab */
165 /* ignore it */
166 break;
167 case '\b': /* backspace */
168 tp->lineindex=max(tp->lineindex-1,PRINTFIDSIZE);
169 break;
170 case '\a': /* alert (bell) */
171 tp->bell=TRUE;
172 break;
173 default: /* ordinary character */
174 tp->line[tp->lineindex]=ch;
175 if (tp->lineindex>tp->tidemark) /* is rightmost.. */
176 tp->tidemark=tp->lineindex;
177 tp->lineindex++; /* step for next */
178 } /* switch */
179 if (tp->lineindex>=PRINTFMAXBUF) {
180 rc=printf_(tp); /* print a line */
181 if (rc!=0) return rc; /* error */
182 }
183
184 } /* copy loop */
185 return count; /* all formatted data processed */
186 } /* block */
187 } /* printf */
188
189/* ----- printf_(tp) -- Local subroutine to send a line ------------ */
190/* A line has been completed (or overflowed): write it to the queue. */
191int printf_(struct perthread *tp) /* pointer to per-thread data */
192 {
193 ULONG urc; /* unsigned returncode */
194 PSZ pszTo, pszFrom; /* character pointers */
195 PVOID addr; /* address of output data */
196 long size; /* total size of output data */
197 time_t timenow; /* holds current time */
198
199 tp->line[tp->tidemark+1]='\0'; /* add terminator */
200 size=tp->tidemark+2; /* total length of data */
201
202 /* Get some shared memory that can be given away */
203 urc=DosAllocSharedMem(&addr, NULL, (unsigned)size,
204 OBJ_GIVEABLE|PAG_WRITE|PAG_COMMIT|flAllocMem);
205 /*knut: added flAllocMem */
206
207 if (urc!=0) return -2; /* error */
208
209 pszTo=addr; /* copy for clarity */
210 pszFrom=&(tp->line[0]); /* pointer to source */
211 strcpy(pszTo,pszFrom); /* copy the string to shared memory */
212
213 if (ourpid!=servepid) { /* (no giveaway needed if to self) */
214 urc=DosGiveSharedMem(addr, servepid, PAG_READ); /* give access */
215 if (urc!=0) return -3;} /* error */
216
217 /* Write the selector, size, and timestamp to the queue */
218 if (tp->bell) size=-size; /* BELL passed by negation */
219 time(&timenow); /* optional - else use 0 */
220 urc=DosWriteQueue(qhandle, /* handle */
221 (unsigned)timenow, /* 'request' (timestamp) */
222 (unsigned)size, /* 'length' (length/bell) */
223 addr, /* 'address' (address) */
224 0); /* priority (FIFO if enabled) */
225 if (urc!=0) return -4; /* error */
226 if (ourpid!=servepid) { /* if given away.. */
227 urc=DosFreeMem(addr); /* .. *we* are done with it */
228 if (urc!=0) return -5;} /* error */
229 /* Reset the line buffer and indices */
230 tp->lineindex=PRINTFIDSIZE-1; /* where next char */
231 tp->tidemark =PRINTFIDSIZE-2; /* rightmost char */
232 tp->bell =FALSE; /* true if line has bell */
233 return 0; /* success! */
234 } /* printf_ */
235#endif
236
237
238
239/*****************************************************************************
240 * Standard Version *
241 *****************************************************************************/
242
243static FILE *flog = NULL; /*PLF Mon 97-09-08 20:00:15*/
244static BOOL init = FALSE;
245static BOOL fLogging = TRUE;
246static int dwEnableLogging = 1;
247
248//#define CHECK_ODINHEAP
249#if defined(DEBUG) && defined(CHECK_ODINHEAP)
250int checkOdinHeap = 1;
251#define ODIN_HEAPCHECK() if(checkOdinHeap) _heap_check();
252#else
253#define ODIN_HEAPCHECK()
254#endif
255
256int SYSTEM EXPORT WriteLog(char *tekst, ...)
257{
258 USHORT sel = RestoreOS2FS();
259 va_list argptr;
260
261 ODIN_HEAPCHECK();
262
263 if(!init)
264 {
265 init = TRUE;
266
267#ifdef DEFAULT_LOGGING_OFF
268 if(getenv("WIN32LOG_ENABLED")) {
269#else
270 if(!getenv("NOWIN32LOG")) {
271#endif
272 char logname[CCHMAXPATH];
273
274 sprintf(logname, "odin32_%d.log", loadNr);
275 flog = fopen(logname, "w");
276 if(flog == NULL) {//probably running exe on readonly device
277 sprintf(logname, "%sodin32_%d.log", kernel32Path, loadNr);
278 flog = fopen(logname, "w");
279 }
280 }
281 else
282 fLogging = FALSE;
283 }
284
285 if(fLogging && flog && (dwEnableLogging > 0))
286 {
287 THDB *thdb = GetThreadTHDB();
288
289 va_start(argptr, tekst);
290 if(thdb) {
291 thdb->logfile = (DWORD)flog;
292 fprintf(flog, "t%d: ", thdb->threadId);
293 }
294 vfprintf(flog, tekst, argptr);
295 if(thdb) thdb->logfile = 0;
296 va_end(argptr);
297
298 if(tekst[strlen(tekst)-1] != '\n')
299 fprintf(flog, "\n");
300 }
301 SetFS(sel);
302 return 1;
303}
304//******************************************************************************
305//******************************************************************************
306int SYSTEM EXPORT WriteLogNoEOL(char *tekst, ...)
307{
308 USHORT sel = RestoreOS2FS();
309 va_list argptr;
310
311 ODIN_HEAPCHECK();
312
313 if(!init)
314 {
315 init = TRUE;
316
317#ifdef DEFAULT_LOGGING_OFF
318 if(getenv("WIN32LOG_ENABLED")) {
319#else
320 if(!getenv("NOWIN32LOG")) {
321#endif
322 char logname[CCHMAXPATH];
323
324 sprintf(logname, "odin32_%d.log", loadNr);
325 flog = fopen(logname, "w");
326 if(flog == NULL) {//probably running exe on readonly device
327 sprintf(logname, "%sodin32_%d.log", kernel32Path, loadNr);
328 flog = fopen(logname, "w");
329 }
330 }
331 else
332 fLogging = FALSE;
333 }
334
335 if(fLogging && flog && (dwEnableLogging > 0))
336 {
337 THDB *thdb = GetThreadTHDB();
338
339 va_start(argptr, tekst);
340 if(thdb) {
341 thdb->logfile = (DWORD)flog;
342 }
343 vfprintf(flog, tekst, argptr);
344 if(thdb) thdb->logfile = 0;
345 va_end(argptr);
346 }
347 SetFS(sel);
348 return 1;
349}
350//******************************************************************************
351//******************************************************************************
352void SYSTEM DecreaseLogCount()
353{
354 dwEnableLogging--;
355}
356//******************************************************************************
357//******************************************************************************
358void SYSTEM IncreaseLogCount()
359{
360 dwEnableLogging++;
361}
362//******************************************************************************
363//******************************************************************************
364int SYSTEM EXPORT WritePrivateLog(void *logfile, char *tekst, ...)
365{
366 USHORT sel = RestoreOS2FS();
367 va_list argptr;
368
369 if(fLogging && logfile)
370 {
371 THDB *thdb = GetThreadTHDB();
372
373 va_start(argptr, tekst);
374 vfprintf((FILE *)logfile, tekst, argptr);
375 if(thdb) thdb->logfile = 0;
376 va_end(argptr);
377
378 if(tekst[strlen(tekst)-1] != '\n')
379 fprintf((FILE *)logfile, "\n");
380 }
381
382 SetFS(sel);
383 return 1;
384}
385//******************************************************************************
386//Check if the exception occurred inside a fprintf (logging THDB member set)
387//If true, decrease the lock count for that file stream
388//NOTE: HACK: DEPENDS ON COMPILER VERSION!!!!
389//******************************************************************************
390void CheckLogException()
391{
392 THDB *thdb = GetThreadTHDB();
393 USHORT *lock;
394
395 if(!thdb) return;
396
397 if(thdb->logfile) {
398 //oops, exception in vfprintf; let's clear the lock count
399#if (__IBMCPP__ == 300) || (__IBMC__ == 300)
400 lock = (USHORT *)(thdb->logfile+0x1C);
401#else
402#error Check the offset of the lock count word in the file stream structure for this compiler revision!!!!!
403#endif
404 (*lock)--;
405 }
406}
407//******************************************************************************
408//NOTE: No need to save/restore FS, as our FS selectors have already been
409// destroyed and FS == 0x150B.
410//******************************************************************************
411void CloseLogFile()
412{
413 fclose(flog);
414 flog = 0;
415}
416//******************************************************************************
417//Used to open any private logfiles used in kernel32 (for now only in winimagepeldr.cpp)
418//******************************************************************************
419void OpenPrivateLogFiles()
420{
421#ifdef DEFAULT_LOGGING_OFF
422 if(getenv("WIN32LOG_ENABLED")) {
423#else
424 if(!getenv("NOWIN32LOG")) {
425#endif
426 OpenPrivateLogFilePE();
427 }
428}
429//******************************************************************************
430//Used to close all private logfiles used in kernel32 (for now only in winimagepeldr.cpp)
431//******************************************************************************
432void ClosePrivateLogFiles()
433{
434#ifdef DEFAULT_LOGGING_OFF
435 if(getenv("WIN32LOG_ENABLED")) {
436#else
437 if(!getenv("NOWIN32LOG")) {
438#endif
439 ClosePrivateLogFilePE();
440 }
441}
442//******************************************************************************
443//******************************************************************************
444int SYSTEM EXPORT WriteLogError(char *tekst, ...)
445{
446 USHORT sel = RestoreOS2FS();
447 va_list argptr;
448
449 va_start(argptr, tekst);
450 printf("ERROR: ");
451 vprintf(tekst, argptr);
452 va_end(argptr);
453 if(tekst[strlen(tekst)-1] != '\n')
454 printf("\n");
455
456 SetFS(sel);
457 return 1;
458}
459//******************************************************************************
460//******************************************************************************
461void SYSTEM CheckVersion(ULONG version, char *modname)
462{
463 dprintf(("CheckVersion of %s, %d\n", modname, version));
464 if(version != PE2LX_VERSION){
465 static char msg[300];
466 int r;
467 dprintf(("Version mismatch! %d, %d: %s\n", version, PE2LX_VERSION, modname));
468 sprintf(msg, "%s is intended for use with a different release of PE2LX.\n", modname);
469 do{
470 r = WinMessageBox(HWND_DESKTOP, NULLHANDLE, msg, "Version Mismatch!", 0, MB_ABORTRETRYIGNORE | MB_ICONEXCLAMATION | MB_MOVEABLE);
471 }while(r == MBID_RETRY); // giggle
472 if( r != MBID_IGNORE )
473 exit(987);
474 }
475}
476//******************************************************************************
477//******************************************************************************
478void SYSTEM CheckVersionFromHMOD(ULONG version, HMODULE hModule)
479{
480 char name[_MAX_PATH];
481
482 // query name of dll.
483 if(!DosQueryModuleName(hModule, sizeof(name), name))
484 CheckVersion(version, name);
485}
486//******************************************************************************
487//******************************************************************************
488#ifdef __WATCOMC__ /*PLF Sat 97-06-21 17:12:36*/
489 extern void interrupt3( void );
490 #pragma aux interrupt3= \
491 "int 3"
492#endif
493void WIN32API DebugBreak()
494{
495 dprintf(("DebugBreak\n"));
496
497 LPSTR lpstrEnv = getenv("WIN32.DEBUGBREAK"); /* query environment */
498 if (lpstrEnv == NULL) /* if environment is not set, don't call debugger ! */
499 return;
500
501#ifdef __WATCOMC__
502 interrupt3();
503#else
504 _interrupt(3);
505#endif
506}
507//******************************************************************************
508//******************************************************************************
509
510
511/*****************************************************************************
512 * Name : DebugErrorBox
513 * Purpose : display an apprioriate error box with detailed information
514 * about the error cause
515 * Parameters: APIRET iErrorCode - OS/2 error code
516 * PSZ pszFormat - printf-format string
517 * ...
518 * Variables :
519 * Result : return code of the message box
520 * Remark :
521 * Status :
522 *
523 * Author : Patrick Haller [Tue, 1999/09/13 19:55]
524 *****************************************************************************/
525
526int SYSTEM EXPORT DebugErrorBox(ULONG iErrorCode,
527 char* pszFormat,
528 ...)
529{
530 char szMessageBuffer[1024]; /* buffer for the text message */
531 char szErrorBuffer[1024]; /* buffer for the operating system text */
532 ULONG bc; /* dummy */
533 APIRET rc2; /* API returncode */
534 int iRC; /* message box return code */
535
536 USHORT sel = RestoreOS2FS();
537 va_list argptr;
538
539 // clear memory
540 memset (szMessageBuffer, 0, sizeof(szMessageBuffer));
541 memset (szErrorBuffer, 0, sizeof(szErrorBuffer));
542
543 // build message string
544 va_start(argptr, pszFormat);
545 vsprintf(szMessageBuffer, pszFormat, argptr);
546 va_end(argptr);
547
548 // query error string
549 rc2 = DosGetMessage(NULL,
550 0,
551 szErrorBuffer,
552 sizeof(szErrorBuffer),
553 iErrorCode,
554 "OSO001.MSG",
555 &bc);
556
557 // display message box
558 iRC = WinMessageBox(HWND_DESKTOP,
559 NULLHANDLE,
560 szMessageBuffer,
561 szErrorBuffer,
562 0,
563 MB_OK | MB_ICONEXCLAMATION | MB_MOVEABLE);
564 SetFS(sel);
565 return iRC;
566}
Note: See TracBrowser for help on using the repository browser.