2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
10 #include <afs/param.h>
17 #include "afsd_init.h"
32 // The following is defined if you want to receive Power notifications,
33 // including Hibernation, and also subsequent flushing of AFS volumes
35 #define REGISTER_POWER_NOTIFICATIONS
39 #include "afsd_flushvol.h"
41 extern void afsi_log(char *pattern, ...);
43 HANDLE hAFSDMainThread = NULL;
45 HANDLE WaitToTerminate;
50 unsigned int MainThreadId;
54 extern int traceOnPanic;
55 extern HANDLE afsi_file;
58 * Notifier function for use by osi_panic
60 static void afsd_notifier(char *msgp, char *filep, long line)
67 sprintf(tbuffer, "Error at file %s, line %d: %s",
70 sprintf(tbuffer, "Error at unknown location: %s", msgp);
72 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
74 ReportEvent(h, EVENTLOG_ERROR_TYPE, 0, line, NULL, 1, 0, ptbuf, NULL);
75 DeregisterEventSource(h);
79 osi_LogEnable(afsd_logp);
81 afsd_ForceTrace(TRUE);
83 afsi_log("--- begin dump ---");
84 cm_DumpSCache(afsi_file, "a");
86 cm_dnlcDump(afsi_file, "a");
88 cm_DumpBufHashTable(afsi_file, "a");
89 smb_DumpVCP(afsi_file, "a");
90 afsi_log("--- end dump ---");
94 SetEvent(WaitToTerminate);
97 if (GetCurrentThreadId() == MainThreadId)
98 longjmp(notifier_jmp, 1);
105 * For use miscellaneously in smb.c; need to do better
107 static int _stdcall DummyMessageBox(HWND h, LPCTSTR l1, LPCTSTR l2, UINT ui)
112 static SERVICE_STATUS ServiceStatus;
113 static SERVICE_STATUS_HANDLE StatusHandle;
116 afsd_ServiceFlushVolume(DWORD dwlpEventData)
118 DWORD dwRet = ERROR_NETWORK_BUSY; /* or NO_ERROR */
121 ** If UI bit is not set, user interaction is not possible
122 ** BUT, since we are a NON-interactive service, and therefore
123 ** have NO user I/O, it doesn't much matter.
124 ** This benign code left here as example of how to find this out
126 BOOL bUI = (dwlpEventData & 1);
129 if ( PowerNotificationThreadNotify() )
136 /* flush was unsuccessful, or timeout - deny shutdown */
137 dwRet = ERROR_NETWORK_BUSY;
140 /* to deny hibernate, simply return
141 // any value besides NO_ERROR.
143 // dwRet = ERROR_NETWORK_BUSY;
150 /* service control handler used in nt4 only for backward compat. */
152 afsd_ServiceControlHandler(DWORD ctrlCode)
155 DWORD dummyLen, doTrace;
159 case SERVICE_CONTROL_STOP:
161 RpcMgmtStopServerListening(NULL);
163 /* Force trace if requested */
164 code = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
166 0, KEY_QUERY_VALUE, &parmKey);
167 if (code != ERROR_SUCCESS)
170 dummyLen = sizeof(doTrace);
171 code = RegQueryValueEx(parmKey, "TraceOnShutdown",
173 (BYTE *) &doTrace, &dummyLen);
174 RegCloseKey (parmKey);
175 if (code != ERROR_SUCCESS)
178 afsd_ForceTrace(FALSE);
181 ServiceStatus.dwCurrentState = SERVICE_STOP_PENDING;
182 ServiceStatus.dwWin32ExitCode = NO_ERROR;
183 ServiceStatus.dwCheckPoint = 1;
184 ServiceStatus.dwWaitHint = 10000;
185 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_STOP;
186 SetServiceStatus(StatusHandle, &ServiceStatus);
187 SetEvent(WaitToTerminate);
189 case SERVICE_CONTROL_INTERROGATE:
190 ServiceStatus.dwCurrentState = SERVICE_RUNNING;
191 ServiceStatus.dwWin32ExitCode = NO_ERROR;
192 ServiceStatus.dwCheckPoint = 0;
193 ServiceStatus.dwWaitHint = 0;
194 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_STOP;
195 SetServiceStatus(StatusHandle, &ServiceStatus);
197 /* XXX handle system shutdown */
198 /* XXX handle pause & continue */
204 ** Extended ServiceControlHandler that provides Event types
205 ** for monitoring Power events, for example.
208 afsd_ServiceControlHandlerEx(
216 DWORD dummyLen, doTrace;
218 DWORD dwRet = ERROR_CALL_NOT_IMPLEMENTED;
222 case SERVICE_CONTROL_STOP:
224 RpcMgmtStopServerListening(NULL);
226 /* Force trace if requested */
227 code = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
229 0, KEY_QUERY_VALUE, &parmKey);
230 if (code != ERROR_SUCCESS)
233 dummyLen = sizeof(doTrace);
234 code = RegQueryValueEx(parmKey, "TraceOnShutdown",
236 (BYTE *) &doTrace, &dummyLen);
237 RegCloseKey (parmKey);
238 if (code != ERROR_SUCCESS)
241 afsd_ForceTrace(FALSE);
244 ServiceStatus.dwCurrentState = SERVICE_STOP_PENDING;
245 ServiceStatus.dwWin32ExitCode = NO_ERROR;
246 ServiceStatus.dwCheckPoint = 1;
247 ServiceStatus.dwWaitHint = 10000;
248 ServiceStatus.dwControlsAccepted = 0;
249 SetServiceStatus(StatusHandle, &ServiceStatus);
250 SetEvent(WaitToTerminate);
254 case SERVICE_CONTROL_INTERROGATE:
255 ServiceStatus.dwCurrentState = SERVICE_RUNNING;
256 ServiceStatus.dwWin32ExitCode = NO_ERROR;
257 ServiceStatus.dwCheckPoint = 0;
258 ServiceStatus.dwWaitHint = 0;
259 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_POWEREVENT;
260 SetServiceStatus(StatusHandle, &ServiceStatus);
264 /* XXX handle system shutdown */
265 /* XXX handle pause & continue */
266 case SERVICE_CONTROL_POWEREVENT:
269 ** dwEventType of this notification == WPARAM of WM_POWERBROADCAST
270 ** Return NO_ERROR == return TRUE for that message, i.e. accept request
271 ** Return any error code to deny request,
272 ** i.e. as if returning BROADCAST_QUERY_DENY
274 switch((int) dwEventType)
276 case PBT_APMQUERYSUSPEND:
277 case PBT_APMQUERYSTANDBY:
279 #ifdef REGISTER_POWER_NOTIFICATIONS
281 dwRet = afsd_ServiceFlushVolume((DWORD) lpEventData);
287 /* allow remaining case PBT_WhatEver */
290 case PBT_APMRESUMECRITICAL:
291 case PBT_APMRESUMESUSPEND:
292 case PBT_APMRESUMESTANDBY:
293 case PBT_APMBATTERYLOW:
294 case PBT_APMPOWERSTATUSCHANGE:
295 case PBT_APMOEMEVENT:
296 case PBT_APMRESUMEAUTOMATIC:
301 } /* end switch(ctrlCode) */
305 /* There is similar code in client_config\drivemap.cpp GlobalMountDrive()
307 * Mount a drive into AFS if there global mapping
309 /* DEE Could check first if we are run as SYSTEM */
310 #define MAX_RETRIES 30
311 static void MountGlobalDrives()
313 char szAfsPath[_MAX_PATH];
314 char szDriveToMapTo[5];
318 DWORD dwIndex = 0, dwRetry = 0;
320 DWORD dwSubMountSize;
321 char szSubMount[256];
324 sprintf(szKeyName, "%s\\GlobalAutoMapper", AFSConfigKeyName);
326 dwResult = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKeyName, 0, KEY_QUERY_VALUE, &hKey);
327 if (dwResult != ERROR_SUCCESS)
330 while (dwRetry < MAX_RETRIES) {
331 dwDriveSize = sizeof(szDriveToMapTo);
332 dwSubMountSize = sizeof(szSubMount);
333 dwResult = RegEnumValue(hKey, dwIndex++, szDriveToMapTo, &dwDriveSize, 0, &dwType, szSubMount, &dwSubMountSize);
334 if (dwResult != ERROR_MORE_DATA) {
335 if (dwResult != ERROR_SUCCESS) {
336 if (dwResult != ERROR_NO_MORE_ITEMS)
337 afsi_log("Failed to read GlobalAutoMapper values: %d\n", dwResult);
342 for ( ; dwRetry < MAX_RETRIES; dwRetry++)
345 memset (&nr, 0x00, sizeof(NETRESOURCE));
347 sprintf(szAfsPath,"\\\\%s\\%s",cm_NetbiosName,szSubMount);
349 nr.dwScope = RESOURCE_GLOBALNET;
350 nr.dwType=RESOURCETYPE_DISK;
351 nr.lpLocalName=szDriveToMapTo;
352 nr.lpRemoteName=szAfsPath;
353 nr.dwDisplayType = RESOURCEDISPLAYTYPE_SHARE;
354 nr.dwUsage = RESOURCEUSAGE_CONNECTABLE;
356 dwResult = WNetAddConnection2(&nr,NULL,NULL,FALSE);
357 afsi_log("GlobalAutoMap of %s to %s %s (%d)", szDriveToMapTo, szSubMount,
358 (dwResult == NO_ERROR) ? "succeeded" : "failed", dwResult);
359 if (dwResult == NO_ERROR) {
362 /* wait for smb server to come up */
363 Sleep((DWORD)1000 /* miliseconds */);
370 static void DismountGlobalDrives()
372 char szAfsPath[_MAX_PATH];
373 char szDriveToMapTo[5];
379 DWORD dwSubMountSize;
380 char szSubMount[256];
383 sprintf(szKeyName, "%s\\GlobalAutoMapper", AFSConfigKeyName);
385 dwResult = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKeyName, 0, KEY_QUERY_VALUE, &hKey);
386 if (dwResult != ERROR_SUCCESS)
390 dwDriveSize = sizeof(szDriveToMapTo);
391 dwSubMountSize = sizeof(szSubMount);
392 dwResult = RegEnumValue(hKey, dwIndex++, szDriveToMapTo, &dwDriveSize, 0, &dwType, szSubMount, &dwSubMountSize);
393 if (dwResult != ERROR_MORE_DATA) {
394 if (dwResult != ERROR_SUCCESS) {
395 if (dwResult != ERROR_NO_MORE_ITEMS)
396 afsi_log("Failed to read GlobalAutoMapper values: %d\n", dwResult);
401 sprintf(szAfsPath,"\\\\%s\\%s",cm_NetbiosName,szSubMount);
403 dwResult = WNetCancelConnection(szAfsPath, TRUE);
405 afsi_log("Disconnect from GlobalAutoMap of %s to %s %s", szDriveToMapTo, szSubMount, dwResult ? "succeeded" : "failed");
411 typedef BOOL ( APIENTRY * AfsdInitHook )(void);
412 #define AFSD_INIT_HOOK "AfsdInitHook"
413 #define AFSD_HOOK_DLL "afsdhook.dll"
416 control serviceex exists only on 2000/xp. These functions will be loaded dynamically.
419 typedef SERVICE_STATUS_HANDLE ( * RegisterServiceCtrlHandlerExFunc )( LPCTSTR , LPHANDLER_FUNCTION_EX , LPVOID );
420 typedef SERVICE_STATUS_HANDLE ( * RegisterServiceCtrlHandlerFunc )( LPCTSTR , LPHANDLER_FUNCTION );
422 RegisterServiceCtrlHandlerExFunc pRegisterServiceCtrlHandlerEx = NULL;
423 RegisterServiceCtrlHandlerFunc pRegisterServiceCtrlHandler = NULL;
425 void afsd_Main(DWORD argc, LPTSTR *argv)
434 AfsdInitHook initHook;
437 _CrtSetDbgFlag(_CRTDBG_ALLOC_MEM_DF /*| _CRTDBG_CHECK_ALWAYS_DF*/ |
438 _CRTDBG_CHECK_CRT_DF /* | _CRTDBG_DELAY_FREE_MEM_DF */ );
441 osi_InitPanic(afsd_notifier);
442 osi_InitTraceOption();
448 WaitToTerminate = CreateEvent(NULL, TRUE, FALSE, TEXT("afsd_service_WaitToTerminate"));
449 if ( GetLastError() == ERROR_ALREADY_EXISTS )
450 afsi_log("Event Object Already Exists: %s", TEXT("afsd_service_WaitToTerminate"));
453 hAdvApi32 = LoadLibrary("advapi32.dll");
454 if (hAdvApi32 == NULL)
456 afsi_log("Fatal: cannot load advapi32.dll");
460 pRegisterServiceCtrlHandlerEx = (RegisterServiceCtrlHandlerExFunc)GetProcAddress(hAdvApi32, "RegisterServiceCtrlHandlerExA");
461 if (pRegisterServiceCtrlHandlerEx)
463 afsi_log("running on 2000+ - using RegisterServiceCtrlHandlerEx");
464 StatusHandle = RegisterServiceCtrlHandlerEx(AFS_DAEMON_SERVICE_NAME, afsd_ServiceControlHandlerEx, NULL );
468 StatusHandle = RegisterServiceCtrlHandler(AFS_DAEMON_SERVICE_NAME, afsd_ServiceControlHandler);
471 ServiceStatus.dwServiceType = SERVICE_WIN32_OWN_PROCESS;
472 ServiceStatus.dwServiceSpecificExitCode = 0;
473 ServiceStatus.dwCurrentState = SERVICE_START_PENDING;
474 ServiceStatus.dwWin32ExitCode = NO_ERROR;
475 ServiceStatus.dwCheckPoint = 1;
476 ServiceStatus.dwWaitHint = 30000;
477 /* accept Power Events */
478 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_POWEREVENT;
479 SetServiceStatus(StatusHandle, &ServiceStatus);
483 HANDLE h; char *ptbuf[1];
484 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
485 ptbuf[0] = "AFS start pending";
486 ReportEvent(h, EVENTLOG_INFORMATION_TYPE, 0, 0, NULL, 1, 0, ptbuf, NULL);
487 DeregisterEventSource(h);
490 #ifdef REGISTER_POWER_NOTIFICATIONS
491 /* create thread used to flush cache */
492 PowerNotificationThreadCreate();
495 /* allow an exit to be called prior to any initialization */
496 hInitHookDll = LoadLibrary(AFSD_HOOK_DLL);
500 initHook = ( AfsdInitHook ) GetProcAddress(hInitHookDll, AFSD_INIT_HOOK);
505 FreeLibrary(hInitHookDll);
510 ServiceStatus.dwCurrentState = SERVICE_STOPPED;
511 ServiceStatus.dwWin32ExitCode = NO_ERROR;
512 ServiceStatus.dwCheckPoint = 0;
513 ServiceStatus.dwWaitHint = 0;
514 ServiceStatus.dwControlsAccepted = 0;
515 SetServiceStatus(StatusHandle, &ServiceStatus);
517 /* exit if initialization failed */
522 /* allow another 15 seconds to start */
523 ServiceStatus.dwServiceType = SERVICE_WIN32_OWN_PROCESS;
524 ServiceStatus.dwServiceSpecificExitCode = 0;
525 ServiceStatus.dwCurrentState = SERVICE_START_PENDING;
526 ServiceStatus.dwWin32ExitCode = NO_ERROR;
527 ServiceStatus.dwCheckPoint = 2;
528 ServiceStatus.dwWaitHint = 20000;
529 /* accept Power Events */
530 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_POWEREVENT;
531 SetServiceStatus(StatusHandle, &ServiceStatus);
536 MainThreadId = GetCurrentThreadId();
537 jmpret = setjmp(notifier_jmp);
542 code = afsd_InitCM(&reason);
544 afsi_log("afsd_InitCM failed: %s (code = %d)", reason, code);
545 osi_panic(reason, __FILE__, __LINE__);
549 ServiceStatus.dwCheckPoint++;
550 ServiceStatus.dwWaitHint -= 5000;
551 SetServiceStatus(StatusHandle, &ServiceStatus);
553 code = afsd_InitDaemons(&reason);
555 afsi_log("afsd_InitDaemons failed: %s (code = %d)", reason, code);
556 osi_panic(reason, __FILE__, __LINE__);
560 ServiceStatus.dwCheckPoint++;
561 ServiceStatus.dwWaitHint -= 5000;
562 SetServiceStatus(StatusHandle, &ServiceStatus);
564 code = afsd_InitSMB(&reason, MessageBox);
566 afsi_log("afsd_InitSMB failed: %s (code = %d)", reason, code);
567 osi_panic(reason, __FILE__, __LINE__);
573 ServiceStatus.dwCurrentState = SERVICE_RUNNING;
574 ServiceStatus.dwWin32ExitCode = NO_ERROR;
575 ServiceStatus.dwCheckPoint = 0;
576 ServiceStatus.dwWaitHint = 0;
578 /* accept Power events */
579 ServiceStatus.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_POWEREVENT;
580 SetServiceStatus(StatusHandle, &ServiceStatus);
583 HANDLE h; char *ptbuf[1];
584 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
585 ptbuf[0] = "AFS running";
586 ReportEvent(h, EVENTLOG_INFORMATION_TYPE, 0, 0, NULL, 1, 0, ptbuf, NULL);
587 DeregisterEventSource(h);
591 WaitForSingleObject(WaitToTerminate, INFINITE);
594 HANDLE h; char *ptbuf[1];
595 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
596 ptbuf[0] = "AFS quitting";
597 ReportEvent(h, GlobalStatus ? EVENTLOG_ERROR_TYPE : EVENTLOG_INFORMATION_TYPE,
598 0, 0, NULL, 1, 0, ptbuf, NULL);
599 DeregisterEventSource(h);
602 DismountGlobalDrives();
606 #ifdef REGISTER_POWER_NOTIFICATIONS
607 /* terminate thread used to flush cache */
608 PowerNotificationThreadExit();
611 /* Remove the ExceptionFilter */
612 SetUnhandledExceptionFilter(NULL);
614 ServiceStatus.dwCurrentState = SERVICE_STOPPED;
615 ServiceStatus.dwWin32ExitCode = GlobalStatus ? ERROR_EXCEPTION_IN_SERVICE : NO_ERROR;
616 ServiceStatus.dwCheckPoint = 0;
617 ServiceStatus.dwWaitHint = 0;
618 ServiceStatus.dwControlsAccepted = 0;
619 SetServiceStatus(StatusHandle, &ServiceStatus);
622 DWORD __stdcall afsdMain_thread(void* notUsed)
624 char * argv[2] = {AFS_DAEMON_SERVICE_NAME, NULL};
625 afsd_Main(1, (LPTSTR*)argv);
632 static SERVICE_TABLE_ENTRY dispatchTable[] = {
633 {AFS_DAEMON_SERVICE_NAME, (LPSERVICE_MAIN_FUNCTION) afsd_Main},
637 if (!StartServiceCtrlDispatcher(dispatchTable))
639 LONG status = GetLastError();
640 if (status == ERROR_FAILED_SERVICE_CONTROLLER_CONNECT)
643 hAFSDMainThread = CreateThread(NULL, 0, afsdMain_thread, 0, 0, &tid);
645 printf("Hit <Enter> to terminate OpenAFS Client Service\n");
647 SetEvent(WaitToTerminate);
651 if ( hAFSDMainThread ) {
652 WaitForSingleObject( hAFSDMainThread, INFINITE );
653 CloseHandle( hAFSDMainThread );