Line data    Source code

       1              : //!
       2              : //!   WAL service listens for client connections and
       3              : //!   receive WAL from wal_proposer and send it to WAL receivers
       4              : //!
       5              : use anyhow::{Context, Result};
       6              : use postgres_backend::QueryError;
       7              : use std::{future, time::Duration};
       8              : use tokio::net::TcpStream;
       9              : use tokio_io_timeout::TimeoutReader;
      10              : use tracing::*;
      11              : use utils::{auth::Scope, measured_stream::MeasuredStream};
      12              : 
      13              : use crate::handler::SafekeeperPostgresHandler;
      14              : use crate::metrics::TrafficMetrics;
      15              : use crate::SafeKeeperConf;
      16              : use postgres_backend::{AuthType, PostgresBackend};
      17              : 
      18              : /// Accept incoming TCP connections and spawn them into a background thread.
      19              : /// allowed_auth_scope is either SafekeeperData (wide JWT tokens giving access
      20              : /// to any tenant are allowed) or Tenant (only tokens giving access to specific
      21              : /// tenant are allowed). Doesn't matter if auth is disabled in conf.
      22         1016 : pub async fn task_main(
      23         1016 :     conf: SafeKeeperConf,
      24         1016 :     pg_listener: std::net::TcpListener,
      25         1016 :     allowed_auth_scope: Scope,
      26         1016 : ) -> anyhow::Result<()> {
      27         1016 :     // Tokio's from_std won't do this for us, per its comment.
      28         1016 :     pg_listener.set_nonblocking(true)?;
      29              : 
      30         1016 :     let listener = tokio::net::TcpListener::from_std(pg_listener)?;
      31         1016 :     let mut connection_count: ConnectionCount = 0;
      32              : 
      33              :     loop {
      34         4304 :         let (socket, peer_addr) = listener.accept().await.context("accept")?;
      35            0 :         debug!("accepted connection from {}", peer_addr);
      36         3288 :         let conf = conf.clone();
      37         3288 :         let conn_id = issue_connection_id(&mut connection_count);
      38              : 
      39         3288 :         tokio::spawn(
      40         3288 :             async move {
      41      6705883 :                 if let Err(err) = handle_socket(socket, conf, conn_id, allowed_auth_scope).await {
      42           30 :                     error!("connection handler exited: {}", err);
      43         2821 :                 }
      44         2851 :             }
      45         3288 :             .instrument(info_span!("", cid = %conn_id, ttid = field::Empty)),
      46              :         );
      47              :     }
      48            0 : }
      49              : 
      50              : /// This is run by `task_main` above, inside a background thread.
      51              : ///
      52         3288 : async fn handle_socket(
      53         3288 :     socket: TcpStream,
      54         3288 :     conf: SafeKeeperConf,
      55         3288 :     conn_id: ConnectionId,
      56         3288 :     allowed_auth_scope: Scope,
      57         3288 : ) -> Result<(), QueryError> {
      58         3288 :     socket.set_nodelay(true)?;
      59         3288 :     let peer_addr = socket.peer_addr()?;
      60              : 
      61              :     // Set timeout on reading from the socket. It prevents hanged up connection
      62              :     // if client suddenly disappears. Note that TCP_KEEPALIVE is not enabled by
      63              :     // default, and tokio doesn't provide ability to set it out of the box.
      64         3288 :     let mut socket = TimeoutReader::new(socket);
      65         3288 :     let wal_service_timeout = Duration::from_secs(60 * 10);
      66         3288 :     socket.set_timeout(Some(wal_service_timeout));
      67         3288 :     // pin! is here because TimeoutReader (due to storing sleep future inside)
      68         3288 :     // is not Unpin, and all pgbackend/framed/tokio dependencies require stream
      69         3288 :     // to be Unpin. Which is reasonable, as indeed something like TimeoutReader
      70         3288 :     // shouldn't be moved.
      71         3288 :     tokio::pin!(socket);
      72         3288 : 
      73         3288 :     let traffic_metrics = TrafficMetrics::new();
      74         3288 :     if let Some(current_az) = conf.availability_zone.as_deref() {
      75         3288 :         traffic_metrics.set_sk_az(current_az);
      76         3288 :     }
      77              : 
      78         3288 :     let socket = MeasuredStream::new(
      79         3288 :         socket,
      80      2939806 :         |cnt| {
      81      2939806 :             traffic_metrics.observe_read(cnt);
      82      2939806 :         },
      83      2481339 :         |cnt| {
      84      2481339 :             traffic_metrics.observe_write(cnt);
      85      2481339 :         },
      86         3288 :     );
      87              : 
      88         3288 :     let auth_key = match allowed_auth_scope {
      89         2535 :         Scope::Tenant => conf.pg_tenant_only_auth.clone(),
      90          753 :         _ => conf.pg_auth.clone(),
      91              :     };
      92         3288 :     let auth_type = match auth_key {
      93         3156 :         None => AuthType::Trust,
      94          132 :         Some(_) => AuthType::NeonJWT,
      95              :     };
      96         3288 :     let auth_pair = auth_key.map(|key| (allowed_auth_scope, key));
      97         3288 :     let mut conn_handler =
      98         3288 :         SafekeeperPostgresHandler::new(conf, conn_id, Some(traffic_metrics.clone()), auth_pair);
      99         3288 :     let pgbackend = PostgresBackend::new_from_io(socket, peer_addr, auth_type, None)?;
     100              :     // libpq protocol between safekeeper and walproposer / pageserver
     101              :     // We don't use shutdown.
     102         3288 :     pgbackend
     103         3288 :         .run(&mut conn_handler, future::pending::<()>)
     104      6705883 :         .await
     105         2851 : }
     106              : 
     107              : /// Unique WAL service connection ids are logged in spans for observability.
     108              : pub type ConnectionId = u32;
     109              : pub type ConnectionCount = u32;
     110              : 
     111         3288 : pub fn issue_connection_id(count: &mut ConnectionCount) -> ConnectionId {
     112         3288 :     *count = count.wrapping_add(1);
     113         3288 :     *count
     114         3288 : }