io_fetch.cc 16.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#include <config.h>

#include <unistd.h>             // for some IPC/network system calls
#include <sys/socket.h>
#include <netinet/in.h>

#include <boost/bind.hpp>
22
#include <boost/scoped_ptr.hpp>
23
#include <boost/date_time/posix_time/posix_time_types.hpp>
24 25 26 27 28

#include <dns/message.h>
#include <dns/messagerenderer.h>
#include <dns/opcode.h>
#include <dns/rcode.h>
29
#include <log/logger.h>
30

31 32
#include <asiolink/qid_gen.h>

Stephen Morris's avatar
Stephen Morris committed
33
#include <asio.hpp>
34 35
#include <asio/deadline_timer.hpp>

36 37
#include <asiolink/asiodef.h>
#include <asiolink/io_address.h>
38
#include <asiolink/io_asio_socket.h>
39
#include <asiolink/io_endpoint.h>
Stephen Morris's avatar
Stephen Morris committed
40
#include <asiolink/io_fetch.h>
41 42 43 44 45
#include <asiolink/io_service.h>
#include <asiolink/tcp_endpoint.h>
#include <asiolink/tcp_socket.h>
#include <asiolink/udp_endpoint.h>
#include <asiolink/udp_socket.h>
46 47 48
#include <asiolink/qid_gen.h>

#include <stdint.h>
49 50 51

using namespace asio;
using namespace isc::dns;
Stephen Morris's avatar
Stephen Morris committed
52 53
using namespace isc::log;
using namespace std;
54 55 56

namespace asiolink {

57 58
/// Use the ASIO logger

59
isc::log::Logger logger("asiolink");
60

61 62
/// \brief IOFetch Data
///
63 64 65 66 67
/// The data for IOFetch is held in a separate struct pointed to by a shared_ptr
/// object.  This is because the IOFetch object will be copied often (it is used
/// as a coroutine and passed as callback to many async_*() functions) and we
/// want keep the same data).  Organising the data in this way keeps copying to
/// a minimum.
68 69 70 71 72
struct IOFetchData {

    // The first two members are shared pointers to a base class because what is
    // actually instantiated depends on whether the fetch is over UDP or TCP,
    // which is not known until construction of the IOFetch.  Use of a shared
73
    // pointer here is merely to ensure deletion when the data object is deleted.
74
    boost::scoped_ptr<IOAsioSocket<IOFetch> > socket;
75 76 77 78 79 80 81 82 83 84 85 86 87 88
                                             ///< Socket to use for I/O
    boost::scoped_ptr<IOEndpoint> remote_snd;///< Where the fetch is sent
    boost::scoped_ptr<IOEndpoint> remote_rcv;///< Where the response came from
    isc::dns::Question          question;    ///< Question to be asked
    isc::dns::OutputBufferPtr   msgbuf;      ///< Wire buffer for question
    isc::dns::OutputBufferPtr   received;    ///< Received data put here
    IOFetch::Callback*          callback;    ///< Called on I/O Completion
    asio::deadline_timer        timer;       ///< Timer to measure timeouts
    IOFetch::Protocol           protocol;    ///< Protocol being used
    size_t                      cumulative;  ///< Cumulative received amount
    size_t                      expected;    ///< Expected amount of data
    size_t                      offset;      ///< Offset to receive data
    bool                        stopped;     ///< Have we stopped running?
    int                         timeout;     ///< Timeout in ms
Stephen Morris's avatar
Stephen Morris committed
89
    bool                        packet;      ///< true if packet was supplied
90 91 92 93 94 95 96

    // In case we need to log an error, the origin of the last asynchronous
    // I/O is recorded.  To save time and simplify the code, this is recorded
    // as the ID of the error message that would be generated if the I/O failed.
    // This means that we must make sure that all possible "origins" take the
    // same arguments in their message in the same order.
    isc::log::MessageID         origin;     ///< Origin of last asynchronous I/O
97 98
    uint8_t                     staging[IOFetch::STAGING_LENGTH];
                                            ///< Temporary array for received data
99
    isc::dns::qid_t             qid;         ///< The QID set in the query
100 101 102 103 104

