net/tipc/log.c

   1 /*
   2  * net/tipc/log.c: TIPC print buffer routines for debugging
   3  *
   4  * Copyright (c) 1996-2006, Ericsson AB
   5  * Copyright (c) 2005-2007, Wind River Systems
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the names of the copyright holders nor the names of its
  17  *    contributors may be used to endorse or promote products derived from
  18  *    this software without specific prior written permission.
  19  *
  20  * Alternatively, this software may be distributed under the terms of the
  21  * GNU General Public License ("GPL") version 2 as published by the Free
  22  * Software Foundation.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "core.h"
  38 #include "config.h"
  39 #include "log.h"
  40
  41 /*
  42  * TIPC pre-defines the following print buffers:
  43  *
  44  * TIPC_NULL : null buffer (i.e. print nowhere)
  45  * TIPC_CONS : system console
  46  * TIPC_LOG  : TIPC log buffer
  47  *
  48  * Additional user-defined print buffers are also permitted.
  49  */
  50 static struct print_buf null_buf = { NULL, 0, NULL, 0 };
  51 struct print_buf *const TIPC_NULL = &null_buf;
  52
  53 static struct print_buf cons_buf = { NULL, 0, NULL, 1 };
  54 struct print_buf *const TIPC_CONS = &cons_buf;
  55
  56 static struct print_buf log_buf = { NULL, 0, NULL, 1 };
  57 struct print_buf *const TIPC_LOG = &log_buf;
  58
  59 /*
  60  * Locking policy when using print buffers.
  61  *
  62  * 1) tipc_printf() uses 'print_lock' to protect against concurrent access to
  63  * 'print_string' when writing to a print buffer. This also protects against
  64  * concurrent writes to the print buffer being written to.
  65  *
  66  * 2) tipc_log_XXX() leverages the aforementioned use of 'print_lock' to
  67  * protect against all types of concurrent operations on their associated
  68  * print buffer (not just write operations).
  69  *
  70  * Note: All routines of the form tipc_printbuf_XXX() are lock-free, and rely
  71  * on the caller to prevent simultaneous use of the print buffer(s) being
  72  * manipulated.
  73  */
  74 static DEFINE_SPINLOCK(print_lock);
  75
  76 static void tipc_printbuf_move(struct print_buf *pb_to,
  77                                struct print_buf *pb_from);
  78
  79 /**
  80  * tipc_printbuf_init - initialize print buffer to empty
  81  * @pb: pointer to print buffer structure
  82  * @raw: pointer to character array used by print buffer
  83  * @size: size of character array
  84  *
  85  * Note: If the character array is too small (or absent), the print buffer
  86  * becomes a null device that discards anything written to it.
  87  */
  88 void tipc_printbuf_init(struct print_buf *pb, char *raw, u32 size)
  89 {
  90         pb->buf = raw;
  91         pb->crs = raw;
  92         pb->size = size;
  93         pb->echo = 0;
  94
  95         if (size < TIPC_PB_MIN_SIZE) {
  96                 pb->buf = NULL;
  97         } else if (raw) {
  98                 pb->buf[0] = 0;
  99                 pb->buf[size - 1] = ~0;
 100         }
 101 }
 102
 103 /**
 104  * tipc_printbuf_reset - reinitialize print buffer to empty state
 105  * @pb: pointer to print buffer structure
 106  */
 107 static void tipc_printbuf_reset(struct print_buf *pb)
 108 {
 109         if (pb->buf) {
 110                 pb->crs = pb->buf;
 111                 pb->buf[0] = 0;
 112                 pb->buf[pb->size - 1] = ~0;
 113         }
 114 }
 115
 116 /**
 117  * tipc_printbuf_empty - test if print buffer is in empty state
 118  * @pb: pointer to print buffer structure
 119  *
 120  * Returns non-zero if print buffer is empty.
 121  */
 122 static int tipc_printbuf_empty(struct print_buf *pb)
 123 {
 124         return !pb->buf || (pb->crs == pb->buf);
 125 }
 126
 127 /**
 128  * tipc_printbuf_move - move print buffer contents to another print buffer
 129  * @pb_to: pointer to destination print buffer structure
 130  * @pb_from: pointer to source print buffer structure
 131  *
 132  * Current contents of destination print buffer (if any) are discarded.
 133  * Source print buffer becomes empty if a successful move occurs.
 134  */
 135 static void tipc_printbuf_move(struct print_buf *pb_to,
 136                                struct print_buf *pb_from)
 137 {
 138         int len;
 139
 140         /* Handle the cases where contents can't be moved */
 141         if (!pb_to->buf)
 142                 return;
 143
 144         if (!pb_from->buf) {
 145                 tipc_printbuf_reset(pb_to);
 146                 return;
 147         }
 148
 149         if (pb_to->size < pb_from->size) {
 150                 strcpy(pb_to->buf, "*** PRINT BUFFER MOVE ERROR ***");
 151                 pb_to->buf[pb_to->size - 1] = ~0;
 152                 pb_to->crs = strchr(pb_to->buf, 0);
 153                 return;
 154         }
 155
 156         /* Copy data from char after cursor to end (if used) */
 157         len = pb_from->buf + pb_from->size - pb_from->crs - 2;
 158         if ((pb_from->buf[pb_from->size - 1] == 0) && (len > 0)) {
 159                 strcpy(pb_to->buf, pb_from->crs + 1);
 160                 pb_to->crs = pb_to->buf + len;
 161         } else
 162                 pb_to->crs = pb_to->buf;
 163
 164         /* Copy data from start to cursor (always) */
 165         len = pb_from->crs - pb_from->buf;
 166         strcpy(pb_to->crs, pb_from->buf);
 167         pb_to->crs += len;
 168
 169         tipc_printbuf_reset(pb_from);
 170 }
 171
 172 /**
 173  * tipc_snprintf - append formatted output to print buffer
 174  * @buf: pointer to print buffer
 175  * @len: buffer length
 176  * @fmt: formatted info to be printed
 177  */
 178 int tipc_snprintf(char *buf, int len, const char *fmt, ...)
 179 {
 180         int i;
 181         va_list args;
 182
 183         va_start(args, fmt);
 184         i = vscnprintf(buf, len, fmt, args);
 185         va_end(args);
 186         return i;
 187 }
 188
 189 /**
 190  * tipc_log_resize - change the size of the TIPC log buffer
 191  * @log_size: print buffer size to use
 192  */
 193 int tipc_log_resize(int log_size)
 194 {
 195         int res = 0;
 196
 197         spin_lock_bh(&print_lock);
 198         kfree(TIPC_LOG->buf);
 199         TIPC_LOG->buf = NULL;
 200         if (log_size) {
 201                 if (log_size < TIPC_PB_MIN_SIZE)
 202                         log_size = TIPC_PB_MIN_SIZE;
 203                 res = TIPC_LOG->echo;
 204                 tipc_printbuf_init(TIPC_LOG, kmalloc(log_size, GFP_ATOMIC),
 205                                    log_size);
 206                 TIPC_LOG->echo = res;
 207                 res = !TIPC_LOG->buf;
 208         }
 209         spin_unlock_bh(&print_lock);
 210
 211         return res;
 212 }
 213
 214 /**
 215  * tipc_log_resize_cmd - reconfigure size of TIPC log buffer
 216  */
 217 struct sk_buff *tipc_log_resize_cmd(const void *req_tlv_area, int req_tlv_space)
 218 {
 219         u32 value;
 220
 221         if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
 222                 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
 223
 224         value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
 225         if (value > 32768)
 226                 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
 227                                                    " (log size must be 0-32768)");
 228         if (tipc_log_resize(value))
 229                 return tipc_cfg_reply_error_string(
 230                         "unable to create specified log (log size is now 0)");
 231         return tipc_cfg_reply_none();
 232 }
 233
 234 /**
 235  * tipc_log_dump - capture TIPC log buffer contents in configuration message
 236  */
 237 struct sk_buff *tipc_log_dump(void)
 238 {
 239         struct sk_buff *reply;
 240
 241         spin_lock_bh(&print_lock);
 242         if (!TIPC_LOG->buf) {
 243                 spin_unlock_bh(&print_lock);
 244                 reply = tipc_cfg_reply_ultra_string("log not activated\n");
 245         } else if (tipc_printbuf_empty(TIPC_LOG)) {
 246                 spin_unlock_bh(&print_lock);
 247                 reply = tipc_cfg_reply_ultra_string("log is empty\n");
 248         } else {
 249                 struct tlv_desc *rep_tlv;
 250                 struct print_buf pb;
 251                 int str_len;
 252
 253                 str_len = min(TIPC_LOG->size, 32768u);
 254                 spin_unlock_bh(&print_lock);
 255                 reply = tipc_cfg_reply_alloc(TLV_SPACE(str_len));
 256                 if (reply) {
 257                         rep_tlv = (struct tlv_desc *)reply->data;
 258                         tipc_printbuf_init(&pb, TLV_DATA(rep_tlv), str_len);
 259                         spin_lock_bh(&print_lock);
 260                         tipc_printbuf_move(&pb, TIPC_LOG);
 261                         spin_unlock_bh(&print_lock);
 262                         str_len = strlen(TLV_DATA(rep_tlv)) + 1;
 263                         skb_put(reply, TLV_SPACE(str_len));
 264                         TLV_SET(rep_tlv, TIPC_TLV_ULTRA_STRING, NULL, str_len);
 265                 }
 266         }
 267         return reply;
 268 }