src/WINNT/afsd/afsd_eventlog.c

   1 ////////////////////////////////////////////////////////////////////
   2 //
   3 //
   4 //              E V E N T   L O G G I N G   F U N C T I O N S
   5 //
   6 //
   7 ////////////////////////////////////////////////////////////////////
   8
   9
  10 #include <windows.h>
  11 #include <stdarg.h>
  12 #include <string.h>
  13 #include <strsafe.h>
  14 #include <WINNT/afsreg.h>
  15 #include "afsd.h"
  16 #include "afsd_eventlog.h"
  17
  18 static BOOL     GetServicePath(LPTSTR lpPathBuf, PDWORD pdwPathBufSize);
  19 static BOOL     AddEventSource(void);
  20
  21 static BOOL
  22 GetServicePath(LPTSTR lpPathBuf, PDWORD pdwPathBufSize)
  23 {
  24     HKEY        hKey = NULL;
  25     DWORD       dwData = 0;
  26     BOOL        bRet = TRUE;
  27
  28     do {
  29         // Open key
  30         if ( RegOpenKeyEx( HKEY_LOCAL_MACHINE, AFSREG_CLT_SVC_SUBKEY, 0, KEY_QUERY_VALUE, &hKey ) )
  31         {
  32             bRet = FALSE;
  33             break;
  34         }
  35
  36         // prepare user's buffer and read into it
  37         dwData = *pdwPathBufSize;
  38         memset(lpPathBuf, '\0', dwData);
  39         if ( RegQueryValueEx( hKey,                     // handle to key
  40                               "ImagePath",              // value name
  41                               NULL,                     // reserved
  42                               NULL,                     // type buffer
  43                               (LPBYTE) lpPathBuf,       // data buffer
  44                               &dwData))         // size of data buffer
  45         {
  46             bRet = FALSE;
  47             break;
  48         }
  49
  50         *pdwPathBufSize = dwData;
  51
  52     } while (0);
  53
  54     if (hKey != NULL)
  55         RegCloseKey(hKey);
  56
  57     return bRet;
  58 }
  59
  60 //
  61 // Ensure name for message file is in proper location in Registry.
  62 //
  63 static BOOL
  64 AddEventSource()
  65 {
  66     HKEY        hKey = NULL, hLogKey;
  67     UCHAR       szBuf[MAX_PATH] = "afsd_service.exe";
  68     DWORD       dwData, dwDisposition;
  69     static BOOL bRet = TRUE;
  70     static BOOL bOnce = TRUE;
  71
  72     if (!bOnce)
  73         return bRet;
  74
  75     if ( RegOpenKeyEx( HKEY_LOCAL_MACHINE, AFSREG_APPLOG_SUBKEY, 0,
  76                        KEY_SET_VALUE, &hLogKey ) )
  77     {
  78         // nope - create it
  79         if ( RegCreateKeyEx(HKEY_LOCAL_MACHINE, AFSREG_APPLOG_SUBKEY, 0,
  80                              NULL, REG_OPTION_NON_VOLATILE,
  81                              KEY_ALL_ACCESS, NULL, &hLogKey,
  82                              &dwDisposition))
  83         {
  84             bRet = FALSE;
  85             goto done;
  86         }
  87     }
  88
  89     // Let's see if key already exists as a subkey under the
  90     // Application key in the EventLog registry key.  If not,
  91     // create it.
  92     if ( RegOpenKeyEx( hLogKey, AFSREG_CLT_APPLOG_SUBKEY, 0,
  93                        KEY_SET_VALUE, &hKey ) )
  94     {
  95         // nope - create it
  96         if ( RegCreateKeyEx(hLogKey, AFSREG_CLT_APPLOG_SUBKEY, 0,
  97                              NULL, REG_OPTION_NON_VOLATILE,
  98                              KEY_ALL_ACCESS, NULL, &hKey,
  99                              &dwDisposition))
 100         {
 101             bRet = FALSE;
 102             goto done;
 103         }
 104     }
 105
 106     // Add the name to the EventMessageFile subkey.
 107     if ( RegSetValueEx( hKey,                   // subkey handle
 108                         AFSREG_APPLOG_MSGFILE_VALUE,    // value name
 109                         0,                      // must be zero
 110                         REG_SZ,                 // value type
 111                         (LPBYTE) szBuf,         // pointer to value data
 112                         (DWORD)strlen(szBuf) + 1))      // length of value data
 113     {
 114         bRet = FALSE;
 115         goto done;
 116     }
 117
 118     // Set the supported event types in the TypesSupported subkey.
 119     dwData = EVENTLOG_ERROR_TYPE | EVENTLOG_WARNING_TYPE |
 120         EVENTLOG_INFORMATION_TYPE;
 121
 122     if ( RegSetValueEx( hKey,                   // subkey handle
 123                         AFSREG_APPLOG_MSGTYPE_VALUE,    // value name
 124                         0,                      // must be zero
 125                         REG_DWORD,              // value type
 126                         (LPBYTE) &dwData,       // pointer to value data
 127                         sizeof(DWORD)))         // length of value data
 128     {
 129         bRet = FALSE;
 130         goto done;
 131     }
 132
 133   done:
 134     if (hKey != NULL)
 135         RegCloseKey(hKey);
 136
 137     if (hLogKey != NULL)
 138         RegCloseKey(hLogKey);
 139
 140     return bRet;
 141 }
 142
 143 // Log an event with a formatted system message as the (only) substitution
 144 // string, from the given message ID.
 145 VOID
 146 LogEventMessage(WORD wEventType, DWORD dwEventID, DWORD dwMessageID)
 147 {
 148     LPTSTR msgBuf;
 149
 150     FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
 151                    NULL, dwMessageID, 0, (LPTSTR)&msgBuf, 0, NULL);
 152     LogEvent(wEventType, dwEventID, msgBuf, NULL);
 153     LocalFree(msgBuf);
 154 }
 155
 156 //
 157 // Use the ReportEvent API to write an entry to the system event log.
 158 //
 159 #define MAXARGS 8
 160 #define STRLEN  64
 161 VOID
 162 LogEvent(WORD wEventType, DWORD dwEventID, ...)
 163 {
 164     va_list     listArgs;
 165     HANDLE      hEventSource;
 166     LPTSTR      lpArgs[MAXARGS];
 167     CHAR        lpStrings[MAXARGS][STRLEN];
 168     WORD        wNumArgs = 0;
 169     WORD        wNumStrings = 0;
 170     DWORD       code;
 171
 172     // Ensure that our event source is properly initialized.
 173     if (!AddEventSource())
 174         return;
 175
 176     // Get a handle to the event log.
 177     hEventSource = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
 178     if (hEventSource == NULL)
 179         return;
 180
 181     // Construct the array of substitution strings.
 182     va_start(listArgs, dwEventID);
 183
 184     switch ( dwEventID ) {
 185     case MSG_FLUSH_NO_SHARE_NAME:
 186     case MSG_FLUSH_NO_MEMORY:
 187     case MSG_FLUSH_IMPERSONATE_ERROR:
 188     case MSG_FLUSH_UNEXPECTED_EVENT:
 189     case MSG_UNHANDLED_EXCEPTION:
 190     case MSG_SMB_ZERO_TRANSACTION_COUNT:
 191     case MSG_SERVICE_START_PENDING:
 192     case MSG_SERVICE_INCORRECT_VERSIONS:
 193     case MSG_SERVICE_RUNNING:
 194     case MSG_SERVICE_STOPPING:
 195     case MSG_SERVICE_ERROR_STOP:
 196     case MSG_CRYPT_OFF:
 197     case MSG_CRYPT_ON:
 198         break;
 199     case MSG_FLUSH_BAD_SHARE_NAME:
 200     case MSG_FLUSH_OPEN_ENUM_ERROR:
 201     case MSG_FLUSH_ENUM_ERROR:
 202     case MSG_FLUSH_FAILED:
 203     case MSG_RX_HARD_DEAD_TIME_EXCEEDED:
 204     case MSG_SERVICE_ERROR_STOP_WITH_MSG:
 205     case MSG_SMB_SEND_PACKET_FAILURE:
 206     case MSG_UNEXPECTED_SMB_SESSION_CLOSE:
 207         wNumArgs = 1;
 208         lpArgs[0] = va_arg(listArgs, LPTSTR);
 209         break;
 210     case MSG_TIME_FLUSH_PER_VOLUME:
 211     case MSG_TIME_FLUSH_TOTAL:
 212     case MSG_SMB_MAX_MPX_COUNT:
 213     case MSG_SMB_MAX_BUFFER_SIZE:
 214         wNumArgs = 2;
 215         lpArgs[0] = va_arg(listArgs, LPTSTR);
 216         lpArgs[1] = va_arg(listArgs, LPTSTR);
 217         break;
 218     case MSG_SERVER_REPORTS_VNOVOL:
 219     case MSG_SERVER_REPORTS_VMOVED:
 220     case MSG_SERVER_REPORTS_VOFFLINE:
 221     case MSG_SERVER_REPORTS_VSALVAGE:
 222     case MSG_SERVER_REPORTS_VNOSERVICE:
 223     case MSG_SERVER_REPORTS_VIO:
 224         wNumArgs = 2;
 225         lpArgs[0] = va_arg(listArgs, LPTSTR);
 226         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,afs_int32));
 227         lpArgs[1] = lpStrings[1];
 228         break;
 229     case MSG_BAD_SMB_PARAM:
 230         wNumArgs = 5;
 231         lpArgs[0] = va_arg(listArgs, LPTSTR);
 232         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,int));
 233         StringCbPrintf(lpStrings[2],STRLEN,"%d",va_arg(listArgs,int));
 234         StringCbPrintf(lpStrings[3],STRLEN,"%d",va_arg(listArgs,int));
 235         StringCbPrintf(lpStrings[4],STRLEN,"%d",va_arg(listArgs,WORD));
 236         lpArgs[1] = lpStrings[1];
 237         lpArgs[2] = lpStrings[2];
 238         lpArgs[3] = lpStrings[3];
 239         lpArgs[4] = lpStrings[4];
 240         break;
 241     case MSG_BAD_SMB_PARAM_WITH_OFFSET:
 242         wNumArgs = 6;
 243         lpArgs[0] = va_arg(listArgs, LPTSTR);
 244         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,int));
 245         StringCbPrintf(lpStrings[2],STRLEN,"%d",va_arg(listArgs,int));
 246         StringCbPrintf(lpStrings[3],STRLEN,"%d",va_arg(listArgs,int));
 247         StringCbPrintf(lpStrings[4],STRLEN,"%d",va_arg(listArgs,int));
 248         StringCbPrintf(lpStrings[5],STRLEN,"%d",va_arg(listArgs,WORD));
 249         lpArgs[1] = lpStrings[1];
 250         lpArgs[2] = lpStrings[2];
 251         lpArgs[3] = lpStrings[3];
 252         lpArgs[4] = lpStrings[4];
 253         lpArgs[5] = lpStrings[5];
 254         break;
 255     case MSG_BAD_SMB_TOO_SHORT:
 256     case MSG_BAD_SMB_INVALID:
 257     case MSG_BAD_SMB_INCOMPLETE:
 258         wNumArgs = 1;
 259         StringCbPrintf(lpStrings[0],STRLEN,"%d",va_arg(listArgs,WORD));
 260         lpArgs[0] = lpStrings[0];
 261         break;
 262     case MSG_SMB_SESSION_START:
 263         wNumArgs = 1;
 264         StringCbPrintf(lpStrings[0],STRLEN,"%d",va_arg(listArgs,long));
 265         lpArgs[0] = lpStrings[0];
 266         break;
 267     case MSG_BAD_SMB_WRONG_SESSION:
 268         wNumArgs = 2;
 269         StringCbPrintf(lpStrings[0],STRLEN,"%d",va_arg(listArgs,DWORD));
 270         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,WORD));
 271         lpArgs[0] = lpStrings[0];
 272         lpArgs[1] = lpStrings[1];
 273         break;
 274     case MSG_BAD_VCP:
 275         wNumArgs = 4;
 276         StringCbPrintf(lpStrings[0],STRLEN,"%d",va_arg(listArgs,UCHAR));
 277         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,UCHAR));
 278         StringCbPrintf(lpStrings[2],STRLEN,"%d",va_arg(listArgs,UCHAR));
 279         StringCbPrintf(lpStrings[3],STRLEN,"%d",va_arg(listArgs,UCHAR));
 280         lpArgs[0] = lpStrings[0];
 281         lpArgs[1] = lpStrings[1];
 282         lpArgs[2] = lpStrings[2];
 283         lpArgs[3] = lpStrings[3];
 284         break;
 285     case MSG_SERVICE_ERROR_STOP_WITH_MSG_AND_LOCATION:
 286         wNumArgs = 3;
 287         lpArgs[0] = va_arg(listArgs, LPTSTR);
 288         StringCbPrintf(lpStrings[1],STRLEN,"%d",va_arg(listArgs,int));
 289         lpArgs[1] = lpStrings[1];
 290         lpArgs[2] = va_arg(listArgs,LPTSTR);
 291         break;
 292     }
 293     va_end(listArgs);
 294
 295     // Make sure we were not given too many args.
 296     if (wNumArgs >= MAXARGS)
 297         return;
 298
 299     // Log the event.
 300     code = ReportEvent(hEventSource,            // handle of event source
 301                        wEventType,              // event type
 302                        0,                       // event category
 303                        dwEventID,               // event ID
 304                        NULL,                    // current user's SID
 305                        wNumArgs,                // strings in lpszArgs
 306                        0,                       // no bytes of raw data
 307                        wNumArgs ? lpArgs : NULL,// array of error strings
 308                        NULL);                   // no raw data
 309
 310
 311     DeregisterEventSource(hEventSource);
 312 }
 313
 314