Skip to content

snp: solana network protocol #6828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

snp: solana network protocol #6828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions book/api/metrics-generated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1118,3 +1118,70 @@
| <span class="metrics-name">benchs_&#8203;transactions_&#8203;sent</span> | counter | Number of benchmark packets sent |

</div>

## Snp Tile

<div class="metrics">

| Metric | Type | Description |
|--------|------|-------------|
| <span class="metrics-name">snp_&#8203;all_&#8203;dest_&#8203;meta_&#8203;cnt</span> | counter | The number of destinations from which we have metadata (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;dest_&#8203;meta_&#8203;snp_&#8203;available_&#8203;cnt</span> | counter | The number of SNP-available destination (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;dest_&#8203;meta_&#8203;snp_&#8203;enabled_&#8203;cnt</span> | counter | The number of SNP-enabled destinations (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;cur_&#8203;total</span> | counter | The number of current created connections (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;cur_&#8203;established</span> | counter | The number of currently established connections (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;total</span> | counter | The number of accumulated created connections (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;established</span> | counter | The number of accumulated established connections (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;dropped</span> | counter | The number of accumulated dropped connections (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;handshake</span> | counter | The number of accumulated dropped connections during handshake (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;established</span> | counter | The number of accumulated dropped connections that had been established (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;set_&#8203;identity</span> | counter | The number of accumulated dropped connections due to set identity (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;to_&#8203;snp_&#8203;avail_&#8203;cnt</span> | counter | The number of bytes sent via UDP to a SNP-available destination (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;to_&#8203;snp_&#8203;avail_&#8203;cnt</span> | counter | The number of packets sent via UDP to a SNP-available destination (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of bytes sent via UDP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of bytes sent via SNP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of packets sent via UDP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of packets sent via SNP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;tx_&#8203;pkts_&#8203;dropped_&#8203;no_&#8203;credits_&#8203;cnt</span> | counter | The number of packets that were not sent due to insufficient flow credits (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes received (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of bytes received via UDP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;bytes_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of bytes received via SNP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets received (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of packets received via UDP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;pkts_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of packets received via SNP (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;rx_&#8203;pkts_&#8203;dropped_&#8203;no_&#8203;credits_&#8203;cnt</span> | counter | The number of packets that were received but dropped due to insufficient flow credits (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;mcast_&#8203;tx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets sent to a multicast channel (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;mcast_&#8203;tx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes sent to a multicast channel (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;mcast_&#8203;rx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets received from a multicast channel (all connections) |
| <span class="metrics-name">snp_&#8203;all_&#8203;mcast_&#8203;rx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes received from a multicast channel (all connections) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;dest_&#8203;meta_&#8203;cnt</span> | counter | The number of destinations from which we have metadata (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;dest_&#8203;meta_&#8203;snp_&#8203;available_&#8203;cnt</span> | counter | The number of SNP-available destination (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;dest_&#8203;meta_&#8203;snp_&#8203;enabled_&#8203;cnt</span> | counter | The number of SNP-enabled destinations (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;cur_&#8203;total</span> | counter | The number of current created connections (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;cur_&#8203;established</span> | counter | The number of currently established connections (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;total</span> | counter | The number of accumulated created connections (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;established</span> | counter | The number of accumulated established connections (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;dropped</span> | counter | The number of accumulated dropped connections (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;handshake</span> | counter | The number of accumulated dropped connections during handshake (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;established</span> | counter | The number of accumulated dropped connections that had been established (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;conn_&#8203;acc_&#8203;dropped_&#8203;set_&#8203;identity</span> | counter | The number of accumulated dropped connections due to set identity (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;to_&#8203;snp_&#8203;avail_&#8203;cnt</span> | counter | The number of bytes sent via UDP to a SNP-available destination (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;to_&#8203;snp_&#8203;avail_&#8203;cnt</span> | counter | The number of packets sent via UDP to a SNP-available destination (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of bytes sent via UDP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;bytes_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of bytes sent via SNP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of packets sent via UDP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;pkts_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of packets sent via SNP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;tx_&#8203;pkts_&#8203;dropped_&#8203;no_&#8203;credits_&#8203;cnt</span> | counter | The number of packets that were not sent due to insufficient flow credits (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes received (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;bytes_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of bytes received via UDP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;bytes_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of bytes received via SNP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets received (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;pkts_&#8203;via_&#8203;udp_&#8203;cnt</span> | counter | The number of packets received via UDP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;pkts_&#8203;via_&#8203;snp_&#8203;cnt</span> | counter | The number of packets received via SNP (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;rx_&#8203;pkts_&#8203;dropped_&#8203;no_&#8203;credits_&#8203;cnt</span> | counter | The number of packets that were received but dropped due to insufficient flow credits (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;mcast_&#8203;tx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets sent to a multicast channel (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;mcast_&#8203;tx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes sent to a multicast channel (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;mcast_&#8203;rx_&#8203;pkts_&#8203;cnt</span> | counter | The number of packets received from a multicast channel (SNP-enforced connections only) |
| <span class="metrics-name">snp_&#8203;enf_&#8203;mcast_&#8203;rx_&#8203;bytes_&#8203;cnt</span> | counter | The number of bytes received from a multicast channel (SNP-enforced connections only) |

