summaryrefslogtreecommitdiff
path: root/libs/ode-0.16.1/ode/src/resource_control.cpp
blob: 29a3d8388727722921459f4a238f7d31af17f547 (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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/*************************************************************************
 *                                                                       *
 * Open Dynamics Engine, Copyright (C) 2001,2002 Russell L. Smith.       *
 * All rights reserved.  Email: russ@q12.org   Web: www.q12.org          *
 *                                                                       *
 * This library is free software; you can redistribute it and/or         *
 * modify it under the terms of EITHER:                                  *
 *   (1) The GNU Lesser General Public License as published by the Free  *
 *       Software Foundation; either version 2.1 of the License, or (at  *
 *       your option) any later version. The text of the GNU Lesser      *
 *       General Public License is included with this library in the     *
 *       file LICENSE.TXT.                                               *
 *   (2) The BSD-style license that is included with this library in     *
 *       the file LICENSE-BSD.TXT.                                       *
 *                                                                       *
 * This library is distributed in the hope that it will be useful,       *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
 * LICENSE.TXT and LICENSE-BSD.TXT for more details.                     *
 *                                                                       *
 *************************************************************************/

/*
 * Resource accounting/preallocation class implementations
 * Copyright (c) 2017-2019 Oleh Derevenko, odar@eleks.com (change all "a" to "e")
 */


#include <ode/common.h>
#include <ode/cooperative.h>
#include "config.h"
#include "resource_control.h"
#include "simple_cooperative.h"


//////////////////////////////////////////////////////////////////////////
// dxResourceRequirementDescriptor();

dxResourceRequirementDescriptor::~dxResourceRequirementDescriptor()
{
    // Do nothing
}


//////////////////////////////////////////////////////////////////////////
// dxRequiredResourceContainer

dxRequiredResourceContainer::~dxRequiredResourceContainer()
{
    freeResources();
}


bool dxRequiredResourceContainer::allocateResources(const dxResourceRequirementDescriptor &requirementDescriptor)
{
    bool result = false;
    
    bool bufferAllocated = false;

    do
    {
        sizeint memorySizeRequirement = requirementDescriptor.getMemorySizeRequirement();
        
        if (memorySizeRequirement != 0)
        {
            unsigned memoryAlignmentRequirement = requirementDescriptor.getMemoryAlignmentRequirement();
            void *bufferAllocated = m_memoryAllocation.allocAligned(memorySizeRequirement, memoryAlignmentRequirement);
            if (bufferAllocated == NULL)
            {
                break;
            }
        }
        bufferAllocated = true;

        dxThreadingBase *relatedThreading = requirementDescriptor.getrelatedThreading();
        dIASSERT(relatedThreading != NULL);

        unsigned simultaneousCallRequirement = requirementDescriptor.getSimultaneousCallRequirement();
        if (simultaneousCallRequirement != 0)
        {
            if (!relatedThreading->PreallocateResourcesForThreadedCalls(simultaneousCallRequirement))
            {
                break;
            }
        }

        dCallWaitID stockCallWait = NULL;

        if (requirementDescriptor.getIsStockCallWaitRequired())
        {
             stockCallWait = relatedThreading->AllocateOrRetrieveStockCallWaitID();
             if (stockCallWait == NULL)
             {
                 break;
             }
        }

        m_relatedThreading = relatedThreading;
    	m_stockCallWait = stockCallWait;
    
    	result = true;
    }
    while (false);

    if (!result)
    {
        if (bufferAllocated)
        {
            m_memoryAllocation.freeAllocation();
        }
    }
    
    return result;

}

void dxRequiredResourceContainer::freeResources()
{
    if (m_relatedThreading != NULL)
    {
        m_relatedThreading = NULL;
        m_stockCallWait = NULL;
        m_memoryAllocation.freeAllocation();
    }
    else
    {
        dIASSERT(m_stockCallWait == NULL);
        dIASSERT(m_memoryAllocation.getUserAreaPointer() == NULL);
    }
}


//////////////////////////////////////////////////////////////////////////
// Public interface functions

static inline 
dResourceRequirementsID encodeResourceRequirementsID(dxResourceRequirementDescriptor *requirementsDescriptor)
{
    return (dResourceRequirementsID)requirementsDescriptor;
}


/*extern ODE_API */
dResourceRequirementsID dResourceRequirementsCreate(dCooperativeID cooperative)
{
    dAASSERT(cooperative != NULL);

    dxSimpleCooperative *cooperativeInstance = decodeCooperativeID(cooperative);
    dxThreadingBase *threading = cooperativeInstance->getRelatedThreading();

    dxResourceRequirementDescriptor *requirementsDescriptor = new dxResourceRequirementDescriptor(threading);
    
    dResourceRequirementsID result = encodeResourceRequirementsID(requirementsDescriptor);
    return result;
}

/*extern ODE_API */
void dResourceRequirementsDestroy(dResourceRequirementsID requirements)
{
    dxResourceRequirementDescriptor *requirementsDescriptor = decodeResourceRequirementsID(requirements);

    if (requirementsDescriptor != NULL)
    {
        delete requirementsDescriptor;
    }
}


/*extern ODE_API */
dResourceRequirementsID dResourceRequirementsClone(/*const */dResourceRequirementsID requirements)
{
    dAASSERT(requirements != NULL);

    dxResourceRequirementDescriptor *requirementsDescriptor = decodeResourceRequirementsID(requirements);

    dxResourceRequirementDescriptor *descriptorClone = new dxResourceRequirementDescriptor(*requirementsDescriptor);

    dResourceRequirementsID result = encodeResourceRequirementsID(descriptorClone);
    return result;
}

/*extern ODE_API */
void dResourceRequirementsMergeIn(dResourceRequirementsID summaryRequirements, /*const */dResourceRequirementsID extraRequirements)
{
    dAASSERT(summaryRequirements != NULL);
    dAASSERT(extraRequirements != NULL);

    dxResourceRequirementDescriptor *summaryDescriptor = decodeResourceRequirementsID(summaryRequirements);
    dxResourceRequirementDescriptor *extraDescriptor = decodeResourceRequirementsID(extraRequirements);

    summaryDescriptor->mergeAnotherDescriptorIn(*extraDescriptor);
}


//////////////////////////////////////////////////////////////////////////

static inline 
dResourceContainerID encodeResourceContainerID(dxRequiredResourceContainer *containerInstance)
{
    return (dResourceContainerID)containerInstance;
}


/*extern ODE_API */
dResourceContainerID dResourceContainerAcquire(/*const */dResourceRequirementsID requirements)
{
    dAASSERT(requirements != NULL);

    dResourceContainerID result = NULL;
    bool allocationSucceeded = false;
    
    dxRequiredResourceContainer *containerInstance;
    bool containerAllocated = false;

    dxResourceRequirementDescriptor *requirementsInstance = decodeResourceRequirementsID(requirements);

    do
    {
        containerInstance = new dxRequiredResourceContainer();

        if (containerInstance == NULL)
        {
            break;
        }

        containerAllocated = true;
    
        if (!containerInstance->allocateResources(*requirementsInstance))
        {
            break;
        }

    	result = encodeResourceContainerID(containerInstance);
        allocationSucceeded = true;
    }
    while (false);

    if (!allocationSucceeded)
    {
        if (containerAllocated)
        {
            delete containerInstance;
        }
    }
    
    return result;
}

/*extern ODE_API */
void dResourceContainerDestroy(dResourceContainerID resources)
{
    dxRequiredResourceContainer *containerInstance = decodeResourceContainerID(resources);

    if (containerInstance != NULL)
    {
        delete containerInstance;
    }
}