{"id":5393,"date":"2022-06-11T00:01:54","date_gmt":"2022-06-11T07:01:54","guid":{"rendered":"https:\/\/c-for-dummies.com\/blog\/?p=5393"},"modified":"2022-06-18T07:29:05","modified_gmt":"2022-06-18T14:29:05","slug":"leaving-a-thread-early","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=5393","title":{"rendered":"Leaving a Thread Early"},"content":{"rendered":"

Threads in your code go off and do their own thing, running independently from other parts of the code. Still, the thread is established as a function in your source code file. Like any function, it can leave early.
\n
\nYou can use a return<\/em> statement to exit a thread early, but the official way to exit a thread is to use the pthread_exit()<\/em> function:<\/p>\n

void pthread_exit(void *value_ptr);<\/code><\/p>\n

The value_ptr<\/code> argument is a return value, specified as an address. To capture this value, you use the pthread_join()<\/em> function, which was covered in last week’s Lesson<\/a>. This function halts the main thread (or whatever thread it’s running in), waiting for the spawned thread to finish. It’s also the only way to capture the spawned thread’s return value.<\/p>\n

The following code launches a thread to output asterisks. The pthread_join()<\/em> function waits for the launched thread to finish — but the thread exits early after five asterisks are output.<\/p>\n

2022_06_11-Lesson-a.c<\/a><\/h3>\n
\r\n#include <stdio.h>\r\n#include <stdlib.h>\r\n#include <unistd.h>\r\n#include <pthread.h>\r\n\r\nvoid *thread_funct(void *a)\r\n{\r\n    const int loop=8;\r\n    int x;\r\n\r\n    for( x=0; x<loop; x++ )\r\n    {\r\n        if( x==5 )\r\n            pthread_exit(\"I'm done!\");\r\n        printf(\"*\\n\");\r\n        sleep(1);\r\n    }\r\n\r\n    return(NULL);\r\n}\r\n\r\nint main()\r\n{\r\n    char buffer[BUFSIZ];\r\n    int r;\r\n    pthread_t thd;\r\n    void *retval;\r\n\r\n    \/* spawn the new thread *\/<\/span>\r\n    r = pthread_create( &thd, NULL, thread_funct, NULL);\r\n    if( r!=0 )\r\n    {\r\n        perror(\"Thread\");\r\n        exit(1);\r\n    }\r\n    \r\n    \/* wait for the thread *\/<\/span>\r\n    r = pthread_join( thd, &retval );\r\n    if( r!=0 )\r\n    {\r\n        perror(\"Thread join\");\r\n        exit(1);\r\n    }\r\n    printf(\"%s\\n\",(char *)retval);\r\n\r\n    \/* prompt for your name *\/<\/span>\r\n    printf(\"What is your name? \");\r\n    fgets(buffer,BUFSIZ,stdin);\r\n    printf(\"Hello, %s\",buffer);\r\n\r\n    return(0);\r\n}<\/pre>\n
The pthread_join()<\/em> function at Line 38 pauses the main thread until the spawned thread runs to completion. The function’s first argument is the thread handle, thd<\/code>. The second argument is the address of a void<\/em> pointer, retval<\/code>. This is the argument’s proper data type, which handles any return value.<\/p>\n
The launched thread exits early at Line 13 when the value of variable x<\/code> is equal to 5. The pthread_exit()<\/em> function returns the string \"I'm done!\"<\/code>, which is captured by pthread_join()<\/em>. The printf()<\/em> statement at Line 44 outputs the string, casting it from void<\/em> to a char<\/em> pointer. Then the rest of the main()<\/em> function runs.<\/p>\n
Here’s a sample run:<\/p>\n
*
\n*
\n*
\n*
\n*
\nI'm done!
\nWhat is your name? Dan
\nHello, Dan<\/code><\/p>\n
If you want to return a value from the thread, say the integer x<\/code>, you must declare it static<\/em>. Then you return the value’s address. Here’s the modified version of the thread_funct()<\/em> function that returns the value in x<\/code>:<\/p>\n
\r\nvoid *thread_funct(void *a)\r\n{\r\n    const int loop=8;\r\n    static int x;\r\n\r\n    for( x=0; x<loop; x++ )\r\n    {\r\n        if( x==5 )\r\n            pthread_exit(&x);\r\n        printf(\"*\\n\");\r\n        sleep(1);\r\n    }\r\n\r\n    return(NULL);\r\n}<\/pre>\n
The pthread_join()<\/em> call in the main()<\/em> function need not be modified, as it accepts a void<\/em> pointer as its second argument. You must still, however, typecast the thread’s returned value (retval<\/code>) when used in the main()<\/em> function. Here’s the updated printf()<\/em> statement:<\/p>\n
printf(\"The thread returned value: %d\\n\",*((int *)retval) );<\/code><\/p>\n
Click here<\/a> to view the full code on GitHub.<\/p>\n
So what happens when you replace pthread_exit()<\/em> with a simple return<\/em> statement?<\/p>\n
As far as I can tell, the effect appears the same: pthread_exit(\"I'm done!\")<\/code> becomes return(\"I'm done!\")<\/code>, and pthread_exit(&x)<\/code> becomes return(&x)<\/code>. Coders on Stack Overflow write that the Valgrind utility doesn’t report issues when return<\/em> is used instead of pthread_exit()<\/em>. I know of no further scintillating details on the differences.<\/p>\n
In next week’s Lesson<\/a> I wrap up my thread on multithreading with coverage of the pthread_cancel()<\/em> function.<\/p>\n","protected":false},"excerpt":{"rendered":"
Just as you can exit a program or function before it’s complete, you can also exit a thread. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-5393","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5393","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5393"}],"version-history":[{"count":5,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5393\/revisions"}],"predecessor-version":[{"id":5429,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5393\/revisions\/5429"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5393"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5393"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5393"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}