1/*
2 * Copyright(c) 2015 - 2020 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
52enum irq_type {
53	IRQ_SDMA,
54	IRQ_RCVCTXT,
55	IRQ_NETDEVCTXT,
56	IRQ_GENERAL,
57	IRQ_OTHER
58};
59
60/* Can be used for both memory and cpu */
61enum affinity_flags {
62	AFF_AUTO,
63	AFF_NUMA_LOCAL,
64	AFF_DEV_LOCAL,
65	AFF_IRQ_LOCAL
66};
67
68struct cpu_mask_set {
69	struct cpumask mask;
70	struct cpumask used;
71	uint gen;
72};
73
74struct hfi1_msix_entry;
75
76/* Initialize non-HT cpu cores mask */
77void init_real_cpu_mask(void);
78/* Initialize driver affinity data */
79int hfi1_dev_affinity_init(struct hfi1_devdata *dd);
80/*
81 * Set IRQ affinity to a CPU. The function will determine the
82 * CPU and set the affinity to it.
83 */
84int hfi1_get_irq_affinity(struct hfi1_devdata *dd,
85			  struct hfi1_msix_entry *msix);
86/*
87 * Remove the IRQ's CPU affinity. This function also updates
88 * any internal CPU tracking data
89 */
90void hfi1_put_irq_affinity(struct hfi1_devdata *dd,
91			   struct hfi1_msix_entry *msix);
92/*
93 * Determine a CPU affinity for a user process, if the process does not
94 * have an affinity set yet.
95 */
96int hfi1_get_proc_affinity(int node);
97/* Release a CPU used by a user process. */
98void hfi1_put_proc_affinity(int cpu);
99
100struct hfi1_affinity_node {
101	int node;
102	u16 __percpu *comp_vect_affinity;
103	struct cpu_mask_set def_intr;
104	struct cpu_mask_set rcv_intr;
105	struct cpumask general_intr_mask;
106	struct cpumask comp_vect_mask;
107	struct list_head list;
108};
109
110struct hfi1_affinity_node_list {
111	struct list_head list;
112	struct cpumask real_cpu_mask;
113	struct cpu_mask_set proc;
114	int num_core_siblings;
115	int num_possible_nodes;
116	int num_online_nodes;
117	int num_online_cpus;
118	struct mutex lock; /* protects affinity nodes */
119};
120
121int node_affinity_init(void);
122void node_affinity_destroy_all(void);
123extern struct hfi1_affinity_node_list node_affinity;
124void hfi1_dev_affinity_clean_up(struct hfi1_devdata *dd);
125int hfi1_comp_vect_mappings_lookup(struct rvt_dev_info *rdi, int comp_vect);
126int hfi1_comp_vectors_set_up(struct hfi1_devdata *dd);
127void hfi1_comp_vectors_clean_up(struct hfi1_devdata *dd);
128
129#endif /* _HFI1_AFFINITY_H */
130