_ Git - rust-lightning/blob - lightning/src/util/macro_logger.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 use chain::transaction::OutPoint;
  11 use chain::keysinterface::SpendableOutputDescriptor;
  12
  13 use bitcoin::hash_types::Txid;
  14 use bitcoin::blockdata::transaction::Transaction;
  15 use bitcoin::secp256k1::PublicKey;
  16
  17 use routing::router::Route;
  18 use ln::chan_utils::HTLCClaim;
  19 use util::logger::DebugBytes;
  20
  21 pub(crate) struct DebugPubKey<'a>(pub &'a PublicKey);
  22 impl<'a> core::fmt::Display for DebugPubKey<'a> {
  23         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
  24                 for i in self.0.serialize().iter() {
  25                         write!(f, "{:02x}", i)?;
  26                 }
  27                 Ok(())
  28         }
  29 }
  30 macro_rules! log_pubkey {
  31         ($obj: expr) => {
  32                 ::util::macro_logger::DebugPubKey(&$obj)
  33         }
  34 }
  35
  36 /// Logs a byte slice in hex format.
  37 #[macro_export]
  38 macro_rules! log_bytes {
  39         ($obj: expr) => {
  40                 $crate::util::logger::DebugBytes(&$obj)
  41         }
  42 }
  43
  44 pub(crate) struct DebugFundingChannelId<'a>(pub &'a Txid, pub u16);
  45 impl<'a> core::fmt::Display for DebugFundingChannelId<'a> {
  46         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
  47                 for i in (OutPoint { txid: self.0.clone(), index: self.1 }).to_channel_id().iter() {
  48                         write!(f, "{:02x}", i)?;
  49                 }
  50                 Ok(())
  51         }
  52 }
  53 macro_rules! log_funding_channel_id {
  54         ($funding_txid: expr, $funding_txo: expr) => {
  55                 ::util::macro_logger::DebugFundingChannelId(&$funding_txid, $funding_txo)
  56         }
  57 }
  58
  59 pub(crate) struct DebugFundingInfo<'a, T: 'a>(pub &'a (OutPoint, T));
  60 impl<'a, T> core::fmt::Display for DebugFundingInfo<'a, T> {
  61         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
  62                 DebugBytes(&(self.0).0.to_channel_id()[..]).fmt(f)
  63         }
  64 }
  65 macro_rules! log_funding_info {
  66         ($key_storage: expr) => {
  67                 ::util::macro_logger::DebugFundingInfo(&$key_storage.get_funding_txo())
  68         }
  69 }
  70
  71 pub(crate) struct DebugRoute<'a>(pub &'a Route);
  72 impl<'a> core::fmt::Display for DebugRoute<'a> {
  73         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
  74                 for (idx, p) in self.0.paths.iter().enumerate() {
  75                         writeln!(f, "path {}:", idx)?;
  76                         for h in p.iter() {
  77                                 writeln!(f, " node_id: {}, short_channel_id: {}, fee_msat: {}, cltv_expiry_delta: {}", log_pubkey!(h.pubkey), h.short_channel_id, h.fee_msat, h.cltv_expiry_delta)?;
  78                         }
  79                 }
  80                 Ok(())
  81         }
  82 }
  83 macro_rules! log_route {
  84         ($obj: expr) => {
  85                 ::util::macro_logger::DebugRoute(&$obj)
  86         }
  87 }
  88
  89 pub(crate) struct DebugTx<'a>(pub &'a Transaction);
  90 impl<'a> core::fmt::Display for DebugTx<'a> {
  91         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
  92                 if self.0.input.len() >= 1 && self.0.input.iter().any(|i| !i.witness.is_empty()) {
  93                         let first_input = &self.0.input[0];
  94                         let witness_script_len = first_input.witness.last().unwrap_or(&[]).len();
  95                         if self.0.input.len() == 1 && witness_script_len == 71 &&
  96                                         (first_input.sequence.0 >> 8*3) as u8 == 0x80 {
  97                                 write!(f, "commitment tx ")?;
  98                         } else if self.0.input.len() == 1 && witness_script_len == 71 {
  99                                 write!(f, "closing tx ")?;
 100                         } else if self.0.input.len() == 1 && HTLCClaim::from_witness(&first_input.witness) == Some(HTLCClaim::OfferedTimeout) {
 101                                 write!(f, "HTLC-timeout tx ")?;
 102                         } else if self.0.input.len() == 1 && HTLCClaim::from_witness(&first_input.witness) == Some(HTLCClaim::AcceptedPreimage) {
 103                                 write!(f, "HTLC-success tx ")?;
 104                         } else {
 105                                 let mut num_preimage = 0;
 106                                 let mut num_timeout = 0;
 107                                 let mut num_revoked = 0;
 108                                 for inp in &self.0.input {
 109                                         let htlc_claim = HTLCClaim::from_witness(&inp.witness);
 110                                         match htlc_claim {
 111                                                 Some(HTLCClaim::AcceptedPreimage)|Some(HTLCClaim::OfferedPreimage) => num_preimage += 1,
 112                                                 Some(HTLCClaim::AcceptedTimeout)|Some(HTLCClaim::OfferedTimeout) => num_timeout += 1,
 113                                                 Some(HTLCClaim::Revocation) => num_revoked += 1,
 114                                                 None => continue,
 115                                         }
 116                                 }
 117                                 if num_preimage > 0 || num_timeout > 0 || num_revoked > 0 {
 118                                         write!(f, "HTLC claim tx ({} preimage, {} timeout, {} revoked)",
 119                                                 num_preimage, num_timeout, num_revoked)?;
 120                                 }
 121                         }
 122                 } else {
 123                         debug_assert!(false, "We should never generate unknown transaction types");
 124                         write!(f, "unknown tx type ").unwrap();
 125                 }
 126                 write!(f, "with txid {}", self.0.txid())?;
 127                 Ok(())
 128         }
 129 }
 130
 131 macro_rules! log_tx {
 132         ($obj: expr) => {
 133                 ::util::macro_logger::DebugTx(&$obj)
 134         }
 135 }
 136
 137 pub(crate) struct DebugSpendable<'a>(pub &'a SpendableOutputDescriptor);
 138 impl<'a> core::fmt::Display for DebugSpendable<'a> {
 139         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 140                 match self.0 {
 141                         &SpendableOutputDescriptor::StaticOutput { ref outpoint, .. } => {
 142                                 write!(f, "StaticOutput {}:{} marked for spending", outpoint.txid, outpoint.index)?;
 143                         }
 144                         &SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) => {
 145                                 write!(f, "DelayedPaymentOutput {}:{} marked for spending", descriptor.outpoint.txid, descriptor.outpoint.index)?;
 146                         }
 147                         &SpendableOutputDescriptor::StaticPaymentOutput(ref descriptor) => {
 148                                 write!(f, "StaticPaymentOutput {}:{} marked for spending", descriptor.outpoint.txid, descriptor.outpoint.index)?;
 149                         }
 150                 }
 151                 Ok(())
 152         }
 153 }
 154
 155 macro_rules! log_spendable {
 156         ($obj: expr) => {
 157                 ::util::macro_logger::DebugSpendable(&$obj)
 158         }
 159 }
 160
 161 /// Create a new Record and log it. You probably don't want to use this macro directly,
 162 /// but it needs to be exported so `log_trace` etc can use it in external crates.
 163 #[doc(hidden)]
 164 #[macro_export]
 165 macro_rules! log_internal {
 166         ($logger: expr, $lvl:expr, $($arg:tt)+) => (
 167                 $logger.log(&$crate::util::logger::Record::new($lvl, format_args!($($arg)+), module_path!(), file!(), line!()))
 168         );
 169 }
 170
 171 /// Logs an entry at the given level.
 172 #[doc(hidden)]
 173 #[macro_export]
 174 macro_rules! log_given_level {
 175         ($logger: expr, $lvl:expr, $($arg:tt)+) => (
 176                 match $lvl {
 177                         #[cfg(not(any(feature = "max_level_off")))]
 178                         $crate::util::logger::Level::Error => log_internal!($logger, $lvl, $($arg)*),
 179                         #[cfg(not(any(feature = "max_level_off", feature = "max_level_error")))]
 180                         $crate::util::logger::Level::Warn => log_internal!($logger, $lvl, $($arg)*),
 181                         #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn")))]
 182                         $crate::util::logger::Level::Info => log_internal!($logger, $lvl, $($arg)*),
 183                         #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info")))]
 184                         $crate::util::logger::Level::Debug => log_internal!($logger, $lvl, $($arg)*),
 185                         #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug")))]
 186                         $crate::util::logger::Level::Trace => log_internal!($logger, $lvl, $($arg)*),
 187                         #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug", feature = "max_level_trace")))]
 188                         $crate::util::logger::Level::Gossip => log_internal!($logger, $lvl, $($arg)*),
 189
 190                         #[cfg(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug", feature = "max_level_trace"))]
 191                         _ => {
 192                                 // The level is disabled at compile-time
 193                         },
 194                 }
 195         );
 196 }
 197
 198 /// Log at the `ERROR` level.
 199 #[macro_export]
 200 macro_rules! log_error {
 201         ($logger: expr, $($arg:tt)*) => (
 202                 log_given_level!($logger, $crate::util::logger::Level::Error, $($arg)*);
 203         )
 204 }
 205
 206 /// Log at the `WARN` level.
 207 #[macro_export]
 208 macro_rules! log_warn {
 209         ($logger: expr, $($arg:tt)*) => (
 210                 log_given_level!($logger, $crate::util::logger::Level::Warn, $($arg)*);
 211         )
 212 }
 213
 214 /// Log at the `INFO` level.
 215 #[macro_export]
 216 macro_rules! log_info {
 217         ($logger: expr, $($arg:tt)*) => (
 218                 log_given_level!($logger, $crate::util::logger::Level::Info, $($arg)*);
 219         )
 220 }
 221
 222 /// Log at the `DEBUG` level.
 223 #[macro_export]
 224 macro_rules! log_debug {
 225         ($logger: expr, $($arg:tt)*) => (
 226                 log_given_level!($logger, $crate::util::logger::Level::Debug, $($arg)*);
 227         )
 228 }
 229
 230 /// Log at the `TRACE` level.
 231 #[macro_export]
 232 macro_rules! log_trace {
 233         ($logger: expr, $($arg:tt)*) => (
 234                 log_given_level!($logger, $crate::util::logger::Level::Trace, $($arg)*)
 235         )
 236 }
 237
 238 /// Log at the `GOSSIP` level.
 239 #[macro_export]
 240 macro_rules! log_gossip {
 241         ($logger: expr, $($arg:tt)*) => (
 242                 log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);
 243         )
 244 }