src/Shm.pl

   1 #
   2 #   Shm.pl: Shared Memory stuff.
   3 #    Author: dms
   4 #   Version: 20000201
   5 #   Created: 20000124
   6 #
   7
   8 if (&IsParam("useStrict")) { use strict; }
   9
  10 use POSIX qw(_exit);
  11
  12 sub openSHM {
  13     my $IPC_PRIVATE = 0;
  14     my $size = 2000;
  15
  16     if (defined( $_ = shmget($IPC_PRIVATE, $size, 0777) )) {
  17         &status("Created shared memory (shm) key: [$_]");
  18         return $_;
  19     } else {
  20         &ERROR("openSHM: failed.");
  21         &ERROR("Please delete some shared memory with ipcs or ipcrm.");
  22         exit 1;
  23     }
  24 }
  25
  26 sub closeSHM {
  27     my ($key) = @_;
  28     my $IPC_RMID = 0;
  29
  30     return '' if (!defined $key);
  31
  32     &shmFlush();
  33     &status("Closed shared memory (shm) key: [$key]");
  34     return shmctl($key, $IPC_RMID, 0);
  35 }
  36
  37 sub shmRead {
  38     my ($key) = @_;
  39     my $position = 0;
  40     my $size = 3*80;
  41     my $retval = '';
  42
  43     if (shmread($key,$retval,$position,$size)) {
  44         return $retval;
  45     } else {
  46         &ERROR("shmRead: failed: $!");
  47         ### TODO: if this fails, never try again.
  48         &openSHM();
  49         return '';
  50     }
  51 }
  52
  53 sub shmWrite {
  54     my ($key, $str) = @_;
  55     my $position = 0;
  56     my $size = 80*3;
  57
  58     # NULL hack.
  59     ### TODO: create shmClear to deal with this.
  60     if ($str !~ /^$/) {
  61         my $read = &shmRead($key);
  62         $read =~ s/\0+//g;
  63         $str = $read ."||". $str if ($read ne "");
  64     }
  65
  66     if (!shmwrite($key,$str,$position,$size)) {
  67         &ERROR("shmWrite: failed: $!");
  68     }
  69 }
  70
  71 ##############
  72 ### Helpers
  73 ###
  74
  75 # Usage: &addForked($name);
  76 # Return: 1 for success, 0 for failure.
  77 sub addForked {
  78     my ($name)          = @_;
  79     my $forker_timeout  = 360;  # 6mins, in seconds.
  80     $forker             = $name;
  81
  82     if (!defined $name) {
  83         &WARN("addForked: name == NULL.");
  84         return 0;
  85     }
  86
  87     foreach (keys %forked) {
  88         my $time = time() - $forked{$_}{Time};
  89         next unless ($time > $forker_timeout);
  90
  91         ### TODO: use &time2string()?
  92         &WARN("Fork: looks like we lost '$_', executed $time ago.");
  93         delete $forked{$_};
  94     }
  95
  96     my $count = 0;
  97     while (scalar keys %forked > 1) {   # 2 or more == fail.
  98         sleep 1;
  99
 100         if ($count > 3) {       # 3 seconds.
 101             my $list = join(', ', keys %forked);
 102             if (defined $who) {
 103                 &msg($who, "already running ($list) => exceeded allowed forked processes count (1?).");
 104             } else {
 105                 &status("Fork: I ran too many forked processes :) Giving up $name.");
 106             }
 107             return 0;
 108         }
 109
 110         $count++;
 111     }
 112
 113     if (exists $forked{$name}) {
 114         my $time        = $forked{$name}{Time};
 115         my $continue    = 0;
 116
 117         if (-d "/proc/$forked{$name}{PID}") {
 118             &status("fork: still running; good. BAIL OUT.");
 119         } else {
 120             &WARN("Found dead fork; removing and resetting.");
 121             $continue = 1;
 122         }
 123
 124         if ($continue) {
 125             # NOTHING.
 126         } elsif (time() - $time > 900) {        # stale fork > 15m.
 127             &status("forked: forked{$name} presumably exited without notifying us.");
 128         } else {                                # fresh fork.
 129             &msg($who, "$name is already running ". &Time2String(time() - $time));
 130             return 0;
 131         }
 132     }
 133
 134     $forked{$name}{Time}        = time();
 135     $forkedtime                 = time();
 136     $count{'Fork'}++;
 137     return 1;
 138 }
 139
 140 sub delForked {
 141     my ($name)  = @_;
 142
 143     return if ($$ == $bot_pid);
 144
 145     if (!defined $name) {
 146         &WARN("delForked: name == NULL.");
 147         POSIX::_exit(0);
 148     }
 149
 150     &showProc();        # just for informational purposes.
 151
 152     if (exists $forked{$name}) {
 153         my $timestr = &Time2String(time() - $forked{$name}{Time});
 154         &status("fork: took $timestr for $name.");
 155         &shmWrite($shm,"DELETE FORK $name");
 156     } else {
 157         &ERROR("delForked: forked{$name} does not exist. should not happen.");
 158     }
 159
 160     &status("--- fork finished for '$name' ---");
 161
 162     POSIX::_exit(0);
 163 }
 164
 165 1;