2 use std
::path
::{Path, PathBuf}
;
3 use std
::os
::unix
::io
::AsRawFd
;
5 use anyhow
::{bail, format_err, Error}
;
8 use openssl
::ssl
::{SslMethod, SslAcceptor, SslFiletype}
;
10 use proxmox
::try_block
;
11 use proxmox
::api
::RpcEnvironmentType
;
23 rotate_task_log_archive
,
25 tools
::systemd
::time
::{
32 use proxmox_backup
::api2
::types
::Authid
;
33 use proxmox_backup
::configdir
;
34 use proxmox_backup
::buildcfg
;
35 use proxmox_backup
::server
;
36 use proxmox_backup
::auth_helpers
::*;
37 use proxmox_backup
::tools
::{
46 PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
,
50 use proxmox_backup
::api2
::pull
::do_sync_job
;
51 use proxmox_backup
::server
::do_verification_job
;
52 use proxmox_backup
::server
::do_prune_job
;
54 fn main() -> Result
<(), Error
> {
55 proxmox_backup
::tools
::setup_safe_path_env();
57 let backup_uid
= proxmox_backup
::backup
::backup_user()?
.uid
;
58 let backup_gid
= proxmox_backup
::backup
::backup_group()?
.gid
;
59 let running_uid
= nix
::unistd
::Uid
::effective();
60 let running_gid
= nix
::unistd
::Gid
::effective();
62 if running_uid
!= backup_uid
|| running_gid
!= backup_gid
{
63 bail
!("proxy not running as backup user or group (got uid {} gid {})", running_uid
, running_gid
);
66 proxmox_backup
::tools
::runtime
::main(run())
69 async
fn run() -> Result
<(), Error
> {
70 if let Err(err
) = syslog
::init(
71 syslog
::Facility
::LOG_DAEMON
,
72 log
::LevelFilter
::Info
,
73 Some("proxmox-backup-proxy")) {
74 bail
!("unable to inititialize syslog - {}", err
);
77 // Note: To debug early connection error use
78 // PROXMOX_DEBUG=1 ./target/release/proxmox-backup-proxy
79 let debug
= std
::env
::var("PROXMOX_DEBUG").is_ok();
81 let _
= public_auth_key(); // load with lazy_static
82 let _
= csrf_secret(); // load with lazy_static
84 let mut config
= ApiConfig
::new(
85 buildcfg
::JS_DIR
, &proxmox_backup
::api2
::ROUTER
, RpcEnvironmentType
::PUBLIC
)?
;
87 config
.add_alias("novnc", "/usr/share/novnc-pve");
88 config
.add_alias("extjs", "/usr/share/javascript/extjs");
89 config
.add_alias("fontawesome", "/usr/share/fonts-font-awesome");
90 config
.add_alias("xtermjs", "/usr/share/pve-xtermjs");
91 config
.add_alias("locale", "/usr/share/pbs-i18n");
92 config
.add_alias("widgettoolkit", "/usr/share/javascript/proxmox-widget-toolkit");
93 config
.add_alias("docs", "/usr/share/doc/proxmox-backup/html");
95 let mut indexpath
= PathBuf
::from(buildcfg
::JS_DIR
);
96 indexpath
.push("index.hbs");
97 config
.register_template("index", &indexpath
)?
;
98 config
.register_template("console", "/usr/share/pve-xtermjs/index.html.hbs")?
;
100 let mut commando_sock
= server
::CommandoSocket
::new(server
::our_ctrl_sock());
102 config
.enable_file_log(buildcfg
::API_ACCESS_LOG_FN
, &mut commando_sock
)?
;
104 let rest_server
= RestServer
::new(config
);
106 //openssl req -x509 -newkey rsa:4096 -keyout /etc/proxmox-backup/proxy.key -out /etc/proxmox-backup/proxy.pem -nodes
107 let key_path
= configdir
!("/proxy.key");
108 let cert_path
= configdir
!("/proxy.pem");
110 let mut acceptor
= SslAcceptor
::mozilla_intermediate_v5(SslMethod
::tls()).unwrap();
111 acceptor
.set_private_key_file(key_path
, SslFiletype
::PEM
)
112 .map_err(|err
| format_err
!("unable to read proxy key {} - {}", key_path
, err
))?
;
113 acceptor
.set_certificate_chain_file(cert_path
)
114 .map_err(|err
| format_err
!("unable to read proxy cert {} - {}", cert_path
, err
))?
;
115 acceptor
.check_private_key().unwrap();
117 let acceptor
= Arc
::new(acceptor
.build());
119 let server
= daemon
::create_daemon(
120 ([0,0,0,0,0,0,0,0], 8007).into(),
123 let connections
= accept_connections(listener
, acceptor
, debug
);
124 let connections
= hyper
::server
::accept
::from_stream(connections
);
127 .and_then(|_
| hyper
::Server
::builder(connections
)
129 .with_graceful_shutdown(server
::shutdown_future())
130 .map_err(Error
::from
)
132 .map_err(|err
| eprintln
!("server error: {}", err
))
138 server
::write_pid(buildcfg
::PROXMOX_BACKUP_PROXY_PID_FN
)?
;
139 daemon
::systemd_notify(daemon
::SystemdNotify
::Ready
)?
;
141 let init_result
: Result
<(), Error
> = try_block
!({
142 server
::register_task_control_commands(&mut commando_sock
)?
;
143 commando_sock
.spawn()?
;
144 server
::server_state_init()?
;
148 if let Err(err
) = init_result
{
149 bail
!("unable to start daemon - {}", err
);
152 start_task_scheduler();
153 start_stat_generator();
156 log
::info
!("server shutting down, waiting for active workers to complete");
157 proxmox_backup
::server
::last_worker_future().await?
;
158 log
::info
!("done - exit server");
163 fn accept_connections(
164 mut listener
: tokio
::net
::TcpListener
,
165 acceptor
: Arc
<openssl
::ssl
::SslAcceptor
>,
167 ) -> tokio
::sync
::mpsc
::Receiver
<Result
<tokio_openssl
::SslStream
<tokio
::net
::TcpStream
>, Error
>> {
169 const MAX_PENDING_ACCEPTS
: usize = 1024;
171 let (sender
, receiver
) = tokio
::sync
::mpsc
::channel(MAX_PENDING_ACCEPTS
);
173 let accept_counter
= Arc
::new(());
175 tokio
::spawn(async
move {
177 match listener
.accept().await
{
179 eprintln
!("error accepting tcp connection: {}", err
);
181 Ok((sock
, _addr
)) => {
182 sock
.set_nodelay(true).unwrap();
183 let _
= set_tcp_keepalive(sock
.as_raw_fd(), PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
);
184 let acceptor
= Arc
::clone(&acceptor
);
185 let mut sender
= sender
.clone();
187 if Arc
::strong_count(&accept_counter
) > MAX_PENDING_ACCEPTS
{
188 eprintln
!("connection rejected - to many open connections");
192 let accept_counter
= accept_counter
.clone();
193 tokio
::spawn(async
move {
194 let accept_future
= tokio
::time
::timeout(
195 Duration
::new(10, 0), tokio_openssl
::accept(&acceptor
, sock
));
197 let result
= accept_future
.await
;
200 Ok(Ok(connection
)) => {
201 if let Err(_
) = sender
.send(Ok(connection
)).await
{
203 eprintln
!("detect closed connection channel");
209 eprintln
!("https handshake failed - {}", err
);
214 eprintln
!("https handshake timeout");
219 drop(accept_counter
); // decrease reference count
229 fn start_stat_generator() {
230 let abort_future
= server
::shutdown_future();
231 let future
= Box
::pin(run_stat_generator());
232 let task
= futures
::future
::select(future
, abort_future
);
233 tokio
::spawn(task
.map(|_
| ()));
236 fn start_task_scheduler() {
237 let abort_future
= server
::shutdown_future();
238 let future
= Box
::pin(run_task_scheduler());
239 let task
= futures
::future
::select(future
, abort_future
);
240 tokio
::spawn(task
.map(|_
| ()));
243 use std
::time
::{SystemTime, Instant, Duration, UNIX_EPOCH}
;
245 fn next_minute() -> Result
<Instant
, Error
> {
246 let now
= SystemTime
::now();
247 let epoch_now
= now
.duration_since(UNIX_EPOCH
)?
;
248 let epoch_next
= Duration
::from_secs((epoch_now
.as_secs()/60 + 1)*60);
249 Ok(Instant
::now() + epoch_next
- epoch_now
)
252 async
fn run_task_scheduler() {
254 let mut count
: usize = 0;
259 let delay_target
= match next_minute() { // try to run very minute
262 eprintln
!("task scheduler: compute next minute failed - {}", err
);
263 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(Instant
::now() + Duration
::from_secs(60))).await
;
268 if count
> 2 { // wait 1..2 minutes before starting
269 match schedule_tasks().catch_unwind().await
{
271 match panic
.downcast
::<&str>() {
273 eprintln
!("task scheduler panic: {}", msg
);
276 eprintln
!("task scheduler panic - unknown type");
281 eprintln
!("task scheduler failed - {:?}", err
);
287 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
291 async
fn schedule_tasks() -> Result
<(), Error
> {
293 schedule_datastore_garbage_collection().await
;
294 schedule_datastore_prune().await
;
295 schedule_datastore_sync_jobs().await
;
296 schedule_datastore_verify_jobs().await
;
297 schedule_task_log_rotate().await
;
302 async
fn schedule_datastore_garbage_collection() {
304 use proxmox_backup
::config
::{
311 let config
= match datastore
::config() {
313 eprintln
!("unable to read datastore config - {}", err
);
316 Ok((config
, _digest
)) => config
,
319 for (store
, (_
, store_config
)) in config
.sections
{
320 let datastore
= match DataStore
::lookup_datastore(&store
) {
321 Ok(datastore
) => datastore
,
323 eprintln
!("lookup_datastore failed - {}", err
);
328 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
331 eprintln
!("datastore config from_value failed - {}", err
);
336 let event_str
= match store_config
.gc_schedule
{
337 Some(event_str
) => event_str
,
341 let event
= match parse_calendar_event(&event_str
) {
344 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
349 if datastore
.garbage_collection_running() { continue; }
351 let worker_type
= "garbage_collection";
353 let last
= match jobstate
::last_run_time(worker_type
, &store
) {
356 eprintln
!("could not get last run time of {} {}: {}", worker_type
, store
, err
);
361 let next
= match compute_next_event(&event
, last
, false) {
362 Ok(Some(next
)) => next
,
363 Ok(None
) => continue,
365 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
370 let now
= proxmox
::tools
::time
::epoch_i64();
372 if next
> now { continue; }
374 let job
= match Job
::new(worker_type
, &store
) {
376 Err(_
) => continue, // could not get lock
379 let auth_id
= Authid
::root_auth_id();
381 if let Err(err
) = crate::server
::do_garbage_collection_job(job
, datastore
, auth_id
, Some(event_str
), false) {
382 eprintln
!("unable to start garbage collection job on datastore {} - {}", store
, err
);
387 async
fn schedule_datastore_prune() {
389 use proxmox_backup
::{
399 let config
= match datastore
::config() {
401 eprintln
!("unable to read datastore config - {}", err
);
404 Ok((config
, _digest
)) => config
,
407 for (store
, (_
, store_config
)) in config
.sections
{
409 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
412 eprintln
!("datastore '{}' config from_value failed - {}", store
, err
);
417 let event_str
= match store_config
.prune_schedule
{
418 Some(event_str
) => event_str
,
422 let prune_options
= PruneOptions
{
423 keep_last
: store_config
.keep_last
,
424 keep_hourly
: store_config
.keep_hourly
,
425 keep_daily
: store_config
.keep_daily
,
426 keep_weekly
: store_config
.keep_weekly
,
427 keep_monthly
: store_config
.keep_monthly
,
428 keep_yearly
: store_config
.keep_yearly
,
431 if !prune_options
.keeps_something() { // no prune settings - keep all
435 let worker_type
= "prune";
436 if check_schedule(worker_type
, &event_str
, &store
) {
437 let job
= match Job
::new(worker_type
, &store
) {
439 Err(_
) => continue, // could not get lock
442 let auth_id
= Authid
::root_auth_id().clone();
443 if let Err(err
) = do_prune_job(job
, prune_options
, store
.clone(), &auth_id
, Some(event_str
)) {
444 eprintln
!("unable to start datastore prune job {} - {}", &store
, err
);
450 async
fn schedule_datastore_sync_jobs() {
452 use proxmox_backup
::config
::sync
::{
457 let config
= match sync
::config() {
459 eprintln
!("unable to read sync job config - {}", err
);
462 Ok((config
, _digest
)) => config
,
465 for (job_id
, (_
, job_config
)) in config
.sections
{
466 let job_config
: SyncJobConfig
= match serde_json
::from_value(job_config
) {
469 eprintln
!("sync job config from_value failed - {}", err
);
474 let event_str
= match job_config
.schedule
{
475 Some(ref event_str
) => event_str
.clone(),
479 let worker_type
= "syncjob";
480 if check_schedule(worker_type
, &event_str
, &job_id
) {
481 let job
= match Job
::new(worker_type
, &job_id
) {
483 Err(_
) => continue, // could not get lock
486 let auth_id
= Authid
::root_auth_id().clone();
487 if let Err(err
) = do_sync_job(job
, job_config
, &auth_id
, Some(event_str
)) {
488 eprintln
!("unable to start datastore sync job {} - {}", &job_id
, err
);
494 async
fn schedule_datastore_verify_jobs() {
496 use proxmox_backup
::config
::verify
::{
498 VerificationJobConfig
,
501 let config
= match verify
::config() {
503 eprintln
!("unable to read verification job config - {}", err
);
506 Ok((config
, _digest
)) => config
,
508 for (job_id
, (_
, job_config
)) in config
.sections
{
509 let job_config
: VerificationJobConfig
= match serde_json
::from_value(job_config
) {
512 eprintln
!("verification job config from_value failed - {}", err
);
516 let event_str
= match job_config
.schedule
{
517 Some(ref event_str
) => event_str
.clone(),
521 let worker_type
= "verificationjob";
522 let auth_id
= Authid
::root_auth_id().clone();
523 if check_schedule(worker_type
, &event_str
, &job_id
) {
524 let job
= match Job
::new(&worker_type
, &job_id
) {
526 Err(_
) => continue, // could not get lock
528 if let Err(err
) = do_verification_job(job
, job_config
, &auth_id
, Some(event_str
)) {
529 eprintln
!("unable to start datastore verification job {} - {}", &job_id
, err
);
535 async
fn schedule_task_log_rotate() {
537 let worker_type
= "logrotate";
538 let job_id
= "access-log_and_task-archive";
540 // schedule daily at 00:00 like normal logrotate
541 let schedule
= "00:00";
543 if !check_schedule(worker_type
, schedule
, job_id
) {
544 // if we never ran the rotation, schedule instantly
545 match jobstate
::JobState
::load(worker_type
, job_id
) {
546 Ok(state
) => match state
{
547 jobstate
::JobState
::Created { .. }
=> {}
,
554 let mut job
= match Job
::new(worker_type
, job_id
) {
556 Err(_
) => return, // could not get lock
559 if let Err(err
) = WorkerTask
::new_thread(
562 Authid
::root_auth_id().clone(),
565 job
.start(&worker
.upid().to_string())?
;
566 worker
.log(format
!("starting task log rotation"));
568 let result
= try_block
!({
569 let max_size
= 512 * 1024 - 1; // an entry has ~ 100b, so > 5000 entries/file
570 let max_files
= 20; // times twenty files gives > 100000 task entries
571 let has_rotated
= rotate_task_log_archive(max_size
, true, Some(max_files
))?
;
573 worker
.log(format
!("task log archive was rotated"));
575 worker
.log(format
!("task log archive was not rotated"));
578 let max_size
= 32 * 1024 * 1024 - 1;
580 let mut logrotate
= LogRotate
::new(buildcfg
::API_ACCESS_LOG_FN
, true)
581 .ok_or_else(|| format_err
!("could not get API access log file names"))?
;
583 if logrotate
.rotate(max_size
, None
, Some(max_files
))?
{
584 println
!("rotated access log, telling daemons to re-open log file");
585 proxmox_backup
::tools
::runtime
::block_on(command_reopen_logfiles())?
;
586 worker
.log(format
!("API access log was rotated"));
588 worker
.log(format
!("API access log was not rotated"));
591 let mut logrotate
= LogRotate
::new(buildcfg
::API_AUTH_LOG_FN
, true)
592 .ok_or_else(|| format_err
!("could not get API auth log file names"))?
;
594 if logrotate
.rotate(max_size
, None
, Some(max_files
))?
{
595 worker
.log(format
!("API access log was rotated"));
597 worker
.log(format
!("API access log was not rotated"));
603 let status
= worker
.create_state(&result
);
605 if let Err(err
) = job
.finish(status
) {
606 eprintln
!("could not finish job state for {}: {}", worker_type
, err
);
612 eprintln
!("unable to start task log rotation: {}", err
);
617 async
fn command_reopen_logfiles() -> Result
<(), Error
> {
618 // only care about the most recent daemon instance for each, proxy & api, as other older ones
619 // should not respond to new requests anyway, but only finish their current one and then exit.
620 let sock
= server
::our_ctrl_sock();
621 let f1
= server
::send_command(sock
, serde_json
::json
!({
622 "command": "api-access-log-reopen",
625 let pid
= server
::read_pid(buildcfg
::PROXMOX_BACKUP_API_PID_FN
)?
;
626 let sock
= server
::ctrl_sock_from_pid(pid
);
627 let f2
= server
::send_command(sock
, serde_json
::json
!({
628 "command": "api-access-log-reopen",
631 match futures
::join
!(f1
, f2
) {
632 (Err(e1
), Err(e2
)) => Err(format_err
!("reopen commands failed, proxy: {}; api: {}", e1
, e2
)),
633 (Err(e1
), Ok(_
)) => Err(format_err
!("reopen commands failed, proxy: {}", e1
)),
634 (Ok(_
), Err(e2
)) => Err(format_err
!("reopen commands failed, api: {}", e2
)),
639 async
fn run_stat_generator() {
644 let save
= if count
>= 6 { count = 0; true }
else { false }
;
646 let delay_target
= Instant
::now() + Duration
::from_secs(10);
648 generate_host_stats(save
).await
;
650 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
656 fn rrd_update_gauge(name
: &str, value
: f64, save
: bool
) {
657 use proxmox_backup
::rrd
;
658 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Gauge
, save
) {
659 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
663 fn rrd_update_derive(name
: &str, value
: f64, save
: bool
) {
664 use proxmox_backup
::rrd
;
665 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Derive
, save
) {
666 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
670 async
fn generate_host_stats(save
: bool
) {
671 use proxmox
::sys
::linux
::procfs
::{
672 read_meminfo
, read_proc_stat
, read_proc_net_dev
, read_loadavg
};
673 use proxmox_backup
::config
::datastore
;
676 proxmox_backup
::tools
::runtime
::block_in_place(move || {
678 match read_proc_stat() {
680 rrd_update_gauge("host/cpu", stat
.cpu
, save
);
681 rrd_update_gauge("host/iowait", stat
.iowait_percent
, save
);
684 eprintln
!("read_proc_stat failed - {}", err
);
688 match read_meminfo() {
690 rrd_update_gauge("host/memtotal", meminfo
.memtotal
as f64, save
);
691 rrd_update_gauge("host/memused", meminfo
.memused
as f64, save
);
692 rrd_update_gauge("host/swaptotal", meminfo
.swaptotal
as f64, save
);
693 rrd_update_gauge("host/swapused", meminfo
.swapused
as f64, save
);
696 eprintln
!("read_meminfo failed - {}", err
);
700 match read_proc_net_dev() {
702 use proxmox_backup
::config
::network
::is_physical_nic
;
706 if !is_physical_nic(&item
.device
) { continue; }
707 netin
+= item
.receive
;
710 rrd_update_derive("host/netin", netin
as f64, save
);
711 rrd_update_derive("host/netout", netout
as f64, save
);
714 eprintln
!("read_prox_net_dev failed - {}", err
);
718 match read_loadavg() {
720 rrd_update_gauge("host/loadavg", loadavg
.0 as f64, save
);
723 eprintln
!("read_loadavg failed - {}", err
);
727 let disk_manager
= DiskManage
::new();
729 gather_disk_stats(disk_manager
.clone(), Path
::new("/"), "host", save
);
731 match datastore
::config() {
733 let datastore_list
: Vec
<datastore
::DataStoreConfig
> =
734 config
.convert_to_typed_array("datastore").unwrap_or(Vec
::new());
736 for config
in datastore_list
{
738 let rrd_prefix
= format
!("datastore/{}", config
.name
);
739 let path
= std
::path
::Path
::new(&config
.path
);
740 gather_disk_stats(disk_manager
.clone(), path
, &rrd_prefix
, save
);
744 eprintln
!("read datastore config failed - {}", err
);
751 fn check_schedule(worker_type
: &str, event_str
: &str, id
: &str) -> bool
{
752 let event
= match parse_calendar_event(event_str
) {
755 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
760 let last
= match jobstate
::last_run_time(worker_type
, &id
) {
763 eprintln
!("could not get last run time of {} {}: {}", worker_type
, id
, err
);
768 let next
= match compute_next_event(&event
, last
, false) {
769 Ok(Some(next
)) => next
,
770 Ok(None
) => return false,
772 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
777 let now
= proxmox
::tools
::time
::epoch_i64();
781 fn gather_disk_stats(disk_manager
: Arc
<DiskManage
>, path
: &Path
, rrd_prefix
: &str, save
: bool
) {
783 match proxmox_backup
::tools
::disks
::disk_usage(path
) {
785 let rrd_key
= format
!("{}/total", rrd_prefix
);
786 rrd_update_gauge(&rrd_key
, status
.total
as f64, save
);
787 let rrd_key
= format
!("{}/used", rrd_prefix
);
788 rrd_update_gauge(&rrd_key
, status
.used
as f64, save
);
791 eprintln
!("read disk_usage on {:?} failed - {}", path
, err
);
795 match disk_manager
.find_mounted_device(path
) {
797 Ok(Some((fs_type
, device
, source
))) => {
798 let mut device_stat
= None
;
799 match fs_type
.as_str() {
801 if let Some(pool
) = source
{
802 match zfs_pool_stats(&pool
) {
803 Ok(stat
) => device_stat
= stat
,
804 Err(err
) => eprintln
!("zfs_pool_stats({:?}) failed - {}", pool
, err
),
809 if let Ok(disk
) = disk_manager
.clone().disk_by_dev_num(device
.into_dev_t()) {
810 match disk
.read_stat() {
811 Ok(stat
) => device_stat
= stat
,
812 Err(err
) => eprintln
!("disk.read_stat {:?} failed - {}", path
, err
),
817 if let Some(stat
) = device_stat
{
818 let rrd_key
= format
!("{}/read_ios", rrd_prefix
);
819 rrd_update_derive(&rrd_key
, stat
.read_ios
as f64, save
);
820 let rrd_key
= format
!("{}/read_bytes", rrd_prefix
);
821 rrd_update_derive(&rrd_key
, (stat
.read_sectors
*512) as f64, save
);
823 let rrd_key
= format
!("{}/write_ios", rrd_prefix
);
824 rrd_update_derive(&rrd_key
, stat
.write_ios
as f64, save
);
825 let rrd_key
= format
!("{}/write_bytes", rrd_prefix
);
826 rrd_update_derive(&rrd_key
, (stat
.write_sectors
*512) as f64, save
);
828 let rrd_key
= format
!("{}/io_ticks", rrd_prefix
);
829 rrd_update_derive(&rrd_key
, (stat
.io_ticks
as f64)/1000.0, save
);
833 eprintln
!("find_mounted_device failed - {}", err
);