Blame packet/command_cygwin.c

Packit b802ec
/*
Packit b802ec
    mtr  --  a network diagnostic tool
Packit b802ec
    Copyright (C) 2016  Matt Kimball
Packit b802ec
Packit b802ec
    This program is free software; you can redistribute it and/or modify
Packit b802ec
    it under the terms of the GNU General Public License version 2 as
Packit b802ec
    published by the Free Software Foundation.
Packit b802ec
Packit b802ec
    This program is distributed in the hope that it will be useful,
Packit b802ec
    but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit b802ec
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit b802ec
    GNU General Public License for more details.
Packit b802ec
Packit b802ec
    You should have received a copy of the GNU General Public License
Packit b802ec
    along with this program; if not, write to the Free Software
Packit b802ec
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Packit b802ec
*/
Packit b802ec
Packit b802ec
#include "command.h"
Packit b802ec
Packit b802ec
#include <errno.h>
Packit b802ec
#include <io.h>
Packit b802ec
#include <stdio.h>
Packit b802ec
Packit b802ec
/*
Packit b802ec
    A completion routine to be called by Windows when a read from
Packit b802ec
    the command stream has completed.
Packit b802ec
*/
Packit b802ec
static
Packit b802ec
void CALLBACK finish_read_command(
Packit b802ec
    DWORD status,
Packit b802ec
    DWORD size_read,
Packit b802ec
    OVERLAPPED * overlapped)
Packit b802ec
{
Packit b802ec
    struct command_buffer_t *buffer;
Packit b802ec
    char *read_position;
Packit b802ec
Packit b802ec
    /*
Packit b802ec
       hEvent is unusuaed by ReadFileEx, so we use it to pass
Packit b802ec
       our command_buffer structure.
Packit b802ec
     */
Packit b802ec
    buffer = (struct command_buffer_t *) overlapped->hEvent;
Packit b802ec
Packit b802ec
    if (status) {
Packit b802ec
        /*  When the stream is closed ERROR_BROKEN_PIPE will be the result  */
Packit b802ec
        if (status == ERROR_BROKEN_PIPE) {
Packit b802ec
            buffer->platform.pipe_open = false;
Packit b802ec
            return;
Packit b802ec
        }
Packit b802ec
Packit b802ec
        fprintf(stderr, "ReadFileEx completion failure %d\n", status);
Packit b802ec
        exit(EXIT_FAILURE);
Packit b802ec
    }
Packit b802ec
Packit b802ec
    /*  Copy from the overlapped I/O buffer to the incoming command buffer  */
Packit b802ec
    read_position =
Packit b802ec
        &buffer->incoming_buffer[buffer->incoming_read_position];
Packit b802ec
    memcpy(read_position, buffer->platform.overlapped_buffer, size_read);
Packit b802ec
Packit b802ec
    /*  Account for the newly read data  */
Packit b802ec
    buffer->incoming_read_position += size_read;
Packit b802ec
    buffer->platform.read_active = false;
Packit b802ec
}
Packit b802ec
Packit b802ec
/*
Packit b802ec
    An APC which does nothing, to be used only to wake from the current
Packit b802ec
    alertable wait.
Packit b802ec
*/
Packit b802ec
static
Packit b802ec
void CALLBACK empty_apc(
Packit b802ec
    ULONG * param)
Packit b802ec
{
Packit b802ec
}
Packit b802ec
Packit b802ec
/*  Wake from the next alertable wait without waiting for newly read data  */
Packit b802ec
static
Packit b802ec
void queue_empty_apc(
Packit b802ec
    void)
Packit b802ec
{
Packit b802ec
    if (QueueUserAPC((PAPCFUNC) empty_apc, GetCurrentThread(), 0) == 0) {
Packit b802ec
        fprintf(stderr, "Unexpected QueueUserAPC failure %d\n",
Packit b802ec
                GetLastError());
Packit b802ec
        exit(EXIT_FAILURE);
Packit b802ec
    }
Packit b802ec
}
Packit b802ec
Packit b802ec
/*  Start a new overlapped I/O read from the command stream  */
Packit b802ec
void start_read_command(
Packit b802ec
    struct command_buffer_t *buffer)
Packit b802ec
{
Packit b802ec
    HANDLE command_stream = (HANDLE) get_osfhandle(buffer->command_stream);
Packit b802ec
    int space_remaining =
Packit b802ec
        COMMAND_BUFFER_SIZE - buffer->incoming_read_position - 1;
Packit b802ec
    int err;
Packit b802ec
Packit b802ec
    /*  If a read is already active, or the pipe is closed, do nothing  */
Packit b802ec
    if (!buffer->platform.pipe_open || buffer->platform.read_active) {
Packit b802ec
        return;
Packit b802ec
    }
Packit b802ec
Packit b802ec
    memset(&buffer->platform.overlapped, 0, sizeof(OVERLAPPED));
Packit b802ec
    buffer->platform.overlapped.hEvent = (HANDLE) buffer;
Packit b802ec
Packit b802ec
    if (!ReadFileEx
Packit b802ec
        (command_stream, buffer->platform.overlapped_buffer,
Packit b802ec
         space_remaining, &buffer->platform.overlapped,
Packit b802ec
         finish_read_command)) {
Packit b802ec
Packit b802ec
        err = GetLastError();
Packit b802ec
Packit b802ec
        if (err == ERROR_BROKEN_PIPE) {
Packit b802ec
            /*  If the command stream has been closed, we need to wake from
Packit b802ec
               the next altertable wait to exit the main loop  */
Packit b802ec
            buffer->platform.pipe_open = false;
Packit b802ec
            queue_empty_apc();
Packit b802ec
Packit b802ec
            return;
Packit b802ec
        } else if (err != WAIT_IO_COMPLETION) {
Packit b802ec
            fprintf(stderr, "Unexpected ReadFileEx failure %d\n",
Packit b802ec
                    GetLastError());
Packit b802ec
            exit(EXIT_FAILURE);
Packit b802ec
        }
Packit b802ec
    }
Packit b802ec
Packit b802ec
    /*  Remember that we have started an overlapped read already  */
Packit b802ec
    buffer->platform.read_active = true;
Packit b802ec
}
Packit b802ec
Packit b802ec
/*  Initialize the command buffer, and start the first overlapped read  */
Packit b802ec
void init_command_buffer(
Packit b802ec
    struct command_buffer_t *command_buffer,
Packit b802ec
    int command_stream)
Packit b802ec
{
Packit b802ec
    memset(command_buffer, 0, sizeof(struct command_buffer_t));
Packit b802ec
    command_buffer->command_stream = command_stream;
Packit b802ec
    command_buffer->platform.pipe_open = true;
Packit b802ec
}
Packit b802ec
Packit b802ec
/*
Packit b802ec
    Return with errno EPIPE if the command stream has been closed.
Packit b802ec
    Otherwise, not much to do for Cygwin, since we are using Overlapped I/O
Packit b802ec
    to read commands.
Packit b802ec
*/
Packit b802ec
int read_commands(
Packit b802ec
    struct command_buffer_t *buffer)
Packit b802ec
{
Packit b802ec
    if (!buffer->platform.pipe_open) {
Packit b802ec
        errno = EPIPE;
Packit b802ec
        return -1;
Packit b802ec
    }
Packit b802ec
Packit b802ec
    return 0;
Packit b802ec
}