net/sctp/proc.c

   1 /* SCTP kernel implementation
   2  * Copyright (c) 2003 International Business Machines, Corp.
   3  *
   4  * This file is part of the SCTP kernel implementation
   5  *
   6  * This SCTP implementation is free software;
   7  * you can redistribute it and/or modify it under the terms of
   8  * the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This SCTP implementation is distributed in the hope that it
  13  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  14  *                 ************************
  15  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16  * See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with GNU CC; see the file COPYING.  If not, see
  20  * <http://www.gnu.org/licenses/>.
  21  *
  22  * Please send any bug reports or fixes you make to the
  23  * email address(es):
  24  *    lksctp developers <linux-sctp@vger.kernel.org>
  25  *
  26  * Written or modified by:
  27  *    Sridhar Samudrala <sri@us.ibm.com>
  28  */
  29
  30 #include <linux/types.h>
  31 #include <linux/seq_file.h>
  32 #include <linux/init.h>
  33 #include <linux/export.h>
  34 #include <net/sctp/sctp.h>
  35 #include <net/ip.h> /* for snmp_fold_field */
  36
  37 static const struct snmp_mib sctp_snmp_list[] = {
  38         SNMP_MIB_ITEM("SctpCurrEstab", SCTP_MIB_CURRESTAB),
  39         SNMP_MIB_ITEM("SctpActiveEstabs", SCTP_MIB_ACTIVEESTABS),
  40         SNMP_MIB_ITEM("SctpPassiveEstabs", SCTP_MIB_PASSIVEESTABS),
  41         SNMP_MIB_ITEM("SctpAborteds", SCTP_MIB_ABORTEDS),
  42         SNMP_MIB_ITEM("SctpShutdowns", SCTP_MIB_SHUTDOWNS),
  43         SNMP_MIB_ITEM("SctpOutOfBlues", SCTP_MIB_OUTOFBLUES),
  44         SNMP_MIB_ITEM("SctpChecksumErrors", SCTP_MIB_CHECKSUMERRORS),
  45         SNMP_MIB_ITEM("SctpOutCtrlChunks", SCTP_MIB_OUTCTRLCHUNKS),
  46         SNMP_MIB_ITEM("SctpOutOrderChunks", SCTP_MIB_OUTORDERCHUNKS),
  47         SNMP_MIB_ITEM("SctpOutUnorderChunks", SCTP_MIB_OUTUNORDERCHUNKS),
  48         SNMP_MIB_ITEM("SctpInCtrlChunks", SCTP_MIB_INCTRLCHUNKS),
  49         SNMP_MIB_ITEM("SctpInOrderChunks", SCTP_MIB_INORDERCHUNKS),
  50         SNMP_MIB_ITEM("SctpInUnorderChunks", SCTP_MIB_INUNORDERCHUNKS),
  51         SNMP_MIB_ITEM("SctpFragUsrMsgs", SCTP_MIB_FRAGUSRMSGS),
  52         SNMP_MIB_ITEM("SctpReasmUsrMsgs", SCTP_MIB_REASMUSRMSGS),
  53         SNMP_MIB_ITEM("SctpOutSCTPPacks", SCTP_MIB_OUTSCTPPACKS),
  54         SNMP_MIB_ITEM("SctpInSCTPPacks", SCTP_MIB_INSCTPPACKS),
  55         SNMP_MIB_ITEM("SctpT1InitExpireds", SCTP_MIB_T1_INIT_EXPIREDS),
  56         SNMP_MIB_ITEM("SctpT1CookieExpireds", SCTP_MIB_T1_COOKIE_EXPIREDS),
  57         SNMP_MIB_ITEM("SctpT2ShutdownExpireds", SCTP_MIB_T2_SHUTDOWN_EXPIREDS),
  58         SNMP_MIB_ITEM("SctpT3RtxExpireds", SCTP_MIB_T3_RTX_EXPIREDS),
  59         SNMP_MIB_ITEM("SctpT4RtoExpireds", SCTP_MIB_T4_RTO_EXPIREDS),
  60         SNMP_MIB_ITEM("SctpT5ShutdownGuardExpireds", SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS),
  61         SNMP_MIB_ITEM("SctpDelaySackExpireds", SCTP_MIB_DELAY_SACK_EXPIREDS),
  62         SNMP_MIB_ITEM("SctpAutocloseExpireds", SCTP_MIB_AUTOCLOSE_EXPIREDS),
  63         SNMP_MIB_ITEM("SctpT3Retransmits", SCTP_MIB_T3_RETRANSMITS),
  64         SNMP_MIB_ITEM("SctpPmtudRetransmits", SCTP_MIB_PMTUD_RETRANSMITS),
  65         SNMP_MIB_ITEM("SctpFastRetransmits", SCTP_MIB_FAST_RETRANSMITS),
  66         SNMP_MIB_ITEM("SctpInPktSoftirq", SCTP_MIB_IN_PKT_SOFTIRQ),
  67         SNMP_MIB_ITEM("SctpInPktBacklog", SCTP_MIB_IN_PKT_BACKLOG),
  68         SNMP_MIB_ITEM("SctpInPktDiscards", SCTP_MIB_IN_PKT_DISCARDS),
  69         SNMP_MIB_ITEM("SctpInDataChunkDiscards", SCTP_MIB_IN_DATA_CHUNK_DISCARDS),
  70         SNMP_MIB_SENTINEL
  71 };
  72
  73 /* Display sctp snmp mib statistics(/proc/net/sctp/snmp). */
  74 static int sctp_snmp_seq_show(struct seq_file *seq, void *v)
  75 {
  76         unsigned long buff[SCTP_MIB_MAX];
  77         struct net *net = seq->private;
  78         int i;
  79
  80         memset(buff, 0, sizeof(unsigned long) * SCTP_MIB_MAX);
  81
  82         snmp_get_cpu_field_batch(buff, sctp_snmp_list,
  83                                  net->sctp.sctp_statistics);
  84         for (i = 0; sctp_snmp_list[i].name; i++)
  85                 seq_printf(seq, "%-32s\t%ld\n", sctp_snmp_list[i].name,
  86                                                 buff[i]);
  87
  88         return 0;
  89 }
  90
  91 /* Dump local addresses of an association/endpoint. */
  92 static void sctp_seq_dump_local_addrs(struct seq_file *seq, struct sctp_ep_common *epb)
  93 {
  94         struct sctp_association *asoc;
  95         struct sctp_sockaddr_entry *laddr;
  96         struct sctp_transport *peer;
  97         union sctp_addr *addr, *primary = NULL;
  98         struct sctp_af *af;
  99
 100         if (epb->type == SCTP_EP_TYPE_ASSOCIATION) {
 101                 asoc = sctp_assoc(epb);
 102
 103                 peer = asoc->peer.primary_path;
 104                 if (unlikely(peer == NULL)) {
 105                         WARN(1, "Association %p with NULL primary path!\n", asoc);
 106                         return;
 107                 }
 108
 109                 primary = &peer->saddr;
 110         }
 111
 112         rcu_read_lock();
 113         list_for_each_entry_rcu(laddr, &epb->bind_addr.address_list, list) {
 114                 if (!laddr->valid)
 115                         continue;
 116
 117                 addr = &laddr->a;
 118                 af = sctp_get_af_specific(addr->sa.sa_family);
 119                 if (primary && af->cmp_addr(addr, primary)) {
 120                         seq_printf(seq, "*");
 121                 }
 122                 af->seq_dump_addr(seq, addr);
 123         }
 124         rcu_read_unlock();
 125 }
 126
 127 /* Dump remote addresses of an association. */
 128 static void sctp_seq_dump_remote_addrs(struct seq_file *seq, struct sctp_association *assoc)
 129 {
 130         struct sctp_transport *transport;
 131         union sctp_addr *addr, *primary;
 132         struct sctp_af *af;
 133
 134         primary = &assoc->peer.primary_addr;
 135         list_for_each_entry_rcu(transport, &assoc->peer.transport_addr_list,
 136                         transports) {
 137                 addr = &transport->ipaddr;
 138
 139                 af = sctp_get_af_specific(addr->sa.sa_family);
 140                 if (af->cmp_addr(addr, primary)) {
 141                         seq_printf(seq, "*");
 142                 }
 143                 af->seq_dump_addr(seq, addr);
 144         }
 145 }
 146
 147 static void *sctp_eps_seq_start(struct seq_file *seq, loff_t *pos)
 148 {
 149         if (*pos >= sctp_ep_hashsize)
 150                 return NULL;
 151
 152         if (*pos < 0)
 153                 *pos = 0;
 154
 155         if (*pos == 0)
 156                 seq_printf(seq, " ENDPT     SOCK   STY SST HBKT LPORT   UID INODE LADDRS\n");
 157
 158         return (void *)pos;
 159 }
 160
 161 static void sctp_eps_seq_stop(struct seq_file *seq, void *v)
 162 {
 163 }
 164
 165
 166 static void *sctp_eps_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 167 {
 168         if (++*pos >= sctp_ep_hashsize)
 169                 return NULL;
 170
 171         return pos;
 172 }
 173
 174
 175 /* Display sctp endpoints (/proc/net/sctp/eps). */
 176 static int sctp_eps_seq_show(struct seq_file *seq, void *v)
 177 {
 178         struct sctp_hashbucket *head;
 179         struct sctp_ep_common *epb;
 180         struct sctp_endpoint *ep;
 181         struct sock *sk;
 182         int    hash = *(loff_t *)v;
 183
 184         if (hash >= sctp_ep_hashsize)
 185                 return -ENOMEM;
 186
 187         head = &sctp_ep_hashtable[hash];
 188         read_lock_bh(&head->lock);
 189         sctp_for_each_hentry(epb, &head->chain) {
 190                 ep = sctp_ep(epb);
 191                 sk = epb->sk;
 192                 if (!net_eq(sock_net(sk), seq_file_net(seq)))
 193                         continue;
 194                 seq_printf(seq, "%8pK %8pK %-3d %-3d %-4d %-5d %5u %5lu ", ep, sk,
 195                            sctp_sk(sk)->type, sk->sk_state, hash,
 196                            epb->bind_addr.port,
 197                            from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
 198                            sock_i_ino(sk));
 199
 200                 sctp_seq_dump_local_addrs(seq, epb);
 201                 seq_printf(seq, "\n");
 202         }
 203         read_unlock_bh(&head->lock);
 204
 205         return 0;
 206 }
 207
 208 static const struct seq_operations sctp_eps_ops = {
 209         .start = sctp_eps_seq_start,
 210         .next  = sctp_eps_seq_next,
 211         .stop  = sctp_eps_seq_stop,
 212         .show  = sctp_eps_seq_show,
 213 };
 214
 215 struct sctp_ht_iter {
 216         struct seq_net_private p;
 217         struct rhashtable_iter hti;
 218 };
 219
 220 static void *sctp_transport_seq_start(struct seq_file *seq, loff_t *pos)
 221 {
 222         struct sctp_ht_iter *iter = seq->private;
 223
 224         sctp_transport_walk_start(&iter->hti);
 225
 226         return sctp_transport_get_idx(seq_file_net(seq), &iter->hti, *pos);
 227 }
 228
 229 static void sctp_transport_seq_stop(struct seq_file *seq, void *v)
 230 {
 231         struct sctp_ht_iter *iter = seq->private;
 232
 233         sctp_transport_walk_stop(&iter->hti);
 234 }
 235
 236 static void *sctp_transport_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 237 {
 238         struct sctp_ht_iter *iter = seq->private;
 239
 240         ++*pos;
 241
 242         return sctp_transport_get_next(seq_file_net(seq), &iter->hti);
 243 }
 244
 245 /* Display sctp associations (/proc/net/sctp/assocs). */
 246 static int sctp_assocs_seq_show(struct seq_file *seq, void *v)
 247 {
 248         struct sctp_transport *transport;
 249         struct sctp_association *assoc;
 250         struct sctp_ep_common *epb;
 251         struct sock *sk;
 252
 253         if (v == SEQ_START_TOKEN) {
 254                 seq_printf(seq, " ASSOC     SOCK   STY SST ST HBKT "
 255                                 "ASSOC-ID TX_QUEUE RX_QUEUE UID INODE LPORT "
 256                                 "RPORT LADDRS <-> RADDRS "
 257                                 "HBINT INS OUTS MAXRT T1X T2X RTXC "
 258                                 "wmema wmemq sndbuf rcvbuf\n");
 259                 return 0;
 260         }
 261
 262         transport = (struct sctp_transport *)v;
 263         assoc = transport->asoc;
 264         epb = &assoc->base;
 265         sk = epb->sk;
 266
 267         seq_printf(seq,
 268                    "%8pK %8pK %-3d %-3d %-2d %-4d "
 269                    "%4d %8d %8d %7u %5lu %-5d %5d ",
 270                    assoc, sk, sctp_sk(sk)->type, sk->sk_state,
 271                    assoc->state, 0,
 272                    assoc->assoc_id,
 273                    assoc->sndbuf_used,
 274                    atomic_read(&assoc->rmem_alloc),
 275                    from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
 276                    sock_i_ino(sk),
 277                    epb->bind_addr.port,
 278                    assoc->peer.port);
 279         seq_printf(seq, " ");
 280         sctp_seq_dump_local_addrs(seq, epb);
 281         seq_printf(seq, "<-> ");
 282         sctp_seq_dump_remote_addrs(seq, assoc);
 283         seq_printf(seq, "\t%8lu %5d %5d %4d %4d %4d %8d "
 284                    "%8d %8d %8d %8d",
 285                 assoc->hbinterval, assoc->stream.incnt,
 286                 assoc->stream.outcnt, assoc->max_retrans,
 287                 assoc->init_retries, assoc->shutdown_retries,
 288                 assoc->rtx_data_chunks,
 289                 refcount_read(&sk->sk_wmem_alloc),
 290                 sk->sk_wmem_queued,
 291                 sk->sk_sndbuf,
 292                 sk->sk_rcvbuf);
 293         seq_printf(seq, "\n");
 294
 295         sctp_transport_put(transport);
 296
 297         return 0;
 298 }
 299
 300 static const struct seq_operations sctp_assoc_ops = {
 301         .start = sctp_transport_seq_start,
 302         .next  = sctp_transport_seq_next,
 303         .stop  = sctp_transport_seq_stop,
 304         .show  = sctp_assocs_seq_show,
 305 };
 306
 307 static int sctp_remaddr_seq_show(struct seq_file *seq, void *v)
 308 {
 309         struct sctp_association *assoc;
 310         struct sctp_transport *transport, *tsp;
 311
 312         if (v == SEQ_START_TOKEN) {
 313                 seq_printf(seq, "ADDR ASSOC_ID HB_ACT RTO MAX_PATH_RTX "
 314                                 "REM_ADDR_RTX START STATE\n");
 315                 return 0;
 316         }
 317
 318         transport = (struct sctp_transport *)v;
 319         assoc = transport->asoc;
 320
 321         list_for_each_entry_rcu(tsp, &assoc->peer.transport_addr_list,
 322                                 transports) {
 323                 /*
 324                  * The remote address (ADDR)
 325                  */
 326                 tsp->af_specific->seq_dump_addr(seq, &tsp->ipaddr);
 327                 seq_printf(seq, " ");
 328                 /*
 329                  * The association ID (ASSOC_ID)
 330                  */
 331                 seq_printf(seq, "%d ", tsp->asoc->assoc_id);
 332
 333                 /*
 334                  * If the Heartbeat is active (HB_ACT)
 335                  * Note: 1 = Active, 0 = Inactive
 336                  */
 337                 seq_printf(seq, "%d ", timer_pending(&tsp->hb_timer));
 338
 339                 /*
 340                  * Retransmit time out (RTO)
 341                  */
 342                 seq_printf(seq, "%lu ", tsp->rto);
 343
 344                 /*
 345                  * Maximum path retransmit count (PATH_MAX_RTX)
 346                  */
 347                 seq_printf(seq, "%d ", tsp->pathmaxrxt);
 348
 349                 /*
 350                  * remote address retransmit count (REM_ADDR_RTX)
 351                  * Note: We don't have a way to tally this at the moment
 352                  * so lets just leave it as zero for the moment
 353                  */
 354                 seq_puts(seq, "0 ");
 355
 356                 /*
 357                  * remote address start time (START).  This is also not
 358                  * currently implemented, but we can record it with a
 359                  * jiffies marker in a subsequent patch
 360                  */
 361                 seq_puts(seq, "0 ");
 362
 363                 /*
 364                  * The current state of this destination. I.e.
 365                  * SCTP_ACTIVE, SCTP_INACTIVE, ...
 366                  */
 367                 seq_printf(seq, "%d", tsp->state);
 368
 369                 seq_printf(seq, "\n");
 370         }
 371
 372         sctp_transport_put(transport);
 373
 374         return 0;
 375 }
 376
 377 static const struct seq_operations sctp_remaddr_ops = {
 378         .start = sctp_transport_seq_start,
 379         .next  = sctp_transport_seq_next,
 380         .stop  = sctp_transport_seq_stop,
 381         .show  = sctp_remaddr_seq_show,
 382 };
 383
 384 /* Set up the proc fs entry for the SCTP protocol. */
 385 int __net_init sctp_proc_init(struct net *net)
 386 {
 387         net->sctp.proc_net_sctp = proc_net_mkdir(net, "sctp", net->proc_net);
 388         if (!net->sctp.proc_net_sctp)
 389                 return -ENOMEM;
 390         if (!proc_create_net_single("snmp", 0444, net->sctp.proc_net_sctp,
 391                          sctp_snmp_seq_show, NULL))
 392                 goto cleanup;
 393         if (!proc_create_net("eps", 0444, net->sctp.proc_net_sctp,
 394                         &sctp_eps_ops, sizeof(struct seq_net_private)))
 395                 goto cleanup;
 396         if (!proc_create_net("assocs", 0444, net->sctp.proc_net_sctp,
 397                         &sctp_assoc_ops, sizeof(struct sctp_ht_iter)))
 398                 goto cleanup;
 399         if (!proc_create_net("remaddr", 0444, net->sctp.proc_net_sctp,
 400                         &sctp_remaddr_ops, sizeof(struct sctp_ht_iter)))
 401                 goto cleanup;
 402         return 0;
 403
 404 cleanup:
 405         remove_proc_subtree("sctp", net->proc_net);
 406         net->sctp.proc_net_sctp = NULL;
 407         return -ENOMEM;
 408 }