src/log/ModTcp.cc

   1 /*
   2  * DEBUG: section 50    Log file handling
   3  * AUTHOR: Dhaval Varia
   4  * Developed based on ModUdp.* by Adrian Chadd
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #include "squid.h"
  35 #include "comm.h"
  36 #include "comm/Connection.h"
  37 #include "log/File.h"
  38 #include "log/ModTcp.h"
  39 #include "Parsing.h"
  40
  41 /*
  42  * This logfile TCP module is mostly inspired by a patch by Tim Starling
  43  * from Wikimedia.
  44  *
  45  * It doesn't do any TCP buffering - it'd be quite a bit of work for
  46  * something which the kernel could be doing for you!
  47  */
  48
  49 typedef struct {
  50     int fd;
  51     char *buf;
  52     size_t bufsz;
  53     int offset;
  54 } l_tcp_t;
  55
  56 static void
  57 logfile_mod_tcp_write(Logfile * lf, const char *buf, size_t len)
  58 {
  59     l_tcp_t *ll = (l_tcp_t *) lf->data;
  60     ssize_t s;
  61     s = write(ll->fd, (char const *) buf, len);
  62
  63     fd_bytes(ll->fd, s, FD_WRITE);
  64 #if 0
  65     if (s < 0) {
  66         debugs(1, 1, "logfile (tcp): got errno (" << errno << "):" << xstrerror());
  67     }
  68     if (s != len) {
  69         debugs(1, 1, "logfile (tcp): len=" << len << ", wrote=" << s);
  70     }
  71 #endif
  72
  73     /* We don't worry about network errors for now */
  74 }
  75
  76 static void
  77 logfile_mod_tcp_flush(Logfile * lf)
  78 {
  79     l_tcp_t *ll = (l_tcp_t *) lf->data;
  80     if (0 == ll->offset)
  81         return;
  82     logfile_mod_tcp_write(lf, ll->buf, (size_t) ll->offset);
  83     ll->offset = 0;
  84 }
  85
  86 static void
  87 logfile_mod_tcp_writeline(Logfile * lf, const char *buf, size_t len)
  88 {
  89     l_tcp_t *ll = (l_tcp_t *) lf->data;
  90
  91     if (0 == ll->bufsz) {
  92         /* buffering disabled */
  93         logfile_mod_tcp_write(lf, buf, len);
  94         return;
  95     }
  96     if (ll->offset > 0 && (ll->offset + len + 4) > ll->bufsz)
  97         logfile_mod_tcp_flush(lf);
  98
  99     if (len > ll->bufsz) {
 100         /* too big to fit in buffer */
 101         logfile_mod_tcp_write(lf, buf, len);
 102         return;
 103     }
 104     /* buffer it */
 105     xmemcpy(ll->buf + ll->offset, buf, len);
 106
 107     ll->offset += len;
 108
 109     assert(ll->offset >= 0);
 110
 111     assert((size_t) ll->offset <= ll->bufsz);
 112 }
 113
 114 static void
 115 logfile_mod_tcp_linestart(Logfile * lf)
 116 {
 117 }
 118
 119 static void
 120 logfile_mod_tcp_lineend(Logfile * lf)
 121 {
 122 }
 123
 124 static void
 125 logfile_mod_tcp_rotate(Logfile * lf)
 126 {
 127     return;
 128 }
 129
 130 static void
 131 logfile_mod_tcp_close(Logfile * lf)
 132 {
 133     l_tcp_t *ll = (l_tcp_t *) lf->data;
 134     lf->f_flush(lf);
 135
 136     if (ll->fd >= 0)
 137         file_close(ll->fd);
 138
 139     if (ll->buf)
 140         xfree(ll->buf);
 141
 142     xfree(lf->data);
 143     lf->data = NULL;
 144 }
 145
 146
 147
 148 /*
 149  * This code expects the path to be //host:port
 150  */
 151 int
 152 logfile_mod_tcp_open(Logfile * lf, const char *path, size_t bufsz, int fatal_flag)
 153 {
 154     debugs(5, 3, "Tcp Open called");
 155     Ip::Address addr;
 156
 157     char *strAddr;
 158
 159     lf->f_close = logfile_mod_tcp_close;
 160     lf->f_linewrite = logfile_mod_tcp_writeline;
 161     lf->f_linestart = logfile_mod_tcp_linestart;
 162     lf->f_lineend = logfile_mod_tcp_lineend;
 163     lf->f_flush = logfile_mod_tcp_flush;
 164     lf->f_rotate = logfile_mod_tcp_rotate;
 165
 166     l_tcp_t *ll = static_cast<l_tcp_t*>(xcalloc(1, sizeof(*ll)));
 167     lf->data = ll;
 168
 169     if (strncmp(path, "//", 2) == 0) {
 170         path += 2;
 171     }
 172     strAddr = xstrdup(path);
 173
 174     if (!GetHostWithPort(strAddr, &addr)) {
 175         if (lf->flags.fatal) {
 176             fatalf("Invalid TCP logging address '%s'\n", lf->path);
 177         } else {
 178             debugs(50, DBG_IMPORTANT, "Invalid TCP logging address '" << lf->path << "'");
 179             safe_free(strAddr);
 180             return FALSE;
 181         }
 182     }
 183
 184     safe_free(strAddr);
 185
 186     Ip::Address any_addr;
 187     any_addr.SetAnyAddr();
 188
 189 #if USE_IPV6
 190     // require the sending TCP port to be of the right family for the destination address.
 191     if (addr.IsIPv4())
 192         any_addr.SetIPv4();
 193 #endif
 194
 195     ll->fd = comm_open(SOCK_STREAM, IPPROTO_TCP, any_addr, COMM_NONBLOCKING, "TCP log socket");
 196     if (ll->fd < 0) {
 197         if (lf->flags.fatal) {
 198             fatalf("Unable to open TCP socket for logging\n");
 199         } else {
 200             debugs(50, DBG_IMPORTANT, "Unable to open TCP socket for logging");
 201             return FALSE;
 202         }
 203     } else if (!comm_connect_addr(ll->fd, &addr)) {
 204         if (lf->flags.fatal) {
 205             fatalf("Unable to connect to %s for TCP log: %s\n", lf->path, xstrerror());
 206         } else {
 207             debugs(50, DBG_IMPORTANT, "Unable to connect to " << lf->path << " for TCP log: " << xstrerror());
 208             return FALSE;
 209         }
 210     }
 211     if (ll->fd == -1) {
 212         if (ENOENT == errno && fatal_flag) {
 213             fatalf("Cannot open '%s' because\n"
 214                    "\tthe parent directory does not exist.\n"
 215                    "\tPlease create the directory.\n", path);
 216         } else if (EACCES == errno && fatal_flag) {
 217             fatalf("Cannot open '%s' for writing.\n"
 218                    "\tThe parent directory must be writeable by the\n"
 219                    "\tuser '%s', which is the cache_effective_user\n"
 220                    "\tset in squid.conf.", path, Config.effectiveUser);
 221         } else {
 222             debugs(50, DBG_IMPORTANT, "logfileOpen (TCP): " << lf->path << ": " << xstrerror());
 223             return 0;
 224         }
 225     }
 226
 227     bufsz = 65536;
 228     if (bufsz > 0) {
 229         ll->buf = static_cast<char*>(xmalloc(bufsz));
 230         ll->bufsz = bufsz;
 231     }
 232
 233     return 1;
 234 }