summaryrefslogtreecommitdiff
path: root/utility/rtos_compatibility_layers/posix/px_pth_testcancel.c
blob: e64729dff9136d1f829e787668e3041069107af1 (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
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2026-present Eclipse ThreadX contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/

/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** POSIX wrapper for THREADX                                             */
/**                                                                       */
/**                                                                       */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

/* Include necessary system files.  */

#include "tx_api.h"     /* Threadx API */
#include "pthread.h"    /* Posix API */
#include "px_int.h"     /* Posix helper functions */


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    pthread_testcancel                                  PORTABLE C      */
/*                                                           6.1.7        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    William E. Lamie, Microsoft Corporation                             */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    The pthread_testcancel function shall request that thread be        */
/*    canceled if the cancel state is enabled and cancel type is          */
/*    deferred, and a cancellation request has happened in the past.      */
/*    The target thread's cancelability state and type determines when    */
/*    the cancellation takes effect. When the cancellation is acted on,   */
/*    the cancelation cleanup handlers for thread shall be called. When   */
/*    the last cancelation cleanup handler returns, the thread-specific   */
/*    data destructor functions shall be called for thread. When the last */
/*    destructor function returns, thread shall be terminated.            */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    thread                      pthread handle to thread to be canceled */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*                                                                        */
/*                                                                        */
/*  CALLS                                                                 */
/*         posix_destroy_thread                                           */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
VOID pthread_testcancel(VOID)
{

POSIX_TCB   *pthread_ptr;


    /* Get the thread identifier of the calling pthread */
    pthread_ptr = posix_tid2tcb(pthread_self());

    /* Check if thread was created with cancel enable */
    if ( (pthread_ptr->cancel_state == PTHREAD_CANCEL_ENABLE) &&
           (pthread_ptr->cancel_type==PTHREAD_CANCEL_DEFERRED) &&
           (pthread_ptr->cancel_request==TRUE) )
    {

        /* Signal the housekeeping ThreadX thread to cancel (delete) this pthread */
        posix_destroy_pthread(pthread_ptr,(VOID *)0);
   }
}