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
;
24 rotate_task_log_archive
,
26 tools
::systemd
::time
::{
33 use proxmox_backup
::api2
::types
::Authid
;
34 use proxmox_backup
::configdir
;
35 use proxmox_backup
::buildcfg
;
36 use proxmox_backup
::server
;
37 use proxmox_backup
::auth_helpers
::*;
38 use proxmox_backup
::tools
::{
47 PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
,
51 use proxmox_backup
::api2
::pull
::do_sync_job
;
52 use proxmox_backup
::server
::do_verification_job
;
53 use proxmox_backup
::server
::do_prune_job
;
55 fn main() -> Result
<(), Error
> {
56 proxmox_backup
::tools
::setup_safe_path_env();
58 let backup_uid
= proxmox_backup
::backup
::backup_user()?
.uid
;
59 let backup_gid
= proxmox_backup
::backup
::backup_group()?
.gid
;
60 let running_uid
= nix
::unistd
::Uid
::effective();
61 let running_gid
= nix
::unistd
::Gid
::effective();
63 if running_uid
!= backup_uid
|| running_gid
!= backup_gid
{
64 bail
!("proxy not running as backup user or group (got uid {} gid {})", running_uid
, running_gid
);
67 proxmox_backup
::tools
::runtime
::main(run())
70 async
fn run() -> Result
<(), Error
> {
71 if let Err(err
) = syslog
::init(
72 syslog
::Facility
::LOG_DAEMON
,
73 log
::LevelFilter
::Info
,
74 Some("proxmox-backup-proxy")) {
75 bail
!("unable to inititialize syslog - {}", err
);
78 let _
= public_auth_key(); // load with lazy_static
79 let _
= csrf_secret(); // load with lazy_static
81 let mut config
= ApiConfig
::new(
82 buildcfg
::JS_DIR
, &proxmox_backup
::api2
::ROUTER
, RpcEnvironmentType
::PUBLIC
)?
;
84 config
.add_alias("novnc", "/usr/share/novnc-pve");
85 config
.add_alias("extjs", "/usr/share/javascript/extjs");
86 config
.add_alias("fontawesome", "/usr/share/fonts-font-awesome");
87 config
.add_alias("xtermjs", "/usr/share/pve-xtermjs");
88 config
.add_alias("locale", "/usr/share/pbs-i18n");
89 config
.add_alias("widgettoolkit", "/usr/share/javascript/proxmox-widget-toolkit");
90 config
.add_alias("css", "/usr/share/javascript/proxmox-backup/css");
91 config
.add_alias("docs", "/usr/share/doc/proxmox-backup/html");
93 let mut indexpath
= PathBuf
::from(buildcfg
::JS_DIR
);
94 indexpath
.push("index.hbs");
95 config
.register_template("index", &indexpath
)?
;
96 config
.register_template("console", "/usr/share/pve-xtermjs/index.html.hbs")?
;
98 let mut commando_sock
= server
::CommandoSocket
::new(server
::our_ctrl_sock());
100 config
.enable_file_log(buildcfg
::API_ACCESS_LOG_FN
, &mut commando_sock
)?
;
102 let rest_server
= RestServer
::new(config
);
104 //openssl req -x509 -newkey rsa:4096 -keyout /etc/proxmox-backup/proxy.key -out /etc/proxmox-backup/proxy.pem -nodes
105 let key_path
= configdir
!("/proxy.key");
106 let cert_path
= configdir
!("/proxy.pem");
108 let mut acceptor
= SslAcceptor
::mozilla_intermediate_v5(SslMethod
::tls()).unwrap();
109 acceptor
.set_private_key_file(key_path
, SslFiletype
::PEM
)
110 .map_err(|err
| format_err
!("unable to read proxy key {} - {}", key_path
, err
))?
;
111 acceptor
.set_certificate_chain_file(cert_path
)
112 .map_err(|err
| format_err
!("unable to read proxy cert {} - {}", cert_path
, err
))?
;
113 acceptor
.check_private_key().unwrap();
115 let acceptor
= Arc
::new(acceptor
.build());
117 let server
= daemon
::create_daemon(
118 ([0,0,0,0,0,0,0,0], 8007).into(),
120 let connections
= proxmox_backup
::tools
::async_io
::StaticIncoming
::from(listener
)
121 .map_err(Error
::from
)
122 .try_filter_map(move |(sock
, _addr
)| {
123 let acceptor
= Arc
::clone(&acceptor
);
125 sock
.set_nodelay(true).unwrap();
127 let _
= set_tcp_keepalive(sock
.as_raw_fd(), PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
);
129 Ok(tokio_openssl
::accept(&acceptor
, sock
)
131 .ok() // handshake errors aren't be fatal, so return None to filter
135 let connections
= proxmox_backup
::tools
::async_io
::HyperAccept(connections
);
138 .and_then(|_
| hyper
::Server
::builder(connections
)
140 .with_graceful_shutdown(server
::shutdown_future())
141 .map_err(Error
::from
)
143 .map_err(|err
| eprintln
!("server error: {}", err
))
149 server
::write_pid(buildcfg
::PROXMOX_BACKUP_PROXY_PID_FN
)?
;
150 daemon
::systemd_notify(daemon
::SystemdNotify
::Ready
)?
;
152 let init_result
: Result
<(), Error
> = try_block
!({
153 server
::register_task_control_commands(&mut commando_sock
)?
;
154 commando_sock
.spawn()?
;
155 server
::server_state_init()?
;
159 if let Err(err
) = init_result
{
160 bail
!("unable to start daemon - {}", err
);
163 start_task_scheduler();
164 start_stat_generator();
167 log
::info
!("server shutting down, waiting for active workers to complete");
168 proxmox_backup
::server
::last_worker_future().await?
;
169 log
::info
!("done - exit server");
174 fn start_stat_generator() {
175 let abort_future
= server
::shutdown_future();
176 let future
= Box
::pin(run_stat_generator());
177 let task
= futures
::future
::select(future
, abort_future
);
178 tokio
::spawn(task
.map(|_
| ()));
181 fn start_task_scheduler() {
182 let abort_future
= server
::shutdown_future();
183 let future
= Box
::pin(run_task_scheduler());
184 let task
= futures
::future
::select(future
, abort_future
);
185 tokio
::spawn(task
.map(|_
| ()));
188 use std
::time
::{SystemTime, Instant, Duration, UNIX_EPOCH}
;
190 fn next_minute() -> Result
<Instant
, Error
> {
191 let now
= SystemTime
::now();
192 let epoch_now
= now
.duration_since(UNIX_EPOCH
)?
;
193 let epoch_next
= Duration
::from_secs((epoch_now
.as_secs()/60 + 1)*60);
194 Ok(Instant
::now() + epoch_next
- epoch_now
)
197 async
fn run_task_scheduler() {
199 let mut count
: usize = 0;
204 let delay_target
= match next_minute() { // try to run very minute
207 eprintln
!("task scheduler: compute next minute failed - {}", err
);
208 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(Instant
::now() + Duration
::from_secs(60))).await
;
213 if count
> 2 { // wait 1..2 minutes before starting
214 match schedule_tasks().catch_unwind().await
{
216 match panic
.downcast
::<&str>() {
218 eprintln
!("task scheduler panic: {}", msg
);
221 eprintln
!("task scheduler panic - unknown type");
226 eprintln
!("task scheduler failed - {:?}", err
);
232 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
236 async
fn schedule_tasks() -> Result
<(), Error
> {
238 schedule_datastore_garbage_collection().await
;
239 schedule_datastore_prune().await
;
240 schedule_datastore_sync_jobs().await
;
241 schedule_datastore_verify_jobs().await
;
242 schedule_task_log_rotate().await
;
247 async
fn schedule_datastore_garbage_collection() {
249 use proxmox_backup
::config
::{
256 let config
= match datastore
::config() {
258 eprintln
!("unable to read datastore config - {}", err
);
261 Ok((config
, _digest
)) => config
,
264 for (store
, (_
, store_config
)) in config
.sections
{
265 let datastore
= match DataStore
::lookup_datastore(&store
) {
266 Ok(datastore
) => datastore
,
268 eprintln
!("lookup_datastore failed - {}", err
);
273 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
276 eprintln
!("datastore config from_value failed - {}", err
);
281 let event_str
= match store_config
.gc_schedule
{
282 Some(event_str
) => event_str
,
286 let event
= match parse_calendar_event(&event_str
) {
289 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
294 if datastore
.garbage_collection_running() { continue; }
296 let worker_type
= "garbage_collection";
298 let last
= match jobstate
::last_run_time(worker_type
, &store
) {
301 eprintln
!("could not get last run time of {} {}: {}", worker_type
, store
, err
);
306 let next
= match compute_next_event(&event
, last
, false) {
307 Ok(Some(next
)) => next
,
308 Ok(None
) => continue,
310 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
315 let now
= proxmox
::tools
::time
::epoch_i64();
317 if next
> now { continue; }
319 let job
= match Job
::new(worker_type
, &store
) {
321 Err(_
) => continue, // could not get lock
324 let auth_id
= Authid
::backup_auth_id();
326 if let Err(err
) = crate::server
::do_garbage_collection_job(job
, datastore
, auth_id
, Some(event_str
), false) {
327 eprintln
!("unable to start garbage collection job on datastore {} - {}", store
, err
);
332 async
fn schedule_datastore_prune() {
334 use proxmox_backup
::{
344 let config
= match datastore
::config() {
346 eprintln
!("unable to read datastore config - {}", err
);
349 Ok((config
, _digest
)) => config
,
352 for (store
, (_
, store_config
)) in config
.sections
{
354 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
357 eprintln
!("datastore '{}' config from_value failed - {}", store
, err
);
362 let event_str
= match store_config
.prune_schedule
{
363 Some(event_str
) => event_str
,
367 let prune_options
= PruneOptions
{
368 keep_last
: store_config
.keep_last
,
369 keep_hourly
: store_config
.keep_hourly
,
370 keep_daily
: store_config
.keep_daily
,
371 keep_weekly
: store_config
.keep_weekly
,
372 keep_monthly
: store_config
.keep_monthly
,
373 keep_yearly
: store_config
.keep_yearly
,
376 if !prune_options
.keeps_something() { // no prune settings - keep all
380 let worker_type
= "prune";
381 if check_schedule(worker_type
, &event_str
, &store
) {
382 let job
= match Job
::new(worker_type
, &store
) {
384 Err(_
) => continue, // could not get lock
387 let auth_id
= Authid
::backup_auth_id().clone();
388 if let Err(err
) = do_prune_job(job
, prune_options
, store
.clone(), &auth_id
, Some(event_str
)) {
389 eprintln
!("unable to start datastore prune job {} - {}", &store
, err
);
395 async
fn schedule_datastore_sync_jobs() {
397 use proxmox_backup
::config
::sync
::{
402 let config
= match sync
::config() {
404 eprintln
!("unable to read sync job config - {}", err
);
407 Ok((config
, _digest
)) => config
,
410 for (job_id
, (_
, job_config
)) in config
.sections
{
411 let job_config
: SyncJobConfig
= match serde_json
::from_value(job_config
) {
414 eprintln
!("sync job config from_value failed - {}", err
);
419 let event_str
= match job_config
.schedule
{
420 Some(ref event_str
) => event_str
.clone(),
424 let worker_type
= "syncjob";
425 if check_schedule(worker_type
, &event_str
, &job_id
) {
426 let job
= match Job
::new(worker_type
, &job_id
) {
428 Err(_
) => continue, // could not get lock
431 let auth_id
= Authid
::backup_auth_id().clone();
432 if let Err(err
) = do_sync_job(job
, job_config
, &auth_id
, Some(event_str
)) {
433 eprintln
!("unable to start datastore sync job {} - {}", &job_id
, err
);
439 async
fn schedule_datastore_verify_jobs() {
441 use proxmox_backup
::config
::verify
::{
443 VerificationJobConfig
,
446 let config
= match verify
::config() {
448 eprintln
!("unable to read verification job config - {}", err
);
451 Ok((config
, _digest
)) => config
,
453 for (job_id
, (_
, job_config
)) in config
.sections
{
454 let job_config
: VerificationJobConfig
= match serde_json
::from_value(job_config
) {
457 eprintln
!("verification job config from_value failed - {}", err
);
461 let event_str
= match job_config
.schedule
{
462 Some(ref event_str
) => event_str
.clone(),
466 let worker_type
= "verificationjob";
467 let auth_id
= Authid
::backup_auth_id().clone();
468 if check_schedule(worker_type
, &event_str
, &job_id
) {
469 let job
= match Job
::new(&worker_type
, &job_id
) {
471 Err(_
) => continue, // could not get lock
473 if let Err(err
) = do_verification_job(job
, job_config
, &auth_id
, Some(event_str
)) {
474 eprintln
!("unable to start datastore verification job {} - {}", &job_id
, err
);
480 async
fn schedule_task_log_rotate() {
482 let worker_type
= "logrotate";
483 let job_id
= "access-log_and_task-archive";
485 // schedule daily at 00:00 like normal logrotate
486 let schedule
= "00:00";
488 if !check_schedule(worker_type
, schedule
, job_id
) {
489 // if we never ran the rotation, schedule instantly
490 match jobstate
::JobState
::load(worker_type
, job_id
) {
491 Ok(state
) => match state
{
492 jobstate
::JobState
::Created { .. }
=> {}
,
499 let mut job
= match Job
::new(worker_type
, job_id
) {
501 Err(_
) => return, // could not get lock
504 if let Err(err
) = WorkerTask
::new_thread(
507 Authid
::backup_auth_id().clone(),
510 job
.start(&worker
.upid().to_string())?
;
511 worker
.log(format
!("starting task log rotation"));
513 let result
= try_block
!({
514 let max_size
= 512 * 1024 - 1; // an entry has ~ 100b, so > 5000 entries/file
515 let max_files
= 20; // times twenty files gives > 100000 task entries
516 let has_rotated
= rotate_task_log_archive(max_size
, true, Some(max_files
))?
;
518 worker
.log(format
!("task log archive was rotated"));
520 worker
.log(format
!("task log archive was not rotated"));
523 let max_size
= 32 * 1024 * 1024 - 1;
525 let mut logrotate
= LogRotate
::new(buildcfg
::API_ACCESS_LOG_FN
, true)
526 .ok_or_else(|| format_err
!("could not get API access log file names"))?
;
528 let has_rotated
= logrotate
.rotate(max_size
, None
, Some(max_files
))?
;
530 println
!("rotated access log, telling daemons to re-open log file");
531 proxmox_backup
::tools
::runtime
::block_on(command_reopen_logfiles())?
;
533 worker
.log(format
!("API access log was rotated"));
535 worker
.log(format
!("API access log was not rotated"));
541 let status
= worker
.create_state(&result
);
543 if let Err(err
) = job
.finish(status
) {
544 eprintln
!("could not finish job state for {}: {}", worker_type
, err
);
550 eprintln
!("unable to start task log rotation: {}", err
);
555 async
fn command_reopen_logfiles() -> Result
<(), Error
> {
556 // only care about the most recent daemon instance for each, proxy & api, as other older ones
557 // should not respond to new requests anyway, but only finish their current one and then exit.
558 let sock
= server
::our_ctrl_sock();
559 server
::send_command(sock
, serde_json
::json
!({
560 "command": "api-access-log-reopen",
563 let pid
= server
::read_pid(buildcfg
::PROXMOX_BACKUP_API_PID_FN
)?
;
564 let sock
= server
::ctrl_sock_from_pid(pid
);
565 server
::send_command(sock
, serde_json
::json
!({
566 "command": "api-access-log-reopen",
571 async
fn run_stat_generator() {
576 let save
= if count
>= 6 { count = 0; true }
else { false }
;
578 let delay_target
= Instant
::now() + Duration
::from_secs(10);
580 generate_host_stats(save
).await
;
582 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
588 fn rrd_update_gauge(name
: &str, value
: f64, save
: bool
) {
589 use proxmox_backup
::rrd
;
590 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Gauge
, save
) {
591 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
595 fn rrd_update_derive(name
: &str, value
: f64, save
: bool
) {
596 use proxmox_backup
::rrd
;
597 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Derive
, save
) {
598 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
602 async
fn generate_host_stats(save
: bool
) {
603 use proxmox
::sys
::linux
::procfs
::{
604 read_meminfo
, read_proc_stat
, read_proc_net_dev
, read_loadavg
};
605 use proxmox_backup
::config
::datastore
;
608 proxmox_backup
::tools
::runtime
::block_in_place(move || {
610 match read_proc_stat() {
612 rrd_update_gauge("host/cpu", stat
.cpu
, save
);
613 rrd_update_gauge("host/iowait", stat
.iowait_percent
, save
);
616 eprintln
!("read_proc_stat failed - {}", err
);
620 match read_meminfo() {
622 rrd_update_gauge("host/memtotal", meminfo
.memtotal
as f64, save
);
623 rrd_update_gauge("host/memused", meminfo
.memused
as f64, save
);
624 rrd_update_gauge("host/swaptotal", meminfo
.swaptotal
as f64, save
);
625 rrd_update_gauge("host/swapused", meminfo
.swapused
as f64, save
);
628 eprintln
!("read_meminfo failed - {}", err
);
632 match read_proc_net_dev() {
634 use proxmox_backup
::config
::network
::is_physical_nic
;
638 if !is_physical_nic(&item
.device
) { continue; }
639 netin
+= item
.receive
;
642 rrd_update_derive("host/netin", netin
as f64, save
);
643 rrd_update_derive("host/netout", netout
as f64, save
);
646 eprintln
!("read_prox_net_dev failed - {}", err
);
650 match read_loadavg() {
652 rrd_update_gauge("host/loadavg", loadavg
.0 as f64, save
);
655 eprintln
!("read_loadavg failed - {}", err
);
659 let disk_manager
= DiskManage
::new();
661 gather_disk_stats(disk_manager
.clone(), Path
::new("/"), "host", save
);
663 match datastore
::config() {
665 let datastore_list
: Vec
<datastore
::DataStoreConfig
> =
666 config
.convert_to_typed_array("datastore").unwrap_or(Vec
::new());
668 for config
in datastore_list
{
670 let rrd_prefix
= format
!("datastore/{}", config
.name
);
671 let path
= std
::path
::Path
::new(&config
.path
);
672 gather_disk_stats(disk_manager
.clone(), path
, &rrd_prefix
, save
);
676 eprintln
!("read datastore config failed - {}", err
);
683 fn check_schedule(worker_type
: &str, event_str
: &str, id
: &str) -> bool
{
684 let event
= match parse_calendar_event(event_str
) {
687 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
692 let last
= match jobstate
::last_run_time(worker_type
, &id
) {
695 eprintln
!("could not get last run time of {} {}: {}", worker_type
, id
, err
);
700 let next
= match compute_next_event(&event
, last
, false) {
701 Ok(Some(next
)) => next
,
702 Ok(None
) => return false,
704 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
709 let now
= proxmox
::tools
::time
::epoch_i64();
713 fn gather_disk_stats(disk_manager
: Arc
<DiskManage
>, path
: &Path
, rrd_prefix
: &str, save
: bool
) {
715 match proxmox_backup
::tools
::disks
::disk_usage(path
) {
717 let rrd_key
= format
!("{}/total", rrd_prefix
);
718 rrd_update_gauge(&rrd_key
, status
.total
as f64, save
);
719 let rrd_key
= format
!("{}/used", rrd_prefix
);
720 rrd_update_gauge(&rrd_key
, status
.used
as f64, save
);
723 eprintln
!("read disk_usage on {:?} failed - {}", path
, err
);
727 match disk_manager
.find_mounted_device(path
) {
729 Ok(Some((fs_type
, device
, source
))) => {
730 let mut device_stat
= None
;
731 match fs_type
.as_str() {
733 if let Some(pool
) = source
{
734 match zfs_pool_stats(&pool
) {
735 Ok(stat
) => device_stat
= stat
,
736 Err(err
) => eprintln
!("zfs_pool_stats({:?}) failed - {}", pool
, err
),
741 if let Ok(disk
) = disk_manager
.clone().disk_by_dev_num(device
.into_dev_t()) {
742 match disk
.read_stat() {
743 Ok(stat
) => device_stat
= stat
,
744 Err(err
) => eprintln
!("disk.read_stat {:?} failed - {}", path
, err
),
749 if let Some(stat
) = device_stat
{
750 let rrd_key
= format
!("{}/read_ios", rrd_prefix
);
751 rrd_update_derive(&rrd_key
, stat
.read_ios
as f64, save
);
752 let rrd_key
= format
!("{}/read_bytes", rrd_prefix
);
753 rrd_update_derive(&rrd_key
, (stat
.read_sectors
*512) as f64, save
);
755 let rrd_key
= format
!("{}/write_ios", rrd_prefix
);
756 rrd_update_derive(&rrd_key
, stat
.write_ios
as f64, save
);
757 let rrd_key
= format
!("{}/write_bytes", rrd_prefix
);
758 rrd_update_derive(&rrd_key
, (stat
.write_sectors
*512) as f64, save
);
760 let rrd_key
= format
!("{}/io_ticks", rrd_prefix
);
761 rrd_update_derive(&rrd_key
, (stat
.io_ticks
as f64)/1000.0, save
);
765 eprintln
!("find_mounted_device failed - {}", err
);