]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/RESTEnvironment.pm
1 package PVE
::RESTEnvironment
;
3 # NOTE: you can/should provide your own specialice class, and
4 # use this a bas class (as example see PVE::RPCEnvironment).
6 # we use this singleton class to pass RPC related environment values
10 use POSIX
qw(:sys_wait_h EINTR);
15 use PVE
::Exception
qw(raise raise_perm_exc);
24 # save $SIG{CHLD} handler implementation.
25 # simply set $SIG{CHLD} = $worker_reaper;
26 # and register forked processes with &$register_worker(pid)
27 # Note: using $SIG{CHLD} = 'IGNORE' or $SIG{CHLD} = sub { wait (); } or ...
28 # has serious side effects, because perls built in system() and open()
29 # functions can't get the correct exit status of a child. So we cant use
30 # that (also see perlipc)
35 my $log_task_result = sub {
36 my ($upid, $user, $status) = @_;
40 my $msg = 'successful';
43 my $ec = $status >> 8;
44 my $ic = $status & 255;
45 $msg = $ec ?
"failed ($ec)" : "interrupted ($ic)";
49 my $tlist = $rest_env->active_workers($upid);
50 $rest_env->broadcast_tasklist($tlist);
53 foreach my $t (@$tlist) {
54 if ($t->{upid
} eq $upid) {
59 if ($task && $task->{status
}) {
60 $msg = $task->{status
};
63 $rest_env->log_cluster_msg($pri, $user, "end task $upid $msg")
67 my $worker_reaper = sub {
69 foreach my $pid (keys %$WORKER_PIDS) {
70 my $waitpid = waitpid ($pid, WNOHANG
);
71 if (defined($waitpid) && ($waitpid == $pid)) {
72 my $info = $WORKER_PIDS->{$pid};
73 if ($info && $info->{upid
} && $info->{user
}) {
74 &$log_task_result($info->{upid
}, $info->{user
}, $?);
76 delete ($WORKER_PIDS->{$pid});
81 my $register_worker = sub {
82 my ($pid, $user, $upid) = @_;
86 # do not register if already finished
87 my $waitpid = waitpid ($pid, WNOHANG
);
88 if (defined($waitpid) && ($waitpid == $pid)) {
89 delete ($WORKER_PIDS->{$pid});
93 $WORKER_PIDS->{$pid} = {
99 # initialize environment - must be called once at program startup
101 my ($class, $type, %params) = @_;
103 $class = ref($class) || $class;
105 die "already initialized" if $rest_env;
107 die "unknown environment type"
108 if !$type || $type !~ m/^(cli|pub|priv|ha)$/;
110 $SIG{CHLD
} = $worker_reaper;
113 # cli ... command started fron command line
114 # pub ... access from public server (apache)
115 # priv ... access from private server (pvedaemon)
116 # ha ... access from HA resource manager agent (rgmanager)
118 my $self = { type
=> $type };
122 foreach my $p (keys %params) {
123 if ($p eq 'atfork') {
124 $self->{$p} = $params{$p};
126 die "unknown option '$p'";
132 my ($sysname, $nodename) = POSIX
::uname
();
134 $nodename =~ s/\..*$//; # strip domain part, if any
136 $self->{nodename
} = $nodename;
141 # convenience function for command line tools
142 sub setup_default_cli_env
{
143 my ($class, $username) = @_;
145 $class = ref($class) || $class;
147 $username //= 'root@pam';
149 PVE
::INotify
::inotify_init
();
151 my $rpcenv = $class->init('cli');
152 $rpcenv->init_request();
153 $rpcenv->set_language($ENV{LANG
});
154 $rpcenv->set_user($username);
156 die "please run as root\n"
157 if ($username eq 'root@pam') && ($> != 0);
163 die "REST environment not initialized" if !$rest_env;
169 my ($self, $ip) = @_;
171 $self->{client_ip
} = $ip;
177 return $self->{client_ip
};
180 sub set_result_attrib
{
181 my ($self, $key, $value) = @_;
183 $self->{result_attributes
}->{$key} = $value;
186 sub get_result_attrib
{
187 my ($self, $key) = @_;
189 return $self->{result_attributes
}->{$key};
193 my ($self, $lang) = @_;
195 # fixme: initialize I18N
197 $self->{language
} = $lang;
203 return $self->{language
};
207 my ($self, $user) = @_;
209 $self->{user
} = $user;
213 my ($self, $noerr) = @_;
215 return $self->{user
} if defined($self->{user
}) || $noerr;
217 die "user name not set\n";
226 # read/update list of active workers
227 # we move all finished tasks to the archive index,
228 # but keep aktive and most recent task in the active file.
229 # $nocheck ... consider $new_upid still running (avoid that
230 # we try to read the reult to early.
232 my ($self, $new_upid, $nocheck) = @_;
234 my $lkfn = "/var/log/pve/tasks/.active.lock";
240 my $tasklist = PVE
::INotify
::read_file
('active');
244 my $thash = {}; # only list task once
246 my $check_task = sub {
247 my ($task, $running) = @_;
249 if ($running || PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
})) {
255 delete $task->{pstart
};
258 foreach my $task (@$tasklist) {
259 my $upid = $task->{upid
};
260 next if $thash->{$upid};
261 $thash->{$upid} = $task;
265 if ($new_upid && !(my $task = $thash->{$new_upid})) {
266 $task = PVE
::Tools
::upid_decode
($new_upid);
267 $task->{upid
} = $new_upid;
268 $thash->{$new_upid} = $task;
269 &$check_task($task, $nocheck);
273 @ta = sort { $b->{starttime
} cmp $a->{starttime
} } @ta;
275 my $save = defined($new_upid);
277 foreach my $task (@ta) {
278 next if $task->{endtime
};
279 $task->{endtime
} = time();
280 $task->{status
} = PVE
::Tools
::upid_read_status
($task->{upid
});
286 foreach my $task (@ta) {
287 if (!$task->{saved
}) {
288 $archive .= sprintf("%s %08X %s\n", $task->{upid
}, $task->{endtime
}, $task->{status
});
297 my $filename = "/var/log/pve/tasks/index";
299 my $fh = IO
::File-
>new($filename, '>>', 0644) ||
300 die "unable to open file '$filename' - $!\n";
301 PVE
::Tools
::safe_print
($filename, $fh, $archive);
304 die "unable to close file '$filename' - $!\n";
309 foreach my $task (@arlist) { # mark as not saved
313 my $maxsize = 50000; # about 1000 entries
314 if ($size > $maxsize) {
315 rename($filename, "$filename.1");
319 # we try to reduce the amount of data
320 # list all running tasks and task and a few others
321 # try to limit to 25 tasks
323 my $max = 25 - scalar(@$tlist);
324 foreach my $task (@ta) {
330 PVE
::INotify
::write_file
('active', $tlist) if $save;
335 my $res = PVE
::Tools
::lock_file
($lkfn, $timeout, $code);
341 my $kill_process_group = sub {
342 my ($pid, $pstart) = @_;
344 # send kill to process group (negative pid)
347 # always send signal to all pgrp members
348 kill(15, $kpid); # send TERM signal
350 # give max 5 seconds to shut down
351 for (my $i = 0; $i < 5; $i++) {
352 return if !PVE
::ProcFSTools
::check_process_running
($pid, $pstart);
361 my ($self, $upid, $killit) = @_;
363 my $task = PVE
::Tools
::upid_decode
($upid);
365 my $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
367 return 0 if !$running;
370 &$kill_process_group($task->{pid
});
377 # start long running workers
378 # STDIN is redirected to /dev/null
379 # STDOUT,STDERR are redirected to the filename returned by upid_decode
380 # NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
382 my ($self, $dtype, $id, $user, $function, $background) = @_;
384 $dtype = 'unknown' if !defined ($dtype);
385 $id = '' if !defined ($id);
387 $user = 'root@pve' if !defined ($user);
389 my $sync = ($self->{type
} eq 'cli' && !$background) ?
1 : 0;
394 local $SIG{TERM
} = 'IGNORE';
396 my $starttime = time ();
398 my @psync = POSIX
::pipe();
399 my @csync = POSIX
::pipe();
401 my $node = $self->{nodename
};
404 die "unable to fork worker - $!" if !defined($cpid);
406 my $workerpuid = $cpid ?
$cpid : $$;
408 my $pstart = PVE
::ProcFSTools
::read_proc_starttime
($workerpuid) ||
409 die "unable to read process start time";
411 my $upid = PVE
::Tools
::upid_encode
({
412 node
=> $node, pid
=> $workerpuid, pstart
=> $pstart,
413 starttime
=> $starttime, type
=> $dtype, id
=> $id, user
=> $user });
417 if (!$cpid) { # child
422 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub { die "received interrupt\n"; };
424 $SIG{CHLD
} = $SIG{PIPE
} = 'DEFAULT';
426 # set sess/process group - we want to be able to kill the
427 # whole process group
430 POSIX
::close ($psync[0]);
431 POSIX
::close ($csync[1]);
433 $outfh = $sync ?
$psync[1] : undef;
436 PVE
::INotify
::inotify_close
();
438 if (my $atfork = $self->{atfork
}) {
442 # same algorythm as used inside SA
444 my $fd = fileno (STDIN
);
448 POSIX
::close(0) if $fd != 0;
450 die "unable to redirect STDIN - $!"
451 if !open(STDIN
, "</dev/null");
453 $outfh = PVE
::Tools
::upid_open
($upid);
458 $fd = fileno(STDOUT
);
460 POSIX
::close (1) if $fd != 1;
462 die "unable to redirect STDOUT - $!"
463 if !open(STDOUT
, ">&", $outfh);
465 STDOUT-
>autoflush (1);
467 # redirect STDERR to STDOUT
468 $fd = fileno (STDERR
);
470 POSIX
::close(2) if $fd != 2;
472 die "unable to redirect STDERR - $!"
473 if !open(STDERR
, ">&1");
475 STDERR-
>autoflush(1);
478 my $msg = "ERROR: $err";
479 POSIX
::write($psync[1], $msg, length ($msg));
480 POSIX
::close($psync[1]);
485 # sync with parent (signal that we are ready)
489 POSIX
::write($psync[1], $upid, length ($upid));
490 POSIX
::close($psync[1]);
494 # sync with parent (wait until parent is ready)
495 POSIX
::read($csync[0], $readbuf, 4096);
496 die "parent setup error\n" if $readbuf ne 'OK';
498 if ($self->{type
} eq 'ha') {
499 print "task started by HA resource agent\n";
501 eval { &$function($upid); };
507 print STDERR
"TASK ERROR: $err\n";
510 print STDERR
"TASK OK\n";
518 POSIX
::close ($psync[1]);
519 POSIX
::close ($csync[0]);
522 # sync with child (wait until child starts)
523 POSIX
::read($psync[0], $readbuf, 4096);
526 POSIX
::close($psync[0]);
527 &$register_worker($cpid, $user, $upid);
533 die "got no worker upid - start worker failed\n" if !$readbuf;
535 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
536 die "starting worker failed: $1\n";
539 if ($readbuf ne $upid) {
540 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
544 $outfh = PVE
::Tools
::upid_open
($upid);
551 POSIX
::write($csync[1], $msg, length ($msg));
552 POSIX
::close($csync[1]);
555 POSIX
::close($csync[1]);
556 kill(-9, $cpid); # make sure it gets killed
560 $self->log_cluster_msg('info', $user, "starting task $upid");
562 my $tlist = $self->active_workers($upid, $sync);
563 $self->broadcast_tasklist($tlist);
572 local $SIG{INT
} = local $SIG{QUIT
} = local $SIG{TERM
} = sub {
573 # always send signal to all pgrp members
575 if ($int_count < 3) {
576 kill(15, $kpid); # send TERM signal
578 kill(9, $kpid); # send KILL signal
582 local $SIG{PIPE
} = sub { die "broken pipe\n"; };
584 my $select = new IO
::Select
;
585 my $fh = IO
::Handle-
>new_from_fd($psync[0], 'r');
588 while ($select->count) {
589 my @handles = $select->can_read(1);
590 if (scalar(@handles)) {
591 my $count = sysread ($handles[0], $readbuf, 4096);
592 if (!defined ($count)) {
594 die "sync pipe read error: $err\n";
596 last if $count == 0; # eof
599 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
602 if ($data =~ m/^TASK OK$/) {
604 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
615 # some commands daemonize without closing stdout
616 last if !PVE
::ProcFSTools
::check_process_running
($cpid);
622 POSIX
::close($psync[0]);
624 if ($outbuf) { # just to be sure
627 print $outfh $outbuf;
633 print STDERR
"$err\n";
635 print $outfh "TASK ERROR: $err\n";
639 &$kill_process_group($cpid, $pstart); # make sure it gets killed
645 &$log_task_result($upid, $user, $res);
648 return wantarray ?
($upid, $res) : $upid;
653 sub log_cluster_msg
{
654 my ($self, $pri, $user, $msg) = @_;
656 syslog
($pri, "%s", $msg);
658 # PVE::Cluster::log_msg($pri, $user, $msg);
661 sub broadcast_tasklist
{
662 my ($self, $tlist) = @_;
664 # PVE::Cluster::broadcast_tasklist($tlist);
667 sub check_api2_permissions
{
668 my ($self, $perm, $username, $param) = @_;
670 return 1 if !$username && $perm->{user
} eq 'world';
672 raise_perm_exc
("user != null") if !$username;
674 return 1 if $username eq 'root@pam';
676 raise_perm_exc
('user != root@pam') if !$perm;
678 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
680 ##return $self->exec_api2_perm_check($perm->{check}, $username, $param)
686 # init_request - should be called before each REST/CLI request
688 my ($self, %params) = @_;
690 $self->{result_attributes
} = {}
692 # if you nedd more, implement in subclass