    /// \brief Constructor
    ///
    /// Just fills in the data members of the IOFetchData structure
    ///
105
    /// \param proto Either IOFetch::TCP or IOFetch::UDP.
106
    /// \param service I/O Service object to handle the asynchronous
107
    ///        operations.
108 109 110 111
    /// \param query DNS question to send to the upstream server.
    /// \param address IP address of upstream server
    /// \param port Port to use for the query
    /// \param buff Output buffer into which the response (in wire format)
112
    ///        is written (if a response is received).
113
    /// \param cb Callback object containing the callback to be called
114 115
    ///        when we terminate.  The caller is responsible for managing this
    ///        object and deleting it if necessary.
116 117 118
    /// \param wait Timeout for the fetch (in ms).
    ///
    /// TODO: May need to alter constructor (see comment 4 in Trac ticket #554)
119
    IOFetchData(IOFetch::Protocol proto, IOService& service,
120 121 122 123
        const isc::dns::Question& query, const IOAddress& address,
        uint16_t port, isc::dns::OutputBufferPtr& buff, IOFetch::Callback* cb,
        int wait)
        :
124
        socket((proto == IOFetch::UDP) ?
125 126 127 128 129
            static_cast<IOAsioSocket<IOFetch>*>(
                new UDPSocket<IOFetch>(service)) :
            static_cast<IOAsioSocket<IOFetch>*>(
                new TCPSocket<IOFetch>(service))
            ),
130 131 132 133 134
        remote_snd((proto == IOFetch::UDP) ?
            static_cast<IOEndpoint*>(new UDPEndpoint(address, port)) :
            static_cast<IOEndpoint*>(new TCPEndpoint(address, port))
            ),
        remote_rcv((proto == IOFetch::UDP) ?
135 136 137 138 139
            static_cast<IOEndpoint*>(new UDPEndpoint(address, port)) :
            static_cast<IOEndpoint*>(new TCPEndpoint(address, port))
            ),
        question(query),
        msgbuf(new isc::dns::OutputBuffer(512)),
140
        received(buff),
141

142
        callback(cb),
143 144
        timer(service.get_io_service()),
        protocol(proto),
145
        cumulative(0),
146 147
        expected(0),
        offset(0),
148 149
        stopped(false),
        timeout(wait),
Stephen Morris's avatar
Stephen Morris committed
150
        packet(false),
151
        origin(ASIO_UNKORIGIN),
152 153
        staging(),
        qid(QidGenerator::getInstance().generateQid())
154
    {}
155 156 157 158 159 160 161 162 163 164 165 166

