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
  64         if ($str eq "") {
  65             $str = time().": ";         # time stamping, null.
  66         } elsif ($read eq "") {
  67             $str = time().": ";         # timestamping.
  68         } else {
  69             $str = $read ."||". $str;
  70         }
  71     }
  72
  73     if (!shmwrite($key,$str,$position,$size)) {
  74         &ERROR("shmWrite: failed: $!");
  75     }
  76 }
  77
  78 ##############
  79 ### Helpers
  80 ###
  81
  82 # Usage: &addForked($name);
  83 # Return: 1 for success, 0 for failure.
  84 sub addForked {
  85     my ($name)          = @_;
  86     my $forker_timeout  = 360;  # 6mins, in seconds.
  87     $forker             = $name;
  88
  89     if (!defined $name) {
  90         &WARN("addForked: name == NULL.");
  91         return 0;
  92     }
  93
  94     foreach (keys %forked) {
  95         my $time = time() - $forked{$_}{Time};
  96         next unless ($time > $forker_timeout);
  97
  98         ### TODO: use &time2string()?
  99         &WARN("Fork: looks like we lost '$_', executed $time ago.");
 100         delete $forked{$_};
 101     }
 102
 103     my $count = 0;
 104     while (scalar keys %forked > 1) {   # 2 or more == fail.
 105         sleep 1;
 106
 107         if ($count > 3) {       # 3 seconds.
 108             my $list = join(', ', keys %forked);
 109             if (defined $who) {
 110                 &msg($who, "already running ($list) => exceeded allowed forked processes count (1?).");
 111             } else {
 112                 &status("Fork: I ran too many forked processes :) Giving up $name.");
 113             }
 114             return 0;
 115         }
 116
 117         $count++;
 118     }
 119
 120     if (exists $forked{$name} and !scalar keys %{ $forked{$name} }) {
 121         &WARN("addF: forked{$name} exists but is empty; deleting.");
 122         undef $forked{$name};
 123     }
 124
 125     if (exists $forked{$name} and scalar keys %{ $forked{$name} }) {
 126         my $time        = $forked{$name}{Time};
 127         my $continue    = 0;
 128
 129         $continue++ if ($forked{$name}{PID} == $$);
 130
 131         if ($continue) {
 132             &WARN("hrm.. fork pid == mypid == $$; how did this happen?");
 133
 134         } elsif ( -d "/proc/$forked{$name}{PID}") {
 135             &status("fork: still running; good. BAIL OUT.");
 136             return 0;
 137
 138         } else {
 139             &WARN("Found dead fork; removing and resetting.");
 140             $continue = 1;
 141         }
 142
 143         if ($continue) {
 144             # NOTHING.
 145
 146         } elsif (time() - $time > 900) {        # stale fork > 15m.
 147             &status("forked: forked{$name} presumably exited without notifying us.");
 148
 149         } else {                                # fresh fork.
 150             &msg($who, "$name is already running ". &Time2String(time() - $time));
 151             return 0;
 152         }
 153     }
 154
 155     $forked{$name}{Time}        = time();
 156     $forked{$name}{PID}         = $$;
 157     $forkedtime                 = time();
 158     $count{'Fork'}++;
 159     return 1;
 160 }
 161
 162 sub delForked {
 163     my ($name)  = @_;
 164
 165     return if ($$ == $bot_pid);
 166
 167     if (!defined $name) {
 168         &WARN("delForked: name == NULL.");
 169         POSIX::_exit(0);
 170     }
 171
 172     if ($name =~ /\.pl/) {
 173         &WARN("dF: name is name of source file ($name). FIX IT!");
 174     }
 175
 176     &showProc();        # just for informational purposes.
 177
 178     if (exists $forked{$name}) {
 179         my $timestr = &Time2String(time() - $forked{$name}{Time});
 180         &status("fork: took $timestr for $name.");
 181         &shmWrite($shm,"DELETE FORK $name");
 182     } else {
 183         &ERROR("delForked: forked{$name} does not exist. should not happen.");
 184     }
 185
 186     &status("--- fork finished for '$name' ---");
 187
 188     POSIX::_exit(0);
 189 }
 190
 191 1;