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

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

added (disabled) heapcheck option for writelog
File size: 18.5 KB
Line 
1/* $Id: misc.cpp,v 1.21 2000-04-13 18:48:02 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//******************************************************************************
306void SYSTEM DecreaseLogCount()
307{
308 dwEnableLogging--;
309}
310//******************************************************************************
311//******************************************************************************
312void SYSTEM IncreaseLogCount()
313{
314 dwEnableLogging++;
315}
316//******************************************************************************
317//******************************************************************************
318int SYSTEM EXPORT WritePrivateLog(void *logfile, char *tekst, ...)
319{
320 USHORT sel = RestoreOS2FS();
321 va_list argptr;
322
323 if(fLogging && logfile)
324 {
325 THDB *thdb = GetThreadTHDB();
326
327 va_start(argptr, tekst);
328 vfprintf((FILE *)logfile, tekst, argptr);
329 if(thdb) thdb->logfile = 0;
330 va_end(argptr);
331
332 if(tekst[strlen(tekst)-1] != '\n')
333 fprintf((FILE *)logfile, "\n");
334 }
335
336 SetFS(sel);
337 return 1;
338}
339//******************************************************************************
340//Check if the exception occurred inside a fprintf (logging THDB member set)
341//If true, decrease the lock count for that file stream
342//NOTE: HACK: DEPENDS ON COMPILER VERSION!!!!
343//******************************************************************************
344void CheckLogException()
345{
346 THDB *thdb = GetThreadTHDB();
347 USHORT *lock;
348
349 if(!thdb) return;
350
351 if(thdb->logfile) {
352 //oops, exception in vfprintf; let's clear the lock count
353#if (__IBMCPP__ == 300) || (__IBMC__ == 300)
354 lock = (USHORT *)(thdb->logfile+0x1C);
355#else
356#error Check the offset of the lock count word in the file stream structure for this compiler revision!!!!!
357#endif
358 (*lock)--;
359 }
360}
361//******************************************************************************
362//NOTE: No need to save/restore FS, as our FS selectors have already been
363// destroyed and FS == 0x150B.
364//******************************************************************************
365void CloseLogFile()
366{
367 fclose(flog);
368 flog = 0;
369}
370//******************************************************************************
371//Used to open any private logfiles used in kernel32 (for now only in winimagepeldr.cpp)
372//******************************************************************************
373void OpenPrivateLogFiles()
374{
375#ifdef DEFAULT_LOGGING_OFF
376 if(getenv("WIN32LOG_ENABLED")) {
377#else
378 if(!getenv("NOWIN32LOG")) {
379#endif
380 OpenPrivateLogFilePE();
381 }
382}
383//******************************************************************************
384//Used to close all private logfiles used in kernel32 (for now only in winimagepeldr.cpp)
385//******************************************************************************
386void ClosePrivateLogFiles()
387{
388#ifdef DEFAULT_LOGGING_OFF
389 if(getenv("WIN32LOG_ENABLED")) {
390#else
391 if(!getenv("NOWIN32LOG")) {
392#endif
393 ClosePrivateLogFilePE();
394 }
395}
396//******************************************************************************
397//******************************************************************************
398int SYSTEM EXPORT WriteLogError(char *tekst, ...)
399{
400 USHORT sel = RestoreOS2FS();
401 va_list argptr;
402
403 va_start(argptr, tekst);
404 printf("ERROR: ");
405 vprintf(tekst, argptr);
406 va_end(argptr);
407 if(tekst[strlen(tekst)-1] != '\n')
408 printf("\n");
409
410 SetFS(sel);
411 return 1;
412}
413//******************************************************************************
414//******************************************************************************
415void SYSTEM CheckVersion(ULONG version, char *modname)
416{
417 dprintf(("CheckVersion of %s, %d\n", modname, version));
418 if(version != PE2LX_VERSION){
419 static char msg[300];
420 int r;
421 dprintf(("Version mismatch! %d, %d: %s\n", version, PE2LX_VERSION, modname));
422 sprintf(msg, "%s is intended for use with a different release of PE2LX.\n", modname);
423 do{
424 r = WinMessageBox(HWND_DESKTOP, NULLHANDLE, msg, "Version Mismatch!", 0, MB_ABORTRETRYIGNORE | MB_ICONEXCLAMATION | MB_MOVEABLE);
425 }while(r == MBID_RETRY); // giggle
426 if( r != MBID_IGNORE )
427 exit(987);
428 }
429}
430//******************************************************************************
431//******************************************************************************
432void SYSTEM CheckVersionFromHMOD(ULONG version, HMODULE hModule)
433{
434 char name[_MAX_PATH];
435
436 // query name of dll.
437 if(!DosQueryModuleName(hModule, sizeof(name), name))
438 CheckVersion(version, name);
439}
440//******************************************************************************
441//******************************************************************************
442#ifdef __WATCOMC__ /*PLF Sat 97-06-21 17:12:36*/
443 extern void interrupt3( void );
444 #pragma aux interrupt3= \
445 "int 3"
446#endif
447void WIN32API DebugBreak()
448{
449 dprintf(("DebugBreak\n"));
450
451 LPSTR lpstrEnv = getenv("WIN32.DEBUGBREAK"); /* query environment */
452 if (lpstrEnv == NULL) /* if environment is not set, don't call debugger ! */
453 return;
454
455#ifdef __WATCOMC__
456 interrupt3();
457#else
458 _interrupt(3);
459#endif
460}
461//******************************************************************************
462//******************************************************************************
463
464
465/*****************************************************************************
466 * Name : DebugErrorBox
467 * Purpose : display an apprioriate error box with detailed information
468 * about the error cause
469 * Parameters: APIRET iErrorCode - OS/2 error code
470 * PSZ pszFormat - printf-format string
471 * ...
472 * Variables :
473 * Result : return code of the message box
474 * Remark :
475 * Status :
476 *
477 * Author : Patrick Haller [Tue, 1999/09/13 19:55]
478 *****************************************************************************/
479
480int SYSTEM EXPORT DebugErrorBox(ULONG iErrorCode,
481 char* pszFormat,
482 ...)
483{
484 char szMessageBuffer[1024]; /* buffer for the text message */
485 char szErrorBuffer[1024]; /* buffer for the operating system text */
486 ULONG bc; /* dummy */
487 APIRET rc2; /* API returncode */
488 int iRC; /* message box return code */
489
490 USHORT sel = RestoreOS2FS();
491 va_list argptr;
492
493 // clear memory
494 memset (szMessageBuffer, 0, sizeof(szMessageBuffer));
495 memset (szErrorBuffer, 0, sizeof(szErrorBuffer));
496
497 // build message string
498 va_start(argptr, pszFormat);
499 vsprintf(szMessageBuffer, pszFormat, argptr);
500 va_end(argptr);
501
502 // query error string
503 rc2 = DosGetMessage(NULL,
504 0,
505 szErrorBuffer,
506 sizeof(szErrorBuffer),
507 iErrorCode,
508 "OSO001.MSG",
509 &bc);
510
511 // display message box
512 iRC = WinMessageBox(HWND_DESKTOP,
513 NULLHANDLE,
514 szMessageBuffer,
515 szErrorBuffer,
516 0,
517 MB_OK | MB_ICONEXCLAMATION | MB_MOVEABLE);
518 SetFS(sel);
519 return iRC;
520}
Note: See TracBrowser for help on using the repository browser.