File: btl_tcp_hdr.h

package info (click to toggle)
openmpi 5.0.8-4
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 201,684 kB
  • sloc: ansic: 613,078; makefile: 42,353; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (69 lines) | stat: -rw-r--r-- 2,341 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2020 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#ifndef MCA_BTL_TCP_HDR_H
#define MCA_BTL_TCP_HDR_H

#include "opal_config.h"
#include "btl_tcp.h"
#include "opal/mca/btl/base/base.h"

BEGIN_C_DECLS

/**
 * TCP header.
 */

#define MCA_BTL_TCP_HDR_TYPE_SEND 1
#define MCA_BTL_TCP_HDR_TYPE_PUT  2
#define MCA_BTL_TCP_HDR_TYPE_GET  3
#define MCA_BTL_TCP_HDR_TYPE_FIN  4
/* The MCA_BTL_TCP_HDR_TYPE_FIN is a special kind of message sent during normal
 * connexion closing. Before the endpoint closes the socket, it performs a
 * 1-way handshake by sending a FIN message in the socket. This lets the other
 * end of the connexion discriminate between the case in which the peer has
 * closed intentionnally (e.g., during MPI_FINALIZE), or unintentionally (e.g.,
 * as the result of some transmission or process failure).
 * The process initiating the close sends the FIN message but does not wait
 * for a 2-way handshake and closes the socket immediately. Thus, the recipient
 * of a FIN message can simply close the socket and mark the endpoint as closed
 * without error, and without answering a FIN message itself.
 */

struct mca_btl_tcp_hdr_t {
    mca_btl_base_header_t base;
    uint8_t type;
    uint16_t count;
    uint32_t size;
};
typedef struct mca_btl_tcp_hdr_t mca_btl_tcp_hdr_t;

#define MCA_BTL_TCP_HDR_HTON(hdr)     \
    do {                              \
        hdr.count = htons(hdr.count); \
        hdr.size = htonl(hdr.size);   \
    } while (0)

#define MCA_BTL_TCP_HDR_NTOH(hdr)     \
    do {                              \
        hdr.count = ntohs(hdr.count); \
        hdr.size = ntohl(hdr.size);   \
    } while (0)

END_C_DECLS
#endif