summaryrefslogtreecommitdiffstats
path: root/src/com/jogamp/opencl/CLSubDevice.java
blob: 68cbe9dc74a27875415f1712b3e3940bb2c921c9 (plain)
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * Created on Wednesday, July 13 2011 00:50
 */
package com.jogamp.opencl;

import com.jogamp.opencl.llb.CL;

import static com.jogamp.opencl.llb.CL.*;

/**
 * A subdevice created through device fission.
 * A subdevice can be used like any other device but must be released if no longer needed.
 * <p>
 * possible usecases for device fission:
 * <ul>
 * <li> To reserve part of the device for use for high priority / latency-sensitive tasks </li>
 * <li> To more directly control the assignment of work to individual compute units </li>
 * <li> To subdivide compute devices along some shared hardware feature like a cache </li>
 * </ul>
 * </p>
 * @see CLDevice#createSubDevicesEqually(int)
 * @see CLDevice#createSubDevicesByCount(int[])
 * @see CLDevice#createSubDeviceByIndex(int[])
 * @see CLDevice#createSubDevicesByDomain(com.jogamp.opencl.CLSubDevice.AffinityDomain)
 * @author Michael Bien
 */
public class CLSubDevice extends CLDevice implements CLResource {

    private volatile boolean released;

    private final CLDevice parent;

    private CLSubDevice(CLDevice parent, CLContext context, long id) {
        super(context, id);
        this.parent = parent;
    }

    private CLSubDevice(CLDevice parent, CLPlatform platform, long id) {
        super(platform, id);
        this.parent = parent;
    }

    static CLSubDevice createSubDevice(CLDevice device, long id) {
        if(device.context == null) {
            return new CLSubDevice(device, device.getPlatform(), id);
        }else{
            return new CLSubDevice(device, device.getContext(), id);
        }
    }

    /**
     * Returns the parent device which may be a CLDevice or another CLSubDevice.
     */
    public CLDevice getParent() {
        return parent;
    }

    @Override
    public void release() {
        if(released) {
            throw new RuntimeException("already released");
        }
        released = true;
        CL cl = CLPlatform.getLowLevelCLInterface();
        int ret = cl.clReleaseDeviceEXT(ID);
        CLException.checkForError(ret, "release failed");
    }

    @Override
    public boolean isReleased() {
        return released;
    }

    @Override
    public boolean isSubDevice() {
        return true;
    }


    /**
     * Sub device affinity domains.
     * @see CLDevice#createSubDevicesByDomain(com.jogamp.opencl.CLSubDevice.AffinityDomain) 
     */
    public enum AffinityDomain {

        L1_CACHE(CL_AFFINITY_DOMAIN_L1_CACHE_EXT),

        L2_CACHE(CL_AFFINITY_DOMAIN_L2_CACHE_EXT),

        L3_CACHE(CL_AFFINITY_DOMAIN_L3_CACHE_EXT),

        L4_CACHE(CL_AFFINITY_DOMAIN_L4_CACHE_EXT),

        NUMA(CL_AFFINITY_DOMAIN_NUMA_EXT),

        NEXT_FISSIONABLE(CL_AFFINITY_DOMAIN_NEXT_FISSIONABLE_EXT);

        /**
         * Value of wrapped OpenCL value.
         */
        public final int TYPE;

        private AffinityDomain(int type) {
            this.TYPE = type;
        }

        /**
         * Returns the matching AffinityDomain for the given cl flag.
         */
        public static AffinityDomain valueOf(int domain) {
            AffinityDomain[] values = AffinityDomain.values();
            for (AffinityDomain value : values) {
                if(value.TYPE == domain)
                    return value;
            }
            return null;
        }

    }

    /**
     * Sub device partition styles.
     * @see CLDevice#getPartitionTypes()
     */
    public enum Partition {

        /**
         * @see CLDevice#createSubDevicesEqually(int)
         */
        EQUALLY(CL_DEVICE_PARTITION_EQUALLY_EXT),

        /**
         * @see CLDevice#createSubDevicesByCount(int[])
         */
        COUNTS(CL_DEVICE_PARTITION_BY_COUNTS_EXT),

        /**
         * @see CLDevice#createSubDeviceByIndex(int[])
         */
        NAMES(CL_DEVICE_PARTITION_BY_NAMES_EXT),

        /**
         * @see CLDevice#createSubDevicesByDomain(com.jogamp.opencl.CLSubDevice.AffinityDomain)
         */
        DOMAIN(CL_DEVICE_PARTITION_BY_AFFINITY_DOMAIN_EXT);

        /**
         * Value of wrapped OpenCL value.
         */
        public final int FLAG;

        private Partition(int type) {
            this.FLAG = type;
        }

        /**
         * Returns the matching AffinityDomain for the given cl flag.
         */
        public static Partition valueOf(int domain) {
            Partition[] values = Partition.values();
            for (Partition value : values) {
                if(value.FLAG == domain)
                    return value;
            }
            return null;
        }

    }

}