gnustep/libs-ec
0
0
Fork 0
mirror of https://github.com/gnustep/libs-ec.git synced 2025-02-21 02:41:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Restructure quitting

Browse source
This commit is contained in:
Richard Frith-Macdonald 2017-11-02 16:16:21 +00:00
parent 264348de14
commit eb3d3c1713
3 changed files with 162 additions and 135 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
ChangeLog
View file

@ -1,3 +1,10 @@
2017-11-02 Richard Frith-Macdonald <rfm@gnu.org>
* EcProcess.h:
* EcProcess.m: New methods for handling clean quitting with abort
if it takes too long. Fix the directory in which nightly archived
logs are placed.
2017-09-18 Richard Frith-Macdonald <rfm@gnu.org>
* EcProcess.m: Fix for repeated log archiving on startup.

50
EcProcess.h
View file

@ -505,6 +505,16 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (void) ecDoLock;
/** Called once other stages of a graceful shutdown has completed in
* order to perform final cleanup and have the process exit with the
* specified status.<br />
* If -ecWillQuit: has not been called, this method performs the same
* operations of setting the start time for the period after which the
* process should abort.<br />
* Subclasses should override -ecQuitFor:with: rather than this method.
*/
- (oneway void) ecDidQuit: (NSInteger)status;
/** Returns YES if the process is attempting a graceful shutdown,
* NO otherwise. This also checks to see if the process has been
* attempting to shut down for too long, and if it has been going
@ -513,6 +523,16 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (BOOL) ecIsQuitting;
/** This method is designed for handling an orderly shutdown.<br />
* The base implementation immediately aborts the process if it is
* already quitting, but otherwise calls -ecWillQuit: with the supplied
* reason, and then calls -ecDidQuit: passing the supplied status.<br />
* Subclasses overriding this method should call -ecWillQuit: at the
* start of their implementation and the superclass implementation of
* -ecQuitFor:with: at the end of their implementation.
*/
- (oneway void) ecQuitFor: (NSString*)reason with: (NSInteger)status;
/** Return the timestamp at which this process started up (when the
* receiver was initialised).
*/
@ -523,18 +543,17 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (void) ecUnLock;
/** Sets the start time used by the -ecIsQuitting method and, if reason is
* not nil/empty, generates a log of why quitting was started. <br />
* It is an error to call this method twice, doing so will cause the
* program to abort immediately after logging the fact.<br />
* The -cmdQuit: method will call this method, but only if it has not
* already been called. You can therefore call -ecWillQuit: before any
* call to -cmdQuit: in order to log the reason the process will be
* quitting and to start the period in which the shutdown process should
* complete.<br />
* Subclasses should not override this method.
/** Returns NO (and does nothing) if the process is already quitting,
* otherwise returns YES after setting the start time used by the
* -ecIsQuitting method and (if reason is not nil/empty) generating a
* log of why quitting was started.<br />
* Subclasses overriding this method must call the superclass implementation
* as the first thing they do and should themselves return without doing
* anything if the base method returns NO.<br />
* It generally makes sense for subclasses to override -ecQuitFor:with:
* rather than this method.
*/
- (void) ecWillQuit: (NSString*)reason;
- (BOOL) ecWillQuit: (NSString*)reason;
/* Call these methods during initialisation of your instance
* to set up automatic management of connections to servers.
@ -646,7 +665,7 @@ extern NSString* cmdVersion(NSString *ver);
* database has not actually changed, in this case the notification
* argument is nil).<br />
* This method deals with the updates for any defaults registered using
* the +ecRegisterDefault:withTypeText:andHelpText:action: method, so
* the +ecRegisterDefault:withTypeText:andHelpText:action:value: method, so
* if you override this to handle configuration changes, don't forget
* to call the superclass implementation.<br />
* If you wish to manage updates from the central database in a specific
@ -740,9 +759,8 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (NSMutableDictionary*)cmdOperator: (NSString*)name password: (NSString*)pass;
/** Used to tell your application to quit.<br />
* Subclasses should override this method to perform any pre-shutdown cleanup
* before they call the superclass implementation.
/** This method simply calls -ecQuitFor:with: using a nil value for the
* reason for quitting and the supplied status for the process exit status.
*/
- (oneway void) cmdQuit: (NSInteger)status;
@ -776,7 +794,7 @@ extern NSString* cmdVersion(NSString *ver);
* </item>
* <item>The base implementation of the -cmdDefaultsChanged: method is
* entered, and any messages registered using the
* +ecRegisterDefault:withTypeText:andHelpText:action: method are
* +ecRegisterDefault:withTypeText:andHelpText:action:value: method are
* sent if the corresponding default value has changed.
* </item>
* <item>The base implementation of the -cmdDefaultsChanged: method ends.

240
EcProcess.m
View file

@ -94,6 +94,11 @@
#include <stdio.h>
#ifndef __MINGW__
static int reservedPipe[2] = { 0, 0 };
static NSInteger descriptorsMaximum = 0;
#endif
#if !defined(EC_DEFAULTS_PREFIX)
#define EC_DEFAULTS_PREFIX nil
@ -145,7 +150,6 @@ static BOOL cmdFlagDaemon = NO;
static BOOL cmdFlagTesting = NO;
static BOOL cmdIsRunning = NO;
static BOOL cmdKeepStderr = NO;
static NSInteger cmdQuitStatus = 0;
static NSString *cmdBase = nil;
static NSString *cmdInst = nil;
static NSString *cmdName = nil;
@ -192,38 +196,30 @@ ecIsQuitting()
return YES;
}
/* Function to start quitting (graceful shutdown). If this function
* is called when a graceful shutdown attempt is already in progress,
* the process will abort immediately.
/* Function to start quitting (graceful shutdown).
*/
static void
static BOOL
ecWillQuit(NSString *reason)
{
NSTimeInterval now = [NSDate timeIntervalSinceReferenceDate];
if (0.0 == beganQuitting)
{
NSTimeInterval now = [NSDate timeIntervalSinceReferenceDate];
#ifndef __MINGW__
if (reservedPipe[1] > 0)
{
close(reservedPipe[0]); reservedPipe[0] = 0;
close(reservedPipe[1]); reservedPipe[1] = 0;
}
#endif
if ([reason length] > 0)
{
NSLog(@"will quit: %@", reason);
}
beganQuitting = now;
return YES;
}
else
{
if ([reason length] > 0)
{
NSLog(@"abort: quit requested (%@) while quitting after %g sec.\n",
reason, (now - beganQuitting));
}
else
{
NSLog(@"abort: quit requested while quitting after %g sec.\n",
(now - beganQuitting));
}
signal(SIGABRT, SIG_DFL);
abort();
}
return NO;
}
static RETSIGTYPE
@ -622,11 +618,6 @@ static uint64_t memRoll[10]; // last N values
#define MEMCOUNT (sizeof(memRoll)/sizeof(*memRoll))
static NSDate *memTime = nil; // Time of last alert
#ifndef __MINGW__
static int reservedPipe[2] = { 0, 0 };
static NSInteger descriptorsMaximum = 0;
#endif
static NSString*
findAction(NSString *cmd)
@ -1746,8 +1737,7 @@ static BOOL ecDidAwaken = NO;
additionalText: err];
[self alarm: a];
[alarmDestination shutdown];
ecWillQuit(@"configuration error");
[self cmdQuit: 1];
[self ecQuitFor: @"configuration error" with: 1];
}
else
{
@ -1762,11 +1752,102 @@ static BOOL ecDidAwaken = NO;
return ecDidAwaken;
}
- (oneway void) ecDidQuit: (NSInteger)status
{
NSArray *keys;
NSUInteger index;
NSDate *now = [NSDate date];
if (NO == ecIsQuitting())
{
ecWillQuit(nil);
}
if (cmdPTimer != nil)
{
[cmdPTimer invalidate];
cmdPTimer = nil;
}
if (0 == status)
{
/* Normal shutdown ... unmanage this process first.
*/
[alarmDestination unmanage: nil];
}
[alarmDestination shutdown];
/* Almost done ... flush any logs then write the final audit log and
* flush again (so that audit log should be the last in the file).
*/
[self cmdFlushLogs];
if (0 == status)
{
[self cmdAudit: @"Shutdown '%@'", [self cmdName]];
}
else
{
[self cmdAudit: @"Aborted '%@' (status %"PRIdPTR")",
[self cmdName], status];
}
[auditLogger flush];
/* Now that the audit log has been flushed to the Command/Control
* servers, we can unregister from Command.
*/
[self cmdUnregister];
/* Re-do the alarm destination shut down, just in case an alarm
* occurred while we were flushing logs and/or unregistering.
*/
[alarmDestination shutdown];
DESTROY(alarmDestination);
/* Ensure our DO connection is invalidated so there will be no more
* remote communications.
*/
[EcProcConnection invalidate];
/* The very last thing we do is to close down the log filed so they
* are archived to the correct directory for the current date.
*/
keys = [cmdLogMap allKeys];
for (index = 0; index < [keys count]; index++)
{
[self ecLogEnd: [keys objectAtIndex: index] to: now];
}
exit(status);
}
- (BOOL) ecIsQuitting
{
return ecIsQuitting();
}
- (oneway void) ecQuitFor: (NSString*) reason with: (NSInteger)status
{
if (ecIsQuitting())
{
NSTimeInterval now = [NSDate timeIntervalSinceReferenceDate];
if ([reason length] > 0)
{
NSLog(@"abort: quit requested (%@) while quitting after %g sec.\n",
reason, (now - beganQuitting));
}
else
{
NSLog(@"abort: quit requested while quitting after %g sec.\n",
(now - beganQuitting));
}
signal(SIGABRT, SIG_DFL);
abort();
}
[self ecWillQuit: reason];
[self ecDidQuit: status];
}
- (void) ecLoggersChanged: (NSNotification*)n
{
DESTROY(alertLogger);
@ -1781,9 +1862,9 @@ static BOOL ecDidAwaken = NO;
return started;
}
- (void) ecWillQuit: (NSString*)reason
- (BOOL) ecWillQuit: (NSString*)reason
{
ecWillQuit(reason);
return ecWillQuit(reason);
}
- (oneway void) alarm: (in bycopy EcAlarm*)event
@ -2329,8 +2410,8 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
shutdown = [NSString stringWithFormat:
@" rejected by Command - %@",
[r objectForKey: @"rejected"]];
ecWillQuit(shutdown);
[self cmdQuit: 0]; /* Rejected by server. */
/* Rejected by server. */
[self ecQuitFor: shutdown with: 0];
}
else if (nil == r || nil == [r objectForKey: @"back-off"])
{
@ -2508,8 +2589,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
close(reservedPipe[0]); reservedPipe[0] = 0;
close(reservedPipe[1]); reservedPipe[1] = 0;
}
ecWillQuit(shutdown);
[self cmdQuit: -1];
[self ecQuitFor: shutdown with: -1];
return;
}
}
@ -2595,7 +2675,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
additionalText: _(@"Process probably already running (possibly hung/delayed) or problem in name registration with distributed objects system (gdomap)")];
[self alarm: a];
[alarmDestination shutdown];
ecWillQuit(@"unable to register with name server");
[self ecWillQuit: @"unable to register with name server"];
[self cmdFlushLogs];
[arp release];
return 2;
@ -2656,8 +2736,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
shutdown
= [NSString stringWithFormat: @"signal %d received", sig];
cmdSignalled = 0;
ecWillQuit(shutdown);
[self cmdQuit: sig];
[self ecQuitFor: shutdown with: sig];
}
}
NS_HANDLER
@ -2672,8 +2751,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
[arp release];
/* finish server */
ecWillQuit(nil);
[self cmdQuit: 0];
[self ecQuitFor: nil with: 0];
cmdIsRunning = NO;
DESTROY(EcProcConnection);
return 0;
@ -3852,81 +3930,7 @@ With two parameters ('maximum' and a number),\n\
- (oneway void) cmdQuit: (NSInteger)status
{
NSDate *now = [NSDate date];
if (reservedPipe[1] > 0)
{
close(reservedPipe[0]); reservedPipe[0] = 0;
close(reservedPipe[1]); reservedPipe[1] = 0;
}
if (NO == ecIsQuitting())
{
ecWillQuit(nil);
}
cmdQuitStatus = status;
if (cmdPTimer != nil)
{
[cmdPTimer invalidate];
cmdPTimer = nil;
}
if (0 == status)
{
/* Normal shutdown ... unmanage this process first.
*/
[alarmDestination unmanage: nil];
}
[alarmDestination shutdown];
/* Almost done ... flush any logs then write the final audit log and
* flush again (so that audit log should be the last in the file).
*/
[self cmdFlushLogs];
if (0 == status)
{
[self cmdAudit: @"Shutdown '%@'", [self cmdName]];
}
else
{
[self cmdAudit: @"Aborted '%@' (status %"PRIdPTR")",
[self cmdName], status];
}
[auditLogger flush];
/* Now that the audit log has been flushed to the Command/Control
* servers, we can unregister from Command.
*/
[self cmdUnregister];
/* Re-do the alarm destination shut down, just in case an alarm
* occurred while we were flushing logs and/or unregistering.
*/
[alarmDestination shutdown];
DESTROY(alarmDestination);
/* Ensure our DO connection is invalidated so there will be no more
* remote communications.
*/
[EcProcConnection invalidate];
/* The very last thing we do is to close down the log filed so they
* are archived to the correct directory for the current date.
*/
{
NSArray *keys;
unsigned index;
/*
* Close down all log files.
*/
keys = [cmdLogMap allKeys];
for (index = 0; index < [keys count]; index++)
{
[self ecLogEnd: [keys objectAtIndex: index] to: now];
}
}
exit(status);
[self ecQuitFor: nil with: status];
}
- (void) cmdUpdate: (NSMutableDictionary*)info
@ -4898,8 +4902,7 @@ With two parameters ('maximum' and a number),\n\
{
if (NO == ecIsQuitting())
{
ecWillQuit(@"memory usage limit reached");
[self cmdQuit: -1];
[self ecQuitFor: @"memory usage limit reached" with: -1];
}
return;
}
@ -5104,8 +5107,7 @@ With two parameters ('maximum' and a number),\n\
NSString *shutdown;
shutdown = [NSString stringWithFormat: @"signal %d received", sig];
ecWillQuit(shutdown);
[self cmdQuit: sig];
[self ecQuitFor: shutdown with: sig];
}
if (YES == ecIsQuitting())
{