sync_pipe_write.c

   1 /* sync_pipe_write.c
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #include <config.h>
  11
  12 #include <string.h>
  13
  14 #include <glib.h>
  15
  16 #include <wsutil/file_util.h>
  17
  18 #include "sync_pipe.h"
  19
  20 /****************************************************************************************************************/
  21 /* sync_pipe handling */
  22
  23
  24 /* write a single message header to the recipient pipe */
  25 ssize_t
  26 pipe_write_header(int pipe_fd, char indicator, int length)
  27 {
  28     guchar header[1+3]; /* indicator + 3-byte len */
  29
  30
  31     g_assert(length <= SP_MAX_MSG_LEN);
  32
  33     /* write header (indicator + 3-byte len) */
  34     header[0] = indicator;
  35     header[1] = (length >> 16) & 0xFF;
  36     header[2] = (length >> 8) & 0xFF;
  37     header[3] = (length >> 0) & 0xFF;
  38
  39     /* write header */
  40     return ws_write(pipe_fd, header, sizeof header);
  41 }
  42
  43
  44 /* write a message to the recipient pipe in the standard format
  45    (3 digit message length (excluding length and indicator field),
  46    1 byte message indicator and the rest is the message).
  47    If msg is NULL, the message has only a length and indicator. */
  48 void
  49 pipe_write_block(int pipe_fd, char indicator, const char *msg)
  50 {
  51     ssize_t ret;
  52     int len;
  53
  54     /*g_warning("write %d enter", pipe_fd);*/
  55
  56     if(msg != NULL) {
  57         len = (int) strlen(msg) + 1;    /* including the terminating '\0'! */
  58     } else {
  59         len = 0;
  60     }
  61
  62     /* write header (indicator + 3-byte len) */
  63     ret = pipe_write_header(pipe_fd, indicator, len);
  64     if(ret == -1) {
  65         return;
  66     }
  67
  68     /* write value (if we have one) */
  69     if(len) {
  70         /*g_warning("write %d indicator: %c value len: %u msg: %s", pipe_fd, indicator, len, msg);*/
  71         ret = ws_write(pipe_fd, msg, len);
  72         if(ret == -1) {
  73             return;
  74         }
  75     } else {
  76         /*g_warning("write %d indicator: %c no value", pipe_fd, indicator);*/
  77     }
  78
  79     /*g_warning("write %d leave", pipe_fd);*/
  80 }
  81
  82
  83 void
  84 sync_pipe_errmsg_to_parent(int pipe_fd, const char *error_msg,
  85                            const char *secondary_error_msg)
  86 {
  87
  88     /* first write a "master header" with the length of the two messages plus their "slave headers" */
  89     pipe_write_header(pipe_fd, SP_ERROR_MSG, (int) (strlen(error_msg) + 1 + 4 + strlen(secondary_error_msg) + 1 + 4));
  90     pipe_write_block(pipe_fd, SP_ERROR_MSG, error_msg);
  91     pipe_write_block(pipe_fd, SP_ERROR_MSG, secondary_error_msg);
  92 }
  93
  94 /*
  95  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
  96  *
  97  * Local variables:
  98  * c-basic-offset: 4
  99  * tab-width: 8
 100  * indent-tabs-mode: nil
 101  * End:
 102  *
 103  * vi: set shiftwidth=4 tabstop=8 expandtab:
 104  * :indentSize=4:tabSize=8:noTabs=true:
 105  */