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