OpenMPI  0.1.1
pml_base_request.h
Go to the documentation of this file.
1 /* -*- Mode: C; c-basic-offset:4 ; -*- */
2 /*
3  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
4  * University Research and Technology
5  * Corporation. All rights reserved.
6  * Copyright (c) 2004-2007 The University of Tennessee and The University
7  * of Tennessee Research Foundation. All rights
8  * reserved.
9  * Copyright (c) 2004-2008 High Performance Computing Center Stuttgart,
10  * University of Stuttgart. All rights reserved.
11  * Copyright (c) 2004-2005 The Regents of the University of California.
12  * All rights reserved.
13  * Copyright (c) 2009 Sun Microsystems, Inc. All rights reserved.
14  * $COPYRIGHT$
15  *
16  * Additional copyrights may follow
17  *
18  * $HEADER$
19  */
20 /**
21  * @file
22  */
23 #ifndef MCA_PML_BASE_REQUEST_H
24 #define MCA_PML_BASE_REQUEST_H
25 
26 #include "ompi_config.h"
27 #include "ompi/class/ompi_free_list.h"
28 #include "ompi/communicator/communicator.h"
29 #include "ompi/request/request.h"
30 #include "opal/datatype/opal_convertor.h"
31 
32 BEGIN_C_DECLS
33 
34 /**
35  * External list for the requests. They are declared as lists of
36  * the basic request type, which will allow all PML to overload
37  * the list. Beware these free lists have to be initialized
38  * directly by the PML who win the PML election.
39  */
40 OMPI_DECLSPEC extern ompi_free_list_t mca_pml_base_send_requests;
41 OMPI_DECLSPEC extern ompi_free_list_t mca_pml_base_recv_requests;
42 
43 /**
44  * Type of request.
45  */
46 /*
47  * The following include pulls in shared typedefs with debugger plugins.
48  * For more information on why we do this see the Notice to developers
49  * comment at the top of the ompi_msgq_dll.c file.
50  */
51 #include "pml_base_request_dbg.h"
52 
53 
54 /**
55  * Base type for PML P2P requests
56  */
58 
59 /* START: These fields have to match the definition of the mca_pml_cm_request_t */
60  ompi_request_t req_ompi; /**< base request */
61  volatile bool req_pml_complete; /**< flag indicating if the pt-2-pt layer is done with this request */
62  mca_pml_base_request_type_t req_type; /**< MPI request type - used for test */
63  struct ompi_communicator_t *req_comm; /**< communicator pointer */
64  struct ompi_datatype_t *req_datatype; /**< pointer to data type */
65  volatile bool req_free_called; /**< flag indicating if the user has freed this request */
66  opal_convertor_t req_convertor; /**< always need the convertor */
67 /* END: These field have to match the definition of the mca_pml_cm_request_t */
68 
69  void *req_addr; /**< pointer to application buffer */
70  size_t req_count; /**< count of user datatype elements */
71  int32_t req_peer; /**< peer process - rank w/in this communicator */
72  int32_t req_tag; /**< user defined tag */
73  struct ompi_proc_t* req_proc; /**< peer process */
74  uint64_t req_sequence; /**< sequence number for MPI pt-2-pt ordering */
75 };
77 
79 
80 END_C_DECLS
81 
82 #endif
83 
size_t req_count
count of user datatype elements
Definition: pml_base_request.h:70
Definition: ompi_datatype.h:68
struct ompi_communicator_t * req_comm
communicator pointer
Definition: pml_base_request.h:63
int32_t req_peer
peer process - rank w/in this communicator
Definition: pml_base_request.h:71
Remote Open MPI process structure.
Definition: proc.h:56
opal_convertor_t req_convertor
always need the convertor
Definition: pml_base_request.h:66
Top-level description of requests.
volatile bool req_pml_complete
flag indicating if the pt-2-pt layer is done with this request
Definition: pml_base_request.h:61
struct ompi_proc_t * req_proc
peer process
Definition: pml_base_request.h:73
int32_t req_tag
user defined tag
Definition: pml_base_request.h:72
Definition: ompi_free_list.h:39
struct ompi_datatype_t * req_datatype
pointer to data type
Definition: pml_base_request.h:64
void * req_addr
pointer to application buffer
Definition: pml_base_request.h:69
Definition: opal_convertor.h:90
mca_pml_base_request_type_t req_type
MPI request type - used for test.
Definition: pml_base_request.h:62
BEGIN_C_DECLS OMPI_DECLSPEC ompi_free_list_t mca_pml_base_send_requests
External list for the requests.
Definition: pml_base_request.c:27
ompi_request_t req_ompi
base request
Definition: pml_base_request.h:60
Definition: communicator.h:118
Main top-level request struct definition.
Definition: request.h:100
Type of request.
Definition: pml_base_request.h:57
#define OBJ_CLASS_DECLARATION(NAME)
Declaration for class descriptor.
Definition: opal_object.h:236
uint64_t req_sequence
sequence number for MPI pt-2-pt ordering
Definition: pml_base_request.h:74
volatile bool req_free_called
flag indicating if the user has freed this request
Definition: pml_base_request.h:65