source: trunk/kLdr/kLdr.c@ 2853

Last change on this file since 2853 was 2853, checked in by bird, 19 years ago

comment sections

  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1/* $Id: kLdr.c 2853 2006-11-02 03:28:34Z bird $ */
2/** @file
3 *
4 * kLdr - The Dynamic Loader.
5 *
6 * Copyright (c) 2006 knut st. osmundsen <bird@anduin.net>
7 *
8 *
9 * This file is part of kLdr.
10 *
11 * kLdr is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * kLdr is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with kLdr; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *
25 */
26
27/** @mainpage kLdr - The Dynamic Loader
28 *
29 * The purpose of kLdr is to provide a generic interface for querying
30 * information about and loading executable image modules.
31 *
32 * kLdr defines the term executable image to include all kinds of files that contains
33 * binary code that can be executed on a CPU - linker objects (OBJs/Os), shared
34 * objects (SOs), dynamic link libraries (DLLs), executables (EXEs), and all kinds
35 * of kernel modules / device drivers (SYSs).
36 *
37 * kLdr provides two types of services:
38 * -# Inspect or/and load individual modules (kLdrMod).
39 * -# Work as a dynamic loader - construct and maintain an address space (kLdrDy).
40 *
41 * The kLdrMod API works on KLDRMOD structures where all the internals are exposed, while
42 * the kLdrDy API works opque KLDRDY structures. KLDRDY are in reality simple wrappers
43 * around KLDRMOD with some extra linking and attributes.
44 *
45 */
46
47
48
49
50/*******************************************************************************
51* Header Files *
52*******************************************************************************/
53#include "kLdr.h"
54#include "kLdrHlp.h"
55
56
57/*******************************************************************************
58* Global Variables *
59*******************************************************************************/
60/** Flag indicating whether we've initialized the loader or not.
61 *
62 * 0 if not initialized.
63 * -1 if we're initializing or terminating.
64 * 1 if we've successfully initialized it.
65 * -2 if initialization failed.
66 */
67static int volatile g_fInitialized;
68
69
70
71/**
72 * Initializes the loader.
73 * @returns 0 on success, non-zero OS status code on failure.
74 */
75int kldrInit(void)
76{
77 int rc;
78
79 /* check we're already good. */
80 if (g_fInitialized == 1)
81 return 0;
82
83 /* a tiny serialization effort. */
84 for (;;)
85 {
86 if (g_fInitialized == 1)
87 return 0;
88 if (g_fInitialized == -2)
89 return -1;
90 /** @todo atomic test and set if we care. */
91 if (g_fInitialized == 0)
92 {
93 g_fInitialized = -1;
94 break;
95 }
96 kldrHlpSleep(1);
97 }
98
99 /*
100 * Do the initialization.
101 */
102 rc = kldrHlpHeapInit();
103 if (!rc)
104 {
105 rc = kldrHlpSemInit();
106 if (!rc)
107 {
108 g_fInitialized = 1;
109 return 0;
110 }
111 kldrHlpHeapTerm();
112 }
113 g_fInitialized = -2;
114 return rc;
115}
116
117
118/**
119 * Terminates the loader.
120 */
121void kldrTerm(void)
122{
123 /* can't terminate unless it's initialized. */
124 if (g_fInitialized != 1)
125 return;
126 g_fInitialized = -1;
127
128 /*
129 * Do the termination.
130 */
131 kldrHlpSemTerm();
132 kldrHlpHeapTerm();
133
134 /* done */
135 g_fInitialized = 0;
136}
137
Note: See TracBrowser for help on using the repository browser.