Jump to content

Using Threads: Difference between revisions

From EDM2
m Added WIP notice
Rewrote Creating Threads, C++ Code and reformatting
Line 4: Line 4:


After reading the Pthreads Primer, and attmepting to apply it to eCS, I found a need for an introduction to the API and explanations on how to use it.  This is an attempt to fill that void.  --[[User:Myrkraverk|Myrkraverk]] 03:19, 4 November 2007 (CET)
After reading the Pthreads Primer, and attmepting to apply it to eCS, I found a need for an introduction to the API and explanations on how to use it.  This is an attempt to fill that void.  --[[User:Myrkraverk|Myrkraverk]] 03:19, 4 November 2007 (CET)
== Use of C++ in the Examples ==
I am a C++ programmer and frequently run into "small differences" when attempting to use a plain C compiler.  These are mostly differences in automatic variable declaration and initialization which are leveraged somewhat with C99.  However, I do not want to spend my time batting "plain C" syntax peculiarites or C99 feature command line switches, so I simply compile all my examples as C++.
The only "especially C++" feature I use is std::cout instead of printf() which any resonably proficient C programmer can translate on the spot.


== Creating Threads ==
== Creating Threads ==


There are two basic ways to create threads using the OS/2 API, [[OS2 API:DosCreateThread | DosCreateThread()]] and [[OS2 API:CLR:_beginthread | _beginthread()]]. However, note the following from the OpenWatcom C/C++ Programmers Guide:
Thread creation can be done with the [[OS2 API:DosCreateThread | DosCreateThread()]] system call, or the C runtime library [[OS2 API:CLR:_beginthread | _beginthread()]] function.
 
The [[OS2 API:DosCreateThread | DosCreateThread()]] system call is inherently low level and does not initialize the C/C++ runtime environment.  In particular:
 
* You can not assume C++ Exceptions will work.  VisualAge C++ has #pragma handler for this but it '''can not be relied upon''' with OpenWatcom or GCC.
 
* You can not rely on the state of the floating point unit.  You can however, reset it with [[OS2 API:CLR:_fpreset | _fpreset()]].
 
* You can not rely on [[OS2 API:DosExit | DosExit()]] to clear up thread specific data and/or the runtime environment; use [[OS2 API:CLR:_endthread | _endthread()]] instead.
 
: That is, the C/C++ runtime environment may be initialized on first use (this is documented for VisualAge C++ but aparently not for OpenWatcom or GCC).  Also:
 
:: From the OpenWatcom C/C++ Programmer's Guide:
 
::: '''WARNING!'''  If any thread calls a library function, you must use the _beginthread function to create the thread.  Do not use the DosCreateThread API function.
 
:: From the OS/2 Toolkit 4.5:


: '''WARNING!''' If any thread calls a library function, you must use the _beginthread function to create the thread.  Do not use the DosCreateThread API function.
::: '''Note:''' If you use DosCreateThread, you must explicitly call _endthread to terminate the thread.


This makes me want to use _beginthread() all the time, and leave DosCreateThread() to other people.
None of this is an issue when using [[OS2 API:CLR:_beginthread | _beginthread()]]; it takes care of setting up the runtime environment and tearing it down when the thread function ends.


There are some differences, between the two calls, which affect how you use them.  They are not really interchangable.  The most notable differences are the way they return the thread ID to the calling thread, and the parameters passed to the newly created thread are not identical.  The former is just a matter of moving parameters around, when changing one call to the other, the other can cause compiler errors and conversion headaces that can propagate throughout the application, which can be quite a nightmare, if a change from one to the other is made at a late stage in development.
==== Hello, Threaded World! ====


Here is a short example:
Here is a short example of [[OS2 API:CLR:_beginthread | _beginthread()]]:


  // file: hello_thread.c++
  // file: hello_thread.c++
Line 31: Line 53:
  int main( int argc, char *argv[] )
  int main( int argc, char *argv[] )
  {
  {
   _beginthread( hello, 0, 4096, 0 );
   _beginthread( hello, 0, 4096 * 10, 0 );
   DosSleep( 10 );
   DosSleep( 10 );                       // Allow the thread to finish.
  }
  }


Line 43: Line 65:
  >g++ -Zmt "hello_thread.c++"
  >g++ -Zmt "hello_thread.c++"


Here is the same program, using DosCreateThread().
Here is the same program, using DosCreateThread(). Note that it uses a library call, despite the warnings above.
 
'''NOTE:''' This program deliberately disregards 2 reccommendations:
 
* It uses std::cout in a thread created by DosCreateThread() as per the notice above.
* It does not end the thread with _endthread() as per the notice below.
 
From the OS/2 Toolkit 4.5 C Library Reference:
 
: '''Note:''' If you use DosCreateThread, you must explicitly call _endthread to terminate the thread.  


  // file: hello_doscreate.c++
  // file: hello_doscreate.c++
Line 69: Line 82:
   TID tid = 0;
   TID tid = 0;
   DosCreateThread( &tid, hello, 0, CREATE_READY | STACK_SPARSE, 4096 * 10 );
   DosCreateThread( &tid, hello, 0, CREATE_READY | STACK_SPARSE, 4096 * 10 );
   DosSleep( 10 );
   DosSleep( 10 );   // Allow the thread to finish
  }
  }
Despite disregarding both of the notices above, it works.  If you look closely (and have looked at the relevant function prototypes in the Control Program Programming Guide and Reference (CPPGR), C Library Reference (CLR) and/or OpenWatcom C/C++ Programmers Guide (OWCPG), this program uses 10 times the stack size of the former.  This is becouse it results in stack overflow, when compiled with OpenWatcom.  It works with 4K stack space in GCC.


== References ==
== References ==
Line 82: Line 93:
** Control Program Programming Guide and Reference
** Control Program Programming Guide and Reference
** C Library Reference
** C Library Reference
* [http://hobbes.nmsu.edu/pub/os2/dev/emx/v0.9d/emxview.zip EMX 0.9d Documentation] (inf zip) - Direct download link on Hobbes.

Revision as of 18:56, 7 November 2007

NOTICE: This is currently Work In Progress.

Rationale

After reading the Pthreads Primer, and attmepting to apply it to eCS, I found a need for an introduction to the API and explanations on how to use it. This is an attempt to fill that void. --Myrkraverk 03:19, 4 November 2007 (CET)

Use of C++ in the Examples

I am a C++ programmer and frequently run into "small differences" when attempting to use a plain C compiler. These are mostly differences in automatic variable declaration and initialization which are leveraged somewhat with C99. However, I do not want to spend my time batting "plain C" syntax peculiarites or C99 feature command line switches, so I simply compile all my examples as C++.

The only "especially C++" feature I use is std::cout instead of printf() which any resonably proficient C programmer can translate on the spot.

Creating Threads

Thread creation can be done with the DosCreateThread() system call, or the C runtime library _beginthread() function.

The DosCreateThread() system call is inherently low level and does not initialize the C/C++ runtime environment. In particular:

  • You can not assume C++ Exceptions will work. VisualAge C++ has #pragma handler for this but it can not be relied upon with OpenWatcom or GCC.
  • You can not rely on the state of the floating point unit. You can however, reset it with _fpreset().
  • You can not rely on DosExit() to clear up thread specific data and/or the runtime environment; use _endthread() instead.
That is, the C/C++ runtime environment may be initialized on first use (this is documented for VisualAge C++ but aparently not for OpenWatcom or GCC). Also:
From the OpenWatcom C/C++ Programmer's Guide:
WARNING! If any thread calls a library function, you must use the _beginthread function to create the thread. Do not use the DosCreateThread API function.
From the OS/2 Toolkit 4.5:
Note: If you use DosCreateThread, you must explicitly call _endthread to terminate the thread.

None of this is an issue when using _beginthread(); it takes care of setting up the runtime environment and tearing it down when the thread function ends.

Hello, Threaded World!

Here is a short example of _beginthread():

// file: hello_thread.c++
#include <iostream>
#include <process.h>

#define INCL_DOSPROCESS
#include <os2.h>

void hello( void * )
{
  std::cout << "Hello from thread." << std::endl;
}

int main( int argc, char *argv[] )
{
  _beginthread( hello, 0, 4096 * 10, 0 );
  DosSleep( 10 );                       // Allow the thread to finish.
}

This can be compiled with OpenWatcom like so:

>wcl386 -cc++ -bm "hello_thread.c++"

or with GCC like so:

>g++ -Zmt "hello_thread.c++"

Here is the same program, using DosCreateThread(). Note that it uses a library call, despite the warnings above.

// file: hello_doscreate.c++
#include <iostream>

#define INCL_DOSPROCESS
#include <os2.h>

void _System hello( long unsigned int )
{
  std::cout << "Hello from thread." << std::endl;
}

int main( int argc, char *argv[] )
{
  TID tid = 0;
  DosCreateThread( &tid, hello, 0, CREATE_READY | STACK_SPARSE, 4096 * 10 );
  DosSleep( 10 );   // Allow the thread to finish
}

References