1 /*
2  * Copyright(c) 2015, 2016 Intel Corporation.
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * BSD LICENSE
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  *
24  *  - Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  *  - Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *  - Neither the name of Intel Corporation nor the names of its
31  *    contributors may be used to endorse or promote products derived
32  *    from this software without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  */
47 #ifndef _HFI1_AFFINITY_H
48 #define _HFI1_AFFINITY_H
49 
50 #include "hfi.h"
51 
52 enum irq_type {
53 	IRQ_SDMA,
54 	IRQ_RCVCTXT,
55 	IRQ_GENERAL,
56 	IRQ_OTHER
57 };
58 
59 /* Can be used for both memory and cpu */
60 enum affinity_flags {
61 	AFF_AUTO,
62 	AFF_NUMA_LOCAL,
63 	AFF_DEV_LOCAL,
64 	AFF_IRQ_LOCAL
65 };
66 
67 struct cpu_mask_set {
68 	struct cpumask mask;
69 	struct cpumask used;
70 	uint gen;
71 };
72 
73 struct hfi1_affinity {
74 	struct cpu_mask_set def_intr;
75 	struct cpu_mask_set rcv_intr;
76 	struct cpu_mask_set proc;
77 	struct cpumask real_cpu_mask;
78 	/* spin lock to protect affinity struct */
79 	spinlock_t lock;
80 };
81 
82 struct hfi1_msix_entry;
83 
84 /* Initialize non-HT cpu cores mask */
85 int init_real_cpu_mask(struct hfi1_devdata *);
86 /* Initialize driver affinity data */
87 void hfi1_dev_affinity_init(struct hfi1_devdata *);
88 /* Free driver affinity data */
89 void hfi1_dev_affinity_free(struct hfi1_devdata *);
90 /*
91  * Set IRQ affinity to a CPU. The function will determine the
92  * CPU and set the affinity to it.
93  */
94 int hfi1_get_irq_affinity(struct hfi1_devdata *, struct hfi1_msix_entry *);
95 /*
96  * Remove the IRQ's CPU affinity. This function also updates
97  * any internal CPU tracking data
98  */
99 void hfi1_put_irq_affinity(struct hfi1_devdata *, struct hfi1_msix_entry *);
100 /*
101  * Determine a CPU affinity for a user process, if the process does not
102  * have an affinity set yet.
103  */
104 int hfi1_get_proc_affinity(struct hfi1_devdata *, int);
105 /* Release a CPU used by a user process. */
106 void hfi1_put_proc_affinity(struct hfi1_devdata *, int);
107 
108 #endif /* _HFI1_AFFINITY_H */
109