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