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 /* Initialize the seq file operations for 'snmp' object. */
  92 static int sctp_snmp_seq_open(struct inode *inode, struct file *file)
  93 {
  94         return single_open_net(inode, file, sctp_snmp_seq_show);
  95 }
  96
  97 static const struct file_operations sctp_snmp_seq_fops = {
  98         .open    = sctp_snmp_seq_open,
  99         .read    = seq_read,
 100         .llseek  = seq_lseek,
 101         .release = single_release_net,
 102 };
 103
 104 /* Dump local addresses of an association/endpoint. */
 105 static void sctp_seq_dump_local_addrs(struct seq_file *seq, struct sctp_ep_common *epb)
 106 {
 107         struct sctp_association *asoc;
 108         struct sctp_sockaddr_entry *laddr;
 109         struct sctp_transport *peer;
 110         union sctp_addr *addr, *primary = NULL;
 111         struct sctp_af *af;
 112
 113         if (epb->type == SCTP_EP_TYPE_ASSOCIATION) {
 114                 asoc = sctp_assoc(epb);
 115
 116                 peer = asoc->peer.primary_path;
 117                 if (unlikely(peer == NULL)) {
 118                         WARN(1, "Association %p with NULL primary path!\n", asoc);
 119                         return;
 120                 }
 121
 122                 primary = &peer->saddr;
 123         }
 124
 125         rcu_read_lock();
 126         list_for_each_entry_rcu(laddr, &epb->bind_addr.address_list, list) {
 127                 if (!laddr->valid)
 128                         continue;
 129
 130                 addr = &laddr->a;
 131                 af = sctp_get_af_specific(addr->sa.sa_family);
 132                 if (primary && af->cmp_addr(addr, primary)) {
 133                         seq_printf(seq, "*");
 134                 }
 135                 af->seq_dump_addr(seq, addr);
 136         }
 137         rcu_read_unlock();
 138 }
 139
 140 /* Dump remote addresses of an association. */
 141 static void sctp_seq_dump_remote_addrs(struct seq_file *seq, struct sctp_association *assoc)
 142 {
 143         struct sctp_transport *transport;
 144         union sctp_addr *addr, *primary;
 145         struct sctp_af *af;
 146
 147         primary = &assoc->peer.primary_addr;
 148         list_for_each_entry_rcu(transport, &assoc->peer.transport_addr_list,
 149                         transports) {
 150                 addr = &transport->ipaddr;
 151
 152                 af = sctp_get_af_specific(addr->sa.sa_family);
 153                 if (af->cmp_addr(addr, primary)) {
 154                         seq_printf(seq, "*");
 155                 }
 156                 af->seq_dump_addr(seq, addr);
 157         }
 158 }
 159
 160 static void *sctp_eps_seq_start(struct seq_file *seq, loff_t *pos)
 161 {
 162         if (*pos >= sctp_ep_hashsize)
 163                 return NULL;
 164
 165         if (*pos < 0)
 166                 *pos = 0;
 167
 168         if (*pos == 0)
 169                 seq_printf(seq, " ENDPT     SOCK   STY SST HBKT LPORT   UID INODE LADDRS\n");
 170
 171         return (void *)pos;
 172 }
 173
 174 static void sctp_eps_seq_stop(struct seq_file *seq, void *v)
 175 {
 176 }
 177
 178
 179 static void *sctp_eps_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 180 {
 181         if (++*pos >= sctp_ep_hashsize)
 182                 return NULL;
 183
 184         return pos;
 185 }
 186
 187
 188 /* Display sctp endpoints (/proc/net/sctp/eps). */
 189 static int sctp_eps_seq_show(struct seq_file *seq, void *v)
 190 {
 191         struct sctp_hashbucket *head;
 192         struct sctp_ep_common *epb;
 193         struct sctp_endpoint *ep;
 194         struct sock *sk;
 195         int    hash = *(loff_t *)v;
 196
 197         if (hash >= sctp_ep_hashsize)
 198                 return -ENOMEM;
 199
 200         head = &sctp_ep_hashtable[hash];
 201         read_lock_bh(&head->lock);
 202         sctp_for_each_hentry(epb, &head->chain) {
 203                 ep = sctp_ep(epb);
 204                 sk = epb->sk;
 205                 if (!net_eq(sock_net(sk), seq_file_net(seq)))
 206                         continue;
 207                 seq_printf(seq, "%8pK %8pK %-3d %-3d %-4d %-5d %5u %5lu ", ep, sk,
 208                            sctp_sk(sk)->type, sk->sk_state, hash,
 209                            epb->bind_addr.port,
 210                            from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
 211                            sock_i_ino(sk));
 212
 213                 sctp_seq_dump_local_addrs(seq, epb);
 214                 seq_printf(seq, "\n");
 215         }
 216         read_unlock_bh(&head->lock);
 217
 218         return 0;
 219 }
 220
 221 static const struct seq_operations sctp_eps_ops = {
 222         .start = sctp_eps_seq_start,
 223         .next  = sctp_eps_seq_next,
 224         .stop  = sctp_eps_seq_stop,
 225         .show  = sctp_eps_seq_show,
 226 };
 227
 228
 229 /* Initialize the seq file operations for 'eps' object. */
 230 static int sctp_eps_seq_open(struct inode *inode, struct file *file)
 231 {
 232         return seq_open_net(inode, file, &sctp_eps_ops,
 233                             sizeof(struct seq_net_private));
 234 }
 235
 236 static const struct file_operations sctp_eps_seq_fops = {
 237         .open    = sctp_eps_seq_open,
 238         .read    = seq_read,
 239         .llseek  = seq_lseek,
 240         .release = seq_release_net,
 241 };
 242
 243 struct sctp_ht_iter {
 244         struct seq_net_private p;
 245         struct rhashtable_iter hti;
 246         int start_fail;
 247 };
 248
 249 static void *sctp_transport_seq_start(struct seq_file *seq, loff_t *pos)
 250 {
 251         struct sctp_ht_iter *iter = seq->private;
 252
 253         sctp_transport_walk_start(&iter->hti);
 254
 255         iter->start_fail = 0;
 256         return sctp_transport_get_idx(seq_file_net(seq), &iter->hti, *pos);
 257 }
 258
 259 static void sctp_transport_seq_stop(struct seq_file *seq, void *v)
 260 {
 261         struct sctp_ht_iter *iter = seq->private;
 262
 263         if (iter->start_fail)
 264                 return;
 265         sctp_transport_walk_stop(&iter->hti);
 266 }
 267
 268 static void *sctp_transport_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 269 {
 270         struct sctp_ht_iter *iter = seq->private;
 271
 272         ++*pos;
 273
 274         return sctp_transport_get_next(seq_file_net(seq), &iter->hti);
 275 }
 276
 277 /* Display sctp associations (/proc/net/sctp/assocs). */
 278 static int sctp_assocs_seq_show(struct seq_file *seq, void *v)
 279 {
 280         struct sctp_transport *transport;
 281         struct sctp_association *assoc;
 282         struct sctp_ep_common *epb;
 283         struct sock *sk;
 284
 285         if (v == SEQ_START_TOKEN) {
 286                 seq_printf(seq, " ASSOC     SOCK   STY SST ST HBKT "
 287                                 "ASSOC-ID TX_QUEUE RX_QUEUE UID INODE LPORT "
 288                                 "RPORT LADDRS <-> RADDRS "
 289                                 "HBINT INS OUTS MAXRT T1X T2X RTXC "
 290                                 "wmema wmemq sndbuf rcvbuf\n");
 291                 return 0;
 292         }
 293
 294         transport = (struct sctp_transport *)v;
 295         if (!sctp_transport_hold(transport))
 296                 return 0;
 297         assoc = transport->asoc;
 298         epb = &assoc->base;
 299         sk = epb->sk;
 300
 301         seq_printf(seq,
 302                    "%8pK %8pK %-3d %-3d %-2d %-4d "
 303                    "%4d %8d %8d %7u %5lu %-5d %5d ",
 304                    assoc, sk, sctp_sk(sk)->type, sk->sk_state,
 305                    assoc->state, 0,
 306                    assoc->assoc_id,
 307                    assoc->sndbuf_used,
 308                    atomic_read(&assoc->rmem_alloc),
 309                    from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
 310                    sock_i_ino(sk),
 311                    epb->bind_addr.port,
 312                    assoc->peer.port);
 313         seq_printf(seq, " ");
 314         sctp_seq_dump_local_addrs(seq, epb);
 315         seq_printf(seq, "<-> ");
 316         sctp_seq_dump_remote_addrs(seq, assoc);
 317         seq_printf(seq, "\t%8lu %5d %5d %4d %4d %4d %8d "
 318                    "%8d %8d %8d %8d",
 319                 assoc->hbinterval, assoc->stream.incnt,
 320                 assoc->stream.outcnt, assoc->max_retrans,
 321                 assoc->init_retries, assoc->shutdown_retries,
 322                 assoc->rtx_data_chunks,
 323                 refcount_read(&sk->sk_wmem_alloc),
 324                 sk->sk_wmem_queued,
 325                 sk->sk_sndbuf,
 326                 sk->sk_rcvbuf);
 327         seq_printf(seq, "\n");
 328
 329         sctp_transport_put(transport);
 330
 331         return 0;
 332 }
 333
 334 static const struct seq_operations sctp_assoc_ops = {
 335         .start = sctp_transport_seq_start,
 336         .next  = sctp_transport_seq_next,
 337         .stop  = sctp_transport_seq_stop,
 338         .show  = sctp_assocs_seq_show,
 339 };
 340
 341 /* Initialize the seq file operations for 'assocs' object. */
 342 static int sctp_assocs_seq_open(struct inode *inode, struct file *file)
 343 {
 344         return seq_open_net(inode, file, &sctp_assoc_ops,
 345                             sizeof(struct sctp_ht_iter));
 346 }
 347
 348 static const struct file_operations sctp_assocs_seq_fops = {
 349         .open    = sctp_assocs_seq_open,
 350         .read    = seq_read,
 351         .llseek  = seq_lseek,
 352         .release = seq_release_net,
 353 };
 354
 355 static int sctp_remaddr_seq_show(struct seq_file *seq, void *v)
 356 {
 357         struct sctp_association *assoc;
 358         struct sctp_transport *transport, *tsp;
 359
 360         if (v == SEQ_START_TOKEN) {
 361                 seq_printf(seq, "ADDR ASSOC_ID HB_ACT RTO MAX_PATH_RTX "
 362                                 "REM_ADDR_RTX START STATE\n");
 363                 return 0;
 364         }
 365
 366         transport = (struct sctp_transport *)v;
 367         if (!sctp_transport_hold(transport))
 368                 return 0;
 369         assoc = transport->asoc;
 370
 371         list_for_each_entry_rcu(tsp, &assoc->peer.transport_addr_list,
 372                                 transports) {
 373                 /*
 374                  * The remote address (ADDR)
 375                  */
 376                 tsp->af_specific->seq_dump_addr(seq, &tsp->ipaddr);
 377                 seq_printf(seq, " ");
 378                 /*
 379                  * The association ID (ASSOC_ID)
 380                  */
 381                 seq_printf(seq, "%d ", tsp->asoc->assoc_id);
 382
 383                 /*
 384                  * If the Heartbeat is active (HB_ACT)
 385                  * Note: 1 = Active, 0 = Inactive
 386                  */
 387                 seq_printf(seq, "%d ", timer_pending(&tsp->hb_timer));
 388
 389                 /*
 390                  * Retransmit time out (RTO)
 391                  */
 392                 seq_printf(seq, "%lu ", tsp->rto);
 393
 394                 /*
 395                  * Maximum path retransmit count (PATH_MAX_RTX)
 396                  */
 397                 seq_printf(seq, "%d ", tsp->pathmaxrxt);
 398
 399                 /*
 400                  * remote address retransmit count (REM_ADDR_RTX)
 401                  * Note: We don't have a way to tally this at the moment
 402                  * so lets just leave it as zero for the moment
 403                  */
 404                 seq_puts(seq, "0 ");
 405
 406                 /*
 407                  * remote address start time (START).  This is also not
 408                  * currently implemented, but we can record it with a
 409                  * jiffies marker in a subsequent patch
 410                  */
 411                 seq_puts(seq, "0 ");
 412
 413                 /*
 414                  * The current state of this destination. I.e.
 415                  * SCTP_ACTIVE, SCTP_INACTIVE, ...
 416                  */
 417                 seq_printf(seq, "%d", tsp->state);
 418
 419                 seq_printf(seq, "\n");
 420         }
 421
 422         sctp_transport_put(transport);
 423
 424         return 0;
 425 }
 426
 427 static const struct seq_operations sctp_remaddr_ops = {
 428         .start = sctp_transport_seq_start,
 429         .next  = sctp_transport_seq_next,
 430         .stop  = sctp_transport_seq_stop,
 431         .show  = sctp_remaddr_seq_show,
 432 };
 433
 434 static int sctp_remaddr_seq_open(struct inode *inode, struct file *file)
 435 {
 436         return seq_open_net(inode, file, &sctp_remaddr_ops,
 437                             sizeof(struct sctp_ht_iter));
 438 }
 439
 440 static const struct file_operations sctp_remaddr_seq_fops = {
 441         .open = sctp_remaddr_seq_open,
 442         .read = seq_read,
 443         .llseek = seq_lseek,
 444         .release = seq_release_net,
 445 };
 446
 447 /* Set up the proc fs entry for the SCTP protocol. */
 448 int __net_init sctp_proc_init(struct net *net)
 449 {
 450         net->sctp.proc_net_sctp = proc_net_mkdir(net, "sctp", net->proc_net);
 451         if (!net->sctp.proc_net_sctp)
 452                 return -ENOMEM;
 453         if (!proc_create("snmp", 0444, net->sctp.proc_net_sctp,
 454                          &sctp_snmp_seq_fops))
 455                 goto cleanup;
 456         if (!proc_create("eps", 0444, net->sctp.proc_net_sctp,
 457                          &sctp_eps_seq_fops))
 458                 goto cleanup;
 459         if (!proc_create("assocs", 0444, net->sctp.proc_net_sctp,
 460                          &sctp_assocs_seq_fops))
 461                 goto cleanup;
 462         if (!proc_create("remaddr", 0444, net->sctp.proc_net_sctp,
 463                          &sctp_remaddr_seq_fops))
 464                 goto cleanup;
 465         return 0;
 466
 467 cleanup:
 468         remove_proc_subtree("sctp", net->proc_net);
 469         net->sctp.proc_net_sctp = NULL;
 470         return -ENOMEM;
 471 }