[IBAL] work around for reference count leakage bugs. [mlnx: 4404]
[mirror/winof/.git] / core / al / al_common.c
1 /*\r
2  * Copyright (c) 2005 SilverStorm Technologies.  All rights reserved.\r
3  * Copyright (c) 1996-2003 Intel Corporation. All rights reserved. \r
4  * Portions Copyright (c) 2008 Microsoft Corporation.  All rights reserved.\r
5  *\r
6  * This software is available to you under the OpenIB.org BSD license\r
7  * below:\r
8  *\r
9  *     Redistribution and use in source and binary forms, with or\r
10  *     without modification, are permitted provided that the following\r
11  *     conditions are met:\r
12  *\r
13  *      - Redistributions of source code must retain the above\r
14  *        copyright notice, this list of conditions and the following\r
15  *        disclaimer.\r
16  *\r
17  *      - Redistributions in binary form must reproduce the above\r
18  *        copyright notice, this list of conditions and the following\r
19  *        disclaimer in the documentation and/or other materials\r
20  *        provided with the distribution.\r
21  *\r
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,\r
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
25  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\r
26  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\r
27  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
28  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r
29  * SOFTWARE.\r
30  *\r
31  * $Id$\r
32  */\r
33 \r
34 #include "al.h"\r
35 #include "al_ci_ca.h"\r
36 #include "al_common.h"\r
37 #include "al_debug.h"\r
38 #include "al_ca.h"\r
39 \r
40 #if defined(EVENT_TRACING)\r
41 #ifdef offsetof\r
42 #undef offsetof\r
43 #endif\r
44 #include "al_common.tmh"\r
45 #endif\r
46 \r
47 #include "al_mgr.h"\r
48 #include <complib/cl_math.h>\r
49 #include "ib_common.h"\r
50 #include "bus_ev_log.h"\r
51 \r
52 \r
53 \r
54 #if AL_OBJ_PRIVATE_ASYNC_PROC\r
55 cl_async_proc_t         *gp_async_obj_mgr = NULL;\r
56 #endif\r
57 \r
58 \r
59 boolean_t\r
60 destroy_obj(\r
61         IN                              struct _al_obj                          *p_obj,\r
62         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb );\r
63 \r
64 \r
65 void\r
66 async_destroy_cb(\r
67         IN                              cl_async_proc_item_t            *p_item );\r
68 \r
69 \r
70 void\r
71 async_destroy_obj(\r
72         IN                              struct _al_obj                          *p_obj,\r
73         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb );\r
74 \r
75 \r
76 void\r
77 sync_destroy_obj(\r
78         IN                              struct _al_obj                          *p_obj,\r
79         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb );\r
80 \r
81 \r
82 \r
83 const char* ib_obj_type_str[] =\r
84 {\r
85         "AL_OBJ_TYPE_UNKNOWN",\r
86         "AL_OBJ_TYPE_H_AL",\r
87         "AL_OBJ_TYPE_H_QP",\r
88         "AL_OBJ_TYPE_H_AV",\r
89         "AL_OBJ_TYPE_H_MR",\r
90         "AL_OBJ_TYPE_H_MW",\r
91         "AL_OBJ_TYPE_H_PD",\r
92         "AL_OBJ_TYPE_H_CA",\r
93         "AL_OBJ_TYPE_H_CQ",\r
94         "AL_OBJ_TYPE_H_CONN",\r
95         "AL_OBJ_TYPE_H_LISTEN",\r
96         "AL_OBJ_TYPE_H_IOC",\r
97         "AL_OBJ_TYPE_H_SVC_ENTRY",\r
98         "AL_OBJ_TYPE_H_PNP",\r
99         "AL_OBJ_TYPE_H_SA_REQ",\r
100         "AL_OBJ_TYPE_H_MCAST",\r
101         "AL_OBJ_TYPE_H_ATTACH",\r
102         "AL_OBJ_TYPE_H_MAD",\r
103         "AL_OBJ_TYPE_H_MAD_POOL",\r
104         "AL_OBJ_TYPE_H_POOL_KEY",\r
105         "AL_OBJ_TYPE_H_MAD_SVC",\r
106         "AL_OBJ_TYPE_CI_CA",\r
107         "AL_OBJ_TYPE_CM",\r
108         "AL_OBJ_TYPE_SMI",\r
109         "AL_OBJ_TYPE_DM",\r
110         "AL_OBJ_TYPE_IOU",\r
111         "AL_OBJ_TYPE_LOADER",\r
112         "AL_OBJ_TYPE_MAD_POOL",\r
113         "AL_OBJ_TYPE_MAD_DISP",\r
114         "AL_OBJ_TYPE_AL_MGR",\r
115         "AL_OBJ_TYPE_PNP_MGR",\r
116         "AL_OBJ_TYPE_IOC_PNP_MGR",\r
117         "AL_OBJ_TYPE_IOC_PNP_SVC",\r
118         "AL_OBJ_TYPE_QUERY_SVC",\r
119         "AL_OBJ_TYPE_MCAST_SVC",\r
120         "AL_OBJ_TYPE_SA_REQ_SVC",\r
121         "AL_OBJ_TYPE_RES_MGR",\r
122         "AL_OBJ_TYPE_H_CA_ATTR",\r
123         "AL_OBJ_TYPE_H_PNP_EVENT",\r
124         "AL_OBJ_TYPE_H_SA_REG",\r
125         "AL_OBJ_TYPE_H_FMR",\r
126         "AL_OBJ_TYPE_H_SRQ",\r
127         "AL_OBJ_TYPE_H_FMR_POOL",\r
128         "AL_OBJ_TYPE_NDI"\r
129 };\r
130 \r
131 \r
132 /*\r
133  * Used to force synchronous destruction of AL objects.\r
134  */\r
135 void\r
136 __sync_destroy_cb(\r
137         IN                              void                                            *context )\r
138 {\r
139         UNUSED_PARAM( context );\r
140 }\r
141 \r
142 \r
143 void\r
144 construct_al_obj(\r
145         IN                              al_obj_t * const                        p_obj,\r
146         IN              const   al_obj_type_t                           obj_type )\r
147 {\r
148         CL_ASSERT( p_obj );\r
149         cl_memclr( p_obj, sizeof( al_obj_t ) );\r
150 \r
151         cl_spinlock_construct( &p_obj->lock );\r
152         p_obj->state = CL_UNINITIALIZED;\r
153         p_obj->type = obj_type;\r
154         p_obj->timeout_ms = AL_DEFAULT_TIMEOUT_MS;\r
155         p_obj->ref_cnt = 1;\r
156         cl_event_construct( &p_obj->event );\r
157 \r
158         /* Insert the object into the global tracking list. */\r
159         if( p_obj != &gp_al_mgr->obj )\r
160         {\r
161                 cl_spinlock_acquire( &gp_al_mgr->lock );\r
162                 cl_qlist_insert_tail( &gp_al_mgr->al_obj_list, &p_obj->list_item );\r
163                 cl_spinlock_release( &gp_al_mgr->lock );\r
164                 ref_al_obj( &gp_al_mgr->obj );\r
165         }\r
166 }\r
167 \r
168 \r
169 \r
170 ib_api_status_t\r
171 init_al_obj(\r
172         IN                              al_obj_t * const                        p_obj,\r
173         IN              const   void* const                                     context,\r
174         IN                              boolean_t                                       async_destroy,\r
175         IN              const   al_pfn_destroying_t                     pfn_destroying,\r
176         IN              const   al_pfn_cleanup_t                        pfn_cleanup,\r
177         IN              const   al_pfn_free_t                           pfn_free )\r
178 {\r
179         cl_status_t                             cl_status;\r
180 \r
181         AL_ENTER( AL_DBG_AL_OBJ );\r
182         CL_ASSERT( p_obj && pfn_free );\r
183         CL_ASSERT( p_obj->state == CL_UNINITIALIZED );\r
184         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
185                 ("%p\n", p_obj ) );\r
186 \r
187         /* Initialize the object. */\r
188         p_obj->async_item.pfn_callback = async_destroy_cb;\r
189         p_obj->pfn_free = pfn_free;\r
190 \r
191         p_obj->context = context;\r
192 \r
193         if( async_destroy )\r
194                 p_obj->pfn_destroy = async_destroy_obj;\r
195         else\r
196                 p_obj->pfn_destroy = sync_destroy_obj;\r
197 \r
198         p_obj->pfn_destroying = pfn_destroying;\r
199 \r
200         p_obj->pfn_cleanup = pfn_cleanup;\r
201         p_obj->user_destroy_cb = NULL;\r
202 \r
203         cl_qlist_init( &p_obj->obj_list );\r
204         cl_status = cl_spinlock_init( &p_obj->lock );\r
205         if( cl_status != CL_SUCCESS )\r
206         {\r
207                 return ib_convert_cl_status( cl_status );\r
208         }\r
209 \r
210         cl_status = cl_event_init( &p_obj->event, FALSE );\r
211         if( cl_status != CL_SUCCESS )\r
212         {\r
213                 return ib_convert_cl_status( cl_status );\r
214         }\r
215 \r
216         p_obj->state = CL_INITIALIZED;\r
217 \r
218         /*\r
219          * Hold an extra reference on the object until creation is complete.\r
220          * This prevents a client's destruction of the object during asynchronous\r
221          * event callback processing from deallocating the object before the\r
222          * creation is complete.\r
223          */\r
224         ref_al_obj( p_obj );\r
225 \r
226         AL_EXIT( AL_DBG_AL_OBJ );\r
227         return IB_SUCCESS;\r
228 }\r
229 \r
230 \r
231 void\r
232 reset_al_obj(\r
233         IN                              al_obj_t * const                        p_obj )\r
234 {\r
235         CL_ASSERT( p_obj && (p_obj->ref_cnt == 0) );\r
236         CL_ASSERT( p_obj->state == CL_DESTROYING );\r
237 \r
238         p_obj->ref_cnt = 1;\r
239         p_obj->desc_cnt = 0;\r
240         p_obj->state = CL_INITIALIZED;\r
241         p_obj->h_al = NULL;\r
242         p_obj->hdl = AL_INVALID_HANDLE;\r
243 }\r
244 \r
245 \r
246 \r
247 void\r
248 set_al_obj_timeout(\r
249         IN                              al_obj_t * const                        p_obj,\r
250         IN              const   uint32_t                                        timeout_ms )\r
251 {\r
252         CL_ASSERT( p_obj );\r
253 \r
254         /* Only increase timeout values. */\r
255         p_obj->timeout_ms = MAX( p_obj->timeout_ms, timeout_ms );\r
256 }\r
257 \r
258 \r
259 \r
260 void\r
261 inc_al_obj_desc(\r
262         IN                              al_obj_t * const                        p_obj,\r
263         IN              const   uint32_t                                        desc_cnt )\r
264 {\r
265         CL_ASSERT( p_obj );\r
266 \r
267         /* Increment the number of descendants. */\r
268         p_obj->desc_cnt += desc_cnt;\r
269 }\r
270 \r
271 \r
272 \r
273 ib_api_status_t\r
274 attach_al_obj(\r
275         IN                              al_obj_t * const                        p_parent_obj,\r
276         IN                              al_obj_t * const                        p_child_obj )\r
277 {\r
278         AL_ENTER( AL_DBG_AL_OBJ );\r
279         \r
280         CL_ASSERT( p_child_obj->state == CL_INITIALIZED );\r
281 \r
282         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
283                 ("%p(%s) to %p(%s)\n",\r
284                 p_child_obj, ib_get_obj_type( p_child_obj ),\r
285                 p_parent_obj, ib_get_obj_type( p_parent_obj ) ) );\r
286 \r
287         /* Insert the object into the parent's object tracking list. */\r
288         p_child_obj->p_ci_ca = p_parent_obj->p_ci_ca;\r
289         cl_spinlock_acquire( &p_parent_obj->lock );\r
290         if( p_parent_obj->state != CL_INITIALIZED )\r
291         {\r
292                 cl_spinlock_release( &p_parent_obj->lock );\r
293                 return IB_INVALID_STATE;\r
294         }\r
295         cl_qlist_insert_tail( &p_parent_obj->obj_list,\r
296                 (cl_list_item_t*)&p_child_obj->pool_item );\r
297         p_child_obj->p_parent_obj = p_parent_obj;\r
298         cl_spinlock_release( &p_parent_obj->lock );\r
299 \r
300         if( p_parent_obj->h_al )\r
301         {\r
302                 if( !p_child_obj->h_al )\r
303                 {\r
304                         p_child_obj->h_al = p_parent_obj->h_al;\r
305 #ifdef CL_KERNEL\r
306                         p_child_obj->hdl = al_hdl_insert_obj( p_child_obj );\r
307                         if( p_child_obj->hdl == AL_INVALID_HANDLE )\r
308                         {\r
309                                 cl_spinlock_acquire( &p_parent_obj->lock );\r
310                                 cl_qlist_remove_item( &p_parent_obj->obj_list,\r
311                                         (cl_list_item_t*)&p_child_obj->pool_item );\r
312                                 p_child_obj->p_parent_obj = NULL;\r
313                                 cl_spinlock_release( &p_parent_obj->lock );\r
314                                 return IB_INSUFFICIENT_MEMORY;\r
315                         }\r
316 #endif\r
317                 }\r
318                 else\r
319                 {\r
320                         CL_ASSERT( p_child_obj->h_al == p_parent_obj->h_al );\r
321                 }\r
322         }\r
323 \r
324         /* Reference the parent. */\r
325         ref_al_obj( p_parent_obj );\r
326         AL_EXIT( AL_DBG_AL_OBJ );\r
327         return IB_SUCCESS;\r
328 }\r
329 \r
330 \r
331 \r
332 /*\r
333  * Called to release a child object from its parent.\r
334  */\r
335 void\r
336 detach_al_obj(\r
337         IN                              al_obj_t * const                        p_obj )\r
338 {\r
339         al_obj_t                                *p_parent_obj;\r
340 \r
341         AL_ENTER( AL_DBG_AL_OBJ );\r
342         \r
343         p_parent_obj = p_obj->p_parent_obj;\r
344         CL_ASSERT( p_obj );\r
345         CL_ASSERT( p_obj->state == CL_INITIALIZED ||\r
346                 p_obj->state == CL_DESTROYING );\r
347         CL_ASSERT( p_parent_obj );\r
348         CL_ASSERT( p_parent_obj->state == CL_INITIALIZED ||\r
349                 p_parent_obj->state == CL_DESTROYING );\r
350 \r
351         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
352                 ("%p(%s) from %p(%s)\n",\r
353                 p_obj, ib_get_obj_type( p_obj ),\r
354                 p_parent_obj, ib_get_obj_type( p_parent_obj ) ) );\r
355 \r
356         /* Remove the object from the parent's list. */\r
357         cl_spinlock_acquire( &p_parent_obj->lock );\r
358         cl_qlist_remove_item( &p_parent_obj->obj_list,\r
359                 (cl_list_item_t*)&p_obj->pool_item );\r
360         cl_spinlock_release( &p_parent_obj->lock );\r
361         AL_EXIT( AL_DBG_AL_OBJ );\r
362 }\r
363 \r
364 \r
365 \r
366 /*\r
367  * Increment a reference count on an object.  This object should not be\r
368  * an object's parent.\r
369  */\r
370 int32_t\r
371 ref_al_obj(\r
372         IN                              al_obj_t * const                        p_obj )\r
373 {\r
374         uint32_t        ref_cnt;\r
375 \r
376         AL_ENTER( AL_DBG_AL_OBJ );\r
377         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
378                 ("%p(%s)\n", p_obj, ib_get_obj_type( p_obj ) ) );\r
379         ref_cnt = cl_atomic_inc( &p_obj->ref_cnt );\r
380         CL_ASSERT( ref_cnt != 1 || p_obj->type == AL_OBJ_TYPE_H_CQ );\r
381 \r
382         AL_EXIT( AL_DBG_AL_OBJ );\r
383         return ref_cnt;\r
384 }\r
385 \r
386 \r
387 \r
388 /*\r
389  * Decrement the reference count on an AL object.  Destroy the object if\r
390  * it is no longer referenced.  This object should not be an object's parent.\r
391  */\r
392 int32_t\r
393 deref_al_obj(\r
394         IN                              al_obj_t * const                        p_obj )\r
395 {\r
396         int32_t                 ref_cnt;\r
397 \r
398         AL_ENTER( AL_DBG_AL_OBJ );\r
399 \r
400         CL_ASSERT( p_obj );\r
401         CL_ASSERT( p_obj->state == CL_INITIALIZED ||\r
402                 p_obj->state == CL_DESTROYING );\r
403         CL_ASSERT( p_obj->ref_cnt );\r
404 \r
405         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
406                 ("%p(%s)\n", p_obj, ib_get_obj_type( p_obj ) ) );\r
407 \r
408         ref_cnt = cl_atomic_dec( &p_obj->ref_cnt );\r
409 \r
410         /* If the reference count went to 0, the object should be destroyed. */\r
411         if( ref_cnt == 0 )\r
412         {\r
413                 if( p_obj->pfn_destroy == async_destroy_obj &&\r
414                         p_obj->user_destroy_cb != __sync_destroy_cb )\r
415                 {\r
416                         /* Queue the object for asynchronous destruction. */\r
417 #if AL_OBJ_PRIVATE_ASYNC_PROC\r
418                         cl_async_proc_queue( gp_async_obj_mgr, &p_obj->async_item );\r
419 #else\r
420                         cl_async_proc_queue( gp_async_proc_mgr, &p_obj->async_item );\r
421 #endif\r
422                 }\r
423                 else\r
424                 {\r
425                         /* Signal an event for synchronous destruction. */\r
426                         cl_event_signal( &p_obj->event );\r
427                 }\r
428         }\r
429 \r
430         AL_EXIT( AL_DBG_AL_OBJ );\r
431         return ref_cnt;\r
432 }\r
433 \r
434 \r
435 \r
436 /*\r
437  * Called to cleanup all resources allocated by an object.\r
438  */\r
439 void\r
440 destroy_al_obj(\r
441         IN                              al_obj_t * const                        p_obj )\r
442 {\r
443         AL_ENTER( AL_DBG_AL_OBJ );\r
444 \r
445         CL_ASSERT( p_obj );\r
446         CL_ASSERT( p_obj->state == CL_DESTROYING ||\r
447                 p_obj->state == CL_UNINITIALIZED );\r
448         CL_ASSERT( cl_is_qlist_empty( &p_obj->obj_list ) );\r
449 \r
450         /* Remove the object from the global tracking list. */\r
451         if( p_obj != &gp_al_mgr->obj )\r
452         {\r
453                 cl_spinlock_acquire( &gp_al_mgr->lock );\r
454                 cl_qlist_remove_item( &gp_al_mgr->al_obj_list, &p_obj->list_item );\r
455                 cl_spinlock_release( &gp_al_mgr->lock );\r
456                 deref_al_obj( &gp_al_mgr->obj );\r
457         }\r
458 \r
459         cl_event_destroy( &p_obj->event );\r
460         cl_spinlock_destroy( &p_obj->lock );\r
461         p_obj->state = CL_DESTROYED;\r
462 \r
463         AL_EXIT( AL_DBG_AL_OBJ );\r
464 }\r
465 \r
466 \r
467 \r
468 void\r
469 async_destroy_obj(\r
470         IN                              struct _al_obj                          *p_obj,\r
471         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb )\r
472 {\r
473         AL_ENTER( AL_DBG_AL_OBJ );\r
474 \r
475         if( pfn_destroy_cb == ib_sync_destroy )\r
476                 sync_destroy_obj( p_obj, pfn_destroy_cb );\r
477         else if( destroy_obj( p_obj, pfn_destroy_cb ) )\r
478                 deref_al_obj( p_obj );  /* Only destroy the object once. */\r
479 \r
480         AL_EXIT( AL_DBG_AL_OBJ );\r
481 }\r
482 \r
483 \r
484 \r
485 void\r
486 sync_destroy_obj(\r
487         IN                              struct _al_obj                          *p_obj,\r
488         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb )\r
489 {\r
490         cl_status_t             cl_status;\r
491 \r
492         AL_ENTER( AL_DBG_AL_OBJ );\r
493 \r
494         if( !destroy_obj( p_obj, pfn_destroy_cb ) )\r
495         {\r
496                 /* Object is already being destroyed... */\r
497                 AL_EXIT( AL_DBG_AL_OBJ );\r
498                 return;\r
499         }\r
500 \r
501         if( deref_al_obj( p_obj ) )\r
502         {\r
503                 uint32_t                wait_us;\r
504                 /*\r
505                  * Wait for all other references to go away.  We wait as long as the\r
506                  * longest child will take, plus an additional amount based on the\r
507                  * number of descendants.\r
508                  */\r
509                 wait_us = (p_obj->timeout_ms * 1000) +\r
510                         (AL_TIMEOUT_PER_DESC_US * p_obj->desc_cnt);\r
511                 wait_us = MIN( wait_us, AL_MAX_TIMEOUT_US );\r
512                 do\r
513                 {\r
514                         cl_status = cl_event_wait_on(\r
515                                 &p_obj->event, wait_us, AL_WAIT_ALERTABLE );\r
516                 } while( cl_status == CL_NOT_DONE );\r
517 \r
518                 if( cl_status != CL_SUCCESS )\r
519                 {\r
520                         AL_PRINT( TRACE_LEVEL_ERROR, AL_DBG_ERROR,\r
521                                 ("Error waiting for references to be released - delaying.\n") );\r
522                         print_al_obj( p_obj );\r
523                         /*\r
524                          * Wait some more to handle really long timeouts by referencing\r
525                          * objects that are not descendants.\r
526                          */\r
527                         do\r
528                         {\r
529                                 cl_status = cl_event_wait_on(\r
530                                         &p_obj->event, AL_MAX_TIMEOUT_US, AL_WAIT_ALERTABLE );\r
531                         } while( cl_status == CL_NOT_DONE );\r
532                 }\r
533                 if ( p_obj->p_ci_ca && p_obj->p_ci_ca )\r
534                         CL_PRINT_TO_EVENT_LOG( p_obj->p_ci_ca->h_ca->p_fdo, EVENT_IBBUS_ANY_ERROR,\r
535                                 ("IBAL stuck: AL object %s, ref_cnt: %d. Forcing object destruction.\n",\r
536                                 ib_get_obj_type( p_obj ), p_obj->ref_cnt));\r
537 \r
538                 CL_ASSERT( cl_status == CL_SUCCESS );\r
539                 if( cl_status != CL_SUCCESS )\r
540                 {\r
541                         AL_PRINT( TRACE_LEVEL_ERROR, AL_DBG_ERROR,\r
542                                 ("Forcing object destruction.\n") );\r
543                         print_al_obj( p_obj );\r
544                         //print_tail_al_objs();\r
545                         print_al_objs( p_obj->h_al );\r
546                         p_obj->ref_cnt = 0;\r
547                 }\r
548         }\r
549         async_destroy_cb( &p_obj->async_item );\r
550 \r
551         AL_EXIT( AL_DBG_AL_OBJ );\r
552 }\r
553 \r
554 \r
555 \r
556 boolean_t\r
557 destroy_obj(\r
558         IN                              struct _al_obj                          *p_obj,\r
559         IN              const   ib_pfn_destroy_cb_t                     pfn_destroy_cb )\r
560 {\r
561         cl_list_item_t                  *p_list_item;\r
562         al_obj_t                                *p_child_obj;\r
563 \r
564         AL_ENTER( AL_DBG_AL_OBJ );\r
565 \r
566         CL_ASSERT( p_obj );\r
567         CL_ASSERT( p_obj->state == CL_INITIALIZED ||\r
568                 p_obj->state == CL_DESTROYING );\r
569 \r
570         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
571                 ("%p(%s)\n", p_obj, ib_get_obj_type( p_obj ) ) );\r
572 \r
573         /*\r
574          * Lock to synchronize with asynchronous event processing.\r
575          * See ci_ca_async_event_cb for more information.\r
576          */\r
577         cl_spinlock_acquire( &p_obj->lock );\r
578         if( p_obj->state == CL_DESTROYING )\r
579         {\r
580                 cl_spinlock_release( &p_obj->lock );\r
581                 deref_al_obj( p_obj );\r
582                 AL_EXIT( AL_DBG_AL_OBJ );\r
583                 return FALSE;\r
584         }\r
585         p_obj->state = CL_DESTROYING;\r
586         cl_spinlock_release( &p_obj->lock );\r
587         deref_al_obj( p_obj );\r
588 \r
589 #ifdef CL_KERNEL\r
590         /*\r
591          * Release this object's handle.  We must do this before calling the\r
592          * destroy callback so that any IOCTLs referencing this object will fail\r
593          */\r
594         if( p_obj->hdl != AL_INVALID_HANDLE )\r
595         {\r
596                 CL_ASSERT( p_obj->h_al );\r
597                 al_hdl_free_obj( p_obj );\r
598         }\r
599 #endif\r
600 \r
601         /* Notify the object that it is being destroyed. */\r
602         if( p_obj->pfn_destroying )\r
603                 p_obj->pfn_destroying( p_obj );\r
604 \r
605         if( p_obj->p_parent_obj )\r
606                 detach_al_obj( p_obj );\r
607 \r
608         /*      Destroy all child resources.  No need to lock during destruction. */\r
609         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ, ("destroying children\n") );\r
610         p_list_item = cl_qlist_tail( &p_obj->obj_list );\r
611         while( p_list_item != cl_qlist_end( &p_obj->obj_list ) )\r
612         {\r
613                 p_child_obj = PARENT_STRUCT( p_list_item, al_obj_t, pool_item );\r
614                 CL_ASSERT( p_child_obj->pfn_destroy );\r
615                 AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
616                         ("bye bye: %p(%s)\n", p_child_obj,\r
617                         ib_get_obj_type( p_child_obj ) ) );\r
618                 ref_al_obj( p_child_obj );\r
619                 p_child_obj->pfn_destroy( p_child_obj, NULL );\r
620 \r
621                 p_list_item = cl_qlist_tail( &p_obj->obj_list );\r
622         }\r
623 \r
624         /*\r
625          * Update our parent's timeout value.  Ours could have been increased\r
626          * when destroying one of our children's.\r
627          */\r
628         if( p_obj->p_parent_obj )\r
629         {\r
630                 set_al_obj_timeout( p_obj->p_parent_obj, p_obj->timeout_ms );\r
631                 inc_al_obj_desc( p_obj->p_parent_obj, p_obj->desc_cnt + 1 );\r
632         }\r
633 \r
634         if( pfn_destroy_cb == ib_sync_destroy )\r
635                 p_obj->user_destroy_cb = __sync_destroy_cb;\r
636         else\r
637                 p_obj->user_destroy_cb = pfn_destroy_cb;\r
638 \r
639         AL_EXIT( AL_DBG_AL_OBJ );\r
640         return TRUE;\r
641 }\r
642 \r
643 \r
644 \r
645 void\r
646 async_destroy_cb(\r
647         IN                              cl_async_proc_item_t            *p_item )\r
648 {\r
649         al_obj_t                                *p_obj;\r
650         al_obj_t                                *p_parent_obj = NULL;\r
651 \r
652         AL_ENTER( AL_DBG_AL_OBJ );\r
653 \r
654         CL_ASSERT( p_item );\r
655         p_obj = PARENT_STRUCT( p_item, al_obj_t, async_item );\r
656         CL_ASSERT( p_obj );\r
657         CL_ASSERT( p_obj->state == CL_DESTROYING );\r
658         CL_ASSERT( !p_obj->ref_cnt );\r
659 \r
660         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ,\r
661                 ("%p\n", p_obj ) );\r
662 \r
663         /* Cleanup any hardware related resources. */\r
664         if( p_obj->pfn_cleanup )\r
665         {\r
666                 AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ, ("cleaning up\n" ) );\r
667                 p_obj->pfn_cleanup( p_obj );\r
668         }\r
669 \r
670         /* We can now safely dereference the parent. */\r
671         if( p_obj->p_parent_obj )\r
672         {\r
673                 p_parent_obj = p_obj->p_parent_obj;\r
674                 p_obj->p_parent_obj = NULL;\r
675         }\r
676 \r
677         /* Notify the user that we're done. */\r
678         if( p_obj->user_destroy_cb )\r
679         {\r
680                 AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ, ("notifying user\n" ) );\r
681                 p_obj->user_destroy_cb( (void*)p_obj->context );\r
682         }\r
683 \r
684         /* Free the resources associated with the object. */\r
685         AL_PRINT( TRACE_LEVEL_INFORMATION, AL_DBG_AL_OBJ, ("freeing object\n" ) );\r
686         p_obj->pfn_free( p_obj );\r
687 \r
688         /* Dereference the parent after freeing the child. */\r
689         if( p_parent_obj )\r
690                 deref_al_obj( p_parent_obj );\r
691         AL_EXIT( AL_DBG_AL_OBJ );\r
692 }\r