1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** POSIX wrapper for THREADX                                             */
16 /**                                                                       */
17 /**                                                                       */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 /* Include necessary system files.  */
23 
24 #include "tx_api.h"     /* Threadx API */
25 #include "pthread.h"    /* Posix API */
26 #include "px_int.h"     /* Posix helper functions */
27 
28 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    pthread_mutex_destroy                               PORTABLE C      */
34 /*                                                           6.1.7        */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    William E. Lamie, Microsoft Corporation                             */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function shall destroy the mutex object referenced by mutex;   */
42 /*    the mutex object becomes,in effect, uninitialized.A destroyed mutex */
43 /*    object can be reinitialized using pthread_mutex_init()              */
44 /*    It shall be safe to destroy an initialized mutex that is unlocked.  */
45 /*    Attempting to destroy a locked mutex results in undefined behavior. */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    mutex                          Address of the mutex                 */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*     0                             If successful                        */
54 /*     Value                         In case of any error                 */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    tx_mutex_delete                ThreadX Mutex service                */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  06-02-2021     William E. Lamie         Initial Version 6.1.7         */
69 /*                                                                        */
70 /**************************************************************************/
pthread_mutex_destroy(pthread_mutex_t * mutex)71 INT pthread_mutex_destroy(pthread_mutex_t *mutex)
72 {
73 
74 TX_INTERRUPT_SAVE_AREA
75 
76 TX_MUTEX       *mutex_ptr;
77 INT             status,retval;
78 
79     /* Disable interrupts.  */
80     TX_DISABLE
81 
82     mutex_ptr = (TX_MUTEX*) mutex;
83 
84     status = tx_mutex_delete(mutex_ptr);
85     if (status == TX_SUCCESS)
86     {
87         mutex->in_use = TX_FALSE;
88         retval = OK;
89     }
90     else
91     {
92         posix_errno  = EINVAL;
93 	    posix_set_pthread_errno(EINVAL);
94         retval = EINVAL;
95     }
96 
97     TX_RESTORE
98     return(retval);
99 }
100