1 /*
2  * Copyright (c) 2015 Los Alamos National Security, LLC. All rights reserved.
3  * Copyright (c) 2015-2017 Cray Inc. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #ifndef _GNIX_CNTR_H_
35 #define _GNIX_CNTR_H_
36 
37 #include <ofi.h>
38 
39 #include "gnix.h"
40 #include "gnix_progress.h"
41 #include "gnix_wait.h"
42 #include "gnix_util.h"
43 
44 struct gnix_fid_cntr {
45 	struct fid_cntr cntr_fid;
46 	struct gnix_fid_domain *domain;
47 	struct fid_wait *wait;
48 	struct fi_cntr_attr attr;
49 	ofi_atomic32_t cnt;
50 	ofi_atomic32_t cnt_err;
51 	struct gnix_reference ref_cnt;
52 	struct dlist_entry trigger_list;
53 	fastlock_t trigger_lock;
54 	struct gnix_prog_set pset;
55 	bool requires_lock;
56 };
57 
58 /**
59  * @brief              Increment event counter associated with a gnix_fid counter
60  *                     object
61  * @param[in] cntr     pointer to previously allocated gnix_fid_cntr structure
62  * @return             FI_SUCCESS on success, -FI_EINVAL on invalid argument
63  */
64 int _gnix_cntr_inc(struct gnix_fid_cntr *cntr);
65 
66 /**
67  * @brief              Increment error event counter associated with a gnix_fid counter
68  *                     object
69  * @param[in] cntr     pointer to previously allocated gnix_fid_cntr structure
70  * @return             FI_SUCCESS on success, -FI_EINVAL on invalid argument
71  */
72 int _gnix_cntr_inc_err(struct gnix_fid_cntr *cntr);
73 
74 /**
75  * @brief              Add an object to the list progressed when fi_cntr_read
76  *                     and related functions are called.
77  * @param[in] cntr     pointer to previously allocated gnix_fid_cntr structure
78  * @param[in] obj      pointer to object to add to the progress list.
79  * @param[in] prog_fn  object progress function
80  * @return             FI_SUCCESS on success, -FI_EINVAL on invalid argument
81  */
82 int _gnix_cntr_poll_obj_add(struct gnix_fid_cntr *cntr, void *obj,
83 			    int (*prog_fn)(void *data));
84 
85 /**
86  * @brief              Remove an object from the list progressed when
87  *                     fi_cntr_read and related functions are called.
88  * @param[in] cntr     pointer to previously allocated gnix_fid_cntr structure
89  * @param[in] obj      pointer to previously added object
90  * @param[in] prog_fn  object progress function
91  * @return             FI_SUCCESS on success, -FI_EINVAL on invalid argument
92  */
93 int _gnix_cntr_poll_obj_rem(struct gnix_fid_cntr *cntr, void *obj,
94 			    int (*prog_fn)(void *data));
95 
96 #endif
97