    // Checks if the response we received was ok;
    // - data contains the buffer we read, as well as the address
    // we sent to and the address we received from.
    // length is provided by the operator() in IOFetch.
    // Addresses must match, number of octets read must be at least
    // 2, and the first two octets must match the qid of the message
    // we sent.
    bool responseOK() {
        return (*remote_snd == *remote_rcv && cumulative >= 2 &&
                readUint16(received->getData()) == qid);
    }
167 168
};

169
/// IOFetch Constructor - just initialize the private data
Stephen Morris's avatar
Stephen Morris committed
170

171
IOFetch::IOFetch(Protocol protocol, IOService& service,
Stephen Morris's avatar
Stephen Morris committed
172
    const isc::dns::Question& question, const IOAddress& address, uint16_t port,
173
    OutputBufferPtr& buff, Callback* cb, int wait)
Stephen Morris's avatar
Stephen Morris committed
174
    :
175
    data_(new IOFetchData(protocol, service, question, address,
Stephen Morris's avatar
Stephen Morris committed
176
        port, buff, cb, wait))
177 178 179
{
}

Stephen Morris's avatar
Stephen Morris committed
180 181 182 183 184 185 186 187 188 189 190 191
IOFetch::IOFetch(Protocol protocol, IOService& service,
    OutputBufferPtr& outpkt, const IOAddress& address, uint16_t port,
    OutputBufferPtr& buff, Callback* cb, int wait)
    :
    data_(new IOFetchData(protocol, service,
          isc::dns::Question(isc::dns::Name("dummy.example.org"), isc::dns::RRClass::IN(), isc::dns::RRType::A()),
          address, port, buff, cb, wait))
{
    data_->msgbuf = outpkt;
    data_->packet = true;
}

192 193 194 195 196 197 198
// Return protocol in use.

IOFetch::Protocol
IOFetch::getProtocol() const {
    return (data_->protocol);
}

199 200
/// The function operator is implemented with the "stackless coroutine"
/// pattern; see internal/coroutine.h for details.
Stephen Morris's avatar
Stephen Morris committed
201

202
void
203
IOFetch::operator()(asio::error_code ec, size_t length) {
204

205 206 207 208
    if (data_->stopped) {
        return;
    } else if (ec) {
        logIOFailure(ec);
209 210 211 212
        return;
    }

    CORO_REENTER (this) {
Stephen Morris's avatar
Stephen Morris committed
213

214 215 216 217
        /// Generate the upstream query and render it to wire format
        /// This is done in a different scope to allow inline variable
        /// declarations.
        {
Stephen Morris's avatar
Stephen Morris committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
            if (data_->packet) {
                // A packet was given, overwrite the QID (which is in the
                // first two bytes of the packet).
                data_->msgbuf->writeUint16At(data_->qid, 0);

            } else {
                // A question was given, construct the packet
                Message msg(Message::RENDER);
                msg.setQid(data_->qid);
                msg.setOpcode(Opcode::QUERY());
                msg.setRcode(Rcode::NOERROR());
                msg.setHeaderFlag(Message::HEADERFLAG_RD);
                msg.addQuestion(data_->question);
                MessageRenderer renderer(*data_->msgbuf);
                msg.toWire(renderer);
            }
234 235
        }

236 237
        // If we timeout, we stop, which will can cancel outstanding I/Os and
        // shutdown everything.
238 239 240 241 242 243 244 245
        if (data_->timeout != -1) {
            data_->timer.expires_from_now(boost::posix_time::milliseconds(
                data_->timeout));
            data_->timer.async_wait(boost::bind(&IOFetch::stop, *this,
                TIME_OUT));
        }

        // Open a connection to the target system.  For speed, if the operation
246 247
        // is synchronous (i.e. UDP operation) we bypass the yield.
        data_->origin = ASIO_OPENSOCK;
248
        if (data_->socket->isOpenSynchronous()) {
249
            data_->socket->open(data_->remote_snd.get(), *this);
250
        } else {
251
            CORO_YIELD data_->socket->open(data_->remote_snd.get(), *this);
252 253
        }

Stephen Morris's avatar
Stephen Morris committed
254
        do {
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
            // Begin an asynchronous send, and then yield.  When the send completes,
            // we will resume immediately after this point.
            data_->origin = ASIO_SENDSOCK;
            CORO_YIELD data_->socket->asyncSend(data_->msgbuf->getData(),
                data_->msgbuf->getLength(), data_->remote_snd.get(), *this);
    
            // Now receive the response.  Since TCP may not receive the entire
            // message in one operation, we need to loop until we have received
            // it. (This can't be done within the asyncReceive() method because
            // each I/O operation will be done asynchronously and between each one
            // we need to yield ... and we *really* don't want to set up another
            // coroutine within that method.)  So after each receive (and yield),
            // we check if the operation is complete and if not, loop to read again.
            //
            // Another concession to TCP is that the amount of is contained in the
            // first two bytes.  This leads to two problems:
            //
            // a) We don't want those bytes in the return buffer.
            // b) They may not both arrive in the first I/O.
            //
            // So... we need to loop until we have at least two bytes, then store
            // the expected amount of data.  Then we need to loop until we have
            // received all the data before copying it back to the user's buffer.
            // And we want to minimise the amount of copying...
    
            data_->origin = ASIO_RECVSOCK;
            data_->cumulative = 0;          // No data yet received
            data_->offset = 0;              // First data into start of buffer
283
            data_->received->clear();       // Clear the receive buffer
284 285 286 287 288 289 290 291 292
            do {
                CORO_YIELD data_->socket->asyncReceive(data_->staging,
                                                       static_cast<size_t>(STAGING_LENGTH),
                                                       data_->offset,
                                                       data_->remote_rcv.get(), *this);
            } while (!data_->socket->processReceivedData(data_->staging, length,
                                                         data_->cumulative, data_->offset,
                                                         data_->expected, data_->received));
        } while (!data_->responseOK());
293

294 295 296
        // Finished with this socket, so close it.  This will not generate an
        // I/O error, but reset the origin to unknown in case we change this.
        data_->origin = ASIO_UNKORIGIN;
297 298
        data_->socket->close();

299 300 301 302 303 304 305 306 307
        /// We are done
        stop(SUCCESS);
    }
}

// Function that stops the coroutine sequence.  It is called either when the
// query finishes or when the timer times out.  Either way, it sets the
// "stopped_" flag and cancels anything that is in progress.
//
308 309
// As the function may be entered multiple times as things wind down, it checks
// if the stopped_ flag is already set.  If it is, the call is a no-op.
Stephen Morris's avatar
Stephen Morris committed
310

311 312
void
IOFetch::stop(Result result) {
313

314
    if (!data_->stopped) {
315 316 317 318 319 320 321 322 323 324 325

        // Mark the fetch as stopped to prevent other completion callbacks
        // (invoked because of the calls to cancel()) from executing the
        // cancel calls again.
        //
        // In a single threaded environment, the callbacks won't be invoked
        // until this one completes. In a multi-threaded environment, they may
        // well be, in which case the testing (and setting) of the stopped_
        // variable should be done inside a mutex (and the stopped_ variable
        // declared as "volatile").
        //
326 327 328 329
        // The numeric arguments indicate the debug level, with the lower
        // numbers indicating the most important information.  The relative
        // values are somewhat arbitrary.
        //
330
        // Although Logger::debug checks the debug flag internally, doing it
331
        // below before calling Logger::debug avoids the overhead of a string
332
        // conversion in the common case when debug is not enabled.
333
        //
334 335
        // TODO: Update testing of stopped_ if threads are used.
        data_->stopped = true;
336 337
        switch (result) {
            case TIME_OUT:
338
                if (logger.isDebugEnabled(1)) {
339
                    logger.debug(20, ASIO_RECVTMO,
340 341
                                 data_->remote_snd->getAddress().toText().c_str(),
                                 static_cast<int>(data_->remote_snd->getPort()));
342
                }
343 344
                break;

345
            case SUCCESS:
346
                if (logger.isDebugEnabled(50)) {
347
                    logger.debug(30, ASIO_FETCHCOMP,
348 349
                                 data_->remote_rcv->getAddress().toText().c_str(),
                                 static_cast<int>(data_->remote_rcv->getPort()));
350
                }
351 352
                break;

353 354 355 356
            case STOPPED:
                // Fetch has been stopped for some other reason.  This is
                // allowed but as it is unusual it is logged, but with a lower
                // debug level than a timeout (which is totally normal).
357
                logger.debug(1, ASIO_FETCHSTOP,
358 359
                             data_->remote_snd->getAddress().toText().c_str(),
                             static_cast<int>(data_->remote_snd->getPort()));
360 361
                break;

362
            default:
363
                logger.error(ASIO_UNKRESULT, static_cast<int>(result),
364 365
                             data_->remote_snd->getAddress().toText().c_str(),
                             static_cast<int>(data_->remote_snd->getPort()));
366 367
        }

Stephen Morris's avatar
Stephen Morris committed
368 369 370 371 372 373 374 375
        // Stop requested, cancel and I/O's on the socket and shut it down,
        // and cancel the timer.
        data_->socket->cancel();
        data_->socket->close();

        data_->timer.cancel();

        // Execute the I/O completion callback (if present).
376
        if (data_->callback) {
Stephen Morris's avatar
Stephen Morris committed
377
            (*(data_->callback))(result);
378 379 380 381
        }
    }
}

382 383
// Log an error - called on I/O failure

384
void IOFetch::logIOFailure(asio::error_code ec) {
385

386 387 388 389 390
    // Should only get here with a known error code.
    assert((data_->origin == ASIO_OPENSOCK) ||
           (data_->origin == ASIO_SENDSOCK) ||
           (data_->origin == ASIO_RECVSOCK) ||
           (data_->origin == ASIO_UNKORIGIN));
391

392 393 394
    static const char* PROTOCOL[2] = {"TCP", "UDP"};
    logger.error(data_->origin,
                 ec.value(),
395
                 ((data_->remote_snd->getProtocol() == IPPROTO_TCP) ?
396
                     PROTOCOL[0] : PROTOCOL[1]),
397 398
                 data_->remote_snd->getAddress().toText().c_str(),
                 static_cast<int>(data_->remote_snd->getPort()));
399 400
}

401
} // namespace asiolink
Stephen Morris's avatar
Stephen Morris committed
402