/share/man/man9/thread_exit.9

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 63 lines · 63 code · 0 blank · 0 comment · 0 complexity · 3e66d863f8bb49426414ce54bc25c043 MD5 · raw file 

    

  1. .\"
    2. 

  2. .\" Copyright (c) 2002 Julian Elischer
    3. 

  3. .\" All rights reserved.
    4. 

  4. .\"
    5. 

  5. .\"
    6. 

  6. .\" Redistribution and use in source and binary forms, with or without
    7. 

  7. .\" modification, are permitted provided that the following conditions
    8. 

  8. .\" are met:
    9. 

  9. .\" 1. Redistributions of source code must retain the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer.
    11. 

  11. .\" 2. Redistributions in binary form must reproduce the above copyright
    12. 

  12. .\"    notice, this list of conditions and the following disclaimer in the
    13. 

  13. .\"    documentation and/or other materials provided with the distribution.
    14. 

  14. .\"
    15. 

  15. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    16. 

  16. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    17. 

  17. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    18. 

  18. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    19. 

  19. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    20. 

  20. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    21. 

  21. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    22. 

  22. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    23. 

  23. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    24. 

  24. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    25. 

  25. .\" SUCH DAMAGE.
    26. 

  26. .\"
    27. 

  27. .\" $FreeBSD$
    28. 

  28. .\"
    29. 

  29. .Dd July 5, 2002
    30. 

  30. .Dt THREAD_EXIT 9
    31. 

  31. .Os
    32. 

  32. .Sh NAME
    33. 

  33. .Nm thread_exit
    34. 

  34. .Nd abandon current thread context
    35. 

  35. .Sh SYNOPSIS
    36. 

  36. .In sys/param.h
    37. 

  37. .In sys/proc.h
    38. 

  38. .Ft void
    39. 

  39. .Fn thread_exit "void"
    40. 

  40. .Sh DESCRIPTION
    41. 

  41. The
    42. 

  42. .Fn thread_exit
    43. 

  43. function implements the machine independent prelude to a thread
    44. 

  44. shutdown.
    45. 

  45. It will not return, and will result in a call to
    46. 

  46. .Xr mi_switch 9
    47. 

  47. to schedule some other thread.
    48. 

  48. .Pp
    49. 

  49. .Fn thread_exit
    50. 

  50. arranges to free all the resources of the thread, specifically the kernel
    51. 

  51. stack.
    52. 

  52. .Pp
    53. 

  53. To protect the
    54. 

  54. .Xr runqueue 9 ,
    55. 

  55. .Fn thread_exit
    56. 

  56. must be called with the
    57. 

  57. .Va sched_lock
    58. 

  58. mutex held.
    59. 

  59. .Sh SEE ALSO
    60. 

  60. .Xr mi_switch 9 ,
    61. 

  61. .Xr mutex 9 ,
    62. 

  62. .Xr runqueue 9 ,
    63. 

  63. .Xr sleep 9
    64.