</div>
2 changes: 1 addition & 1 deletion src/app/fdctl/Local.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ $(call add-objs,commands/run_agave,fd_fdctl)
$(call make-lib,fdctl_version)
$(call add-objs,version,fdctl_version)

$(call make-bin-rust,fdctl,main,fd_fdctl fdctl_shared fdctl_platform fd_discoh fd_disco agave_validator fd_flamenco fd_funk fd_quic fd_tls fd_reedsol fd_waltz fd_tango fd_ballet fd_util fdctl_version)
$(call make-bin-rust,fdctl,main,fd_fdctl fdctl_shared fdctl_platform fd_discoh fd_disco agave_validator fd_flamenco fd_funk fd_quic fd_tls fd_snp fd_reedsol fd_waltz fd_tango fd_ballet fd_util fdctl_version)

check-agave-hash:
@$(eval AGAVE_COMMIT_LS_TREE=$(shell git ls-tree HEAD | grep agave | awk '{print $$3}'))
Expand Down
13 changes: 13 additions & 0 deletions src/app/fdctl/config/default.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,19 @@ dynamic_port_range = "8900-9000"
# slow clients but also increase memory usage.
send_buffer_size_mb = 5120

# SNP tile handles the Solana Network Protocol (SNP), both ingress
# and egress.
[tiles.snp]
# SNP is currently optional, and disabled by default.
enabled = false

# With SNP currently optional, the validator auto detects if
# peers have SNP enabled or not, and gracefully degrades to
# UDP for peers that don't support SNP.
# SNP can be enforced for a specific set of destinations.
# For these, SNP will be required and not downgraded to UDP.
enforced_destinations = []

# These options can be useful for development, but should not be used
# when connecting to a live cluster, as they may cause the validator to
# be unstable or have degraded performance or security. The program
Expand Down
2 changes: 2 additions & 0 deletions src/app/fdctl/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ extern fd_topo_run_tile_t fd_tile_verify;
extern fd_topo_run_tile_t fd_tile_dedup;
extern fd_topo_run_tile_t fd_tile_pack;
extern fd_topo_run_tile_t fd_tile_shred;
extern fd_topo_run_tile_t fd_tile_snp;
extern fd_topo_run_tile_t fd_tile_sign;
extern fd_topo_run_tile_t fd_tile_metric;
extern fd_topo_run_tile_t fd_tile_cswtch;
Expand All @@ -70,6 +71,7 @@ fd_topo_run_tile_t * TILES[] = {
&fd_tile_dedup,
&fd_tile_pack,
&fd_tile_shred,
&fd_tile_snp,
&fd_tile_sign,
&fd_tile_metric,
&fd_tile_cswtch,
Expand Down
Loading
Loading