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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>KSquirrel: development</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name='Author' content='Baryshev Dmitry/Krasu'>
<link rel="stylesheet" href="styles.css" type="text/css">
</head>
<body>
<DIV
CLASS="ARTICLE"
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
><A
NAME="AEN2"
></A
>C++ dlopen mini HOWTO</H1
><H3
CLASS="author"
><A
NAME="AEN4"
>Aaron Isotton</A
></H3
><DIV
CLASS="affiliation"
><DIV
CLASS="address"
><P
CLASS="address"
><TT
CLASS="email"
><<A
HREF="mailto:[email protected]"
>[email protected]</A
>></TT
></P
></DIV
></DIV
><P
CLASS="pubdate"
>2003-08-12<BR></P
><DIV
CLASS="revhistory"
><TABLE
WIDTH="100%"
BORDER="0"
><TR
><TH
ALIGN="LEFT"
VALIGN="TOP"
COLSPAN="3"
><B
>Revision History</B
></TH
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 1.03</TD
><TD
ALIGN="LEFT"
>2003-08-12</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Added reference to the GLib Dynamic Module
Loader. Thanks to G. V. Sriraam for the pointer.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 1.02</TD
><TD
ALIGN="LEFT"
>2002-12-08</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Added FAQ. Minor changes</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 1.01</TD
><TD
ALIGN="LEFT"
>2002-06-30</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Updated virtual destructor explanation. Minor changes.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 1.00</TD
><TD
ALIGN="LEFT"
>2002-06-19</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Moved copyright and license section to the
beginning. Added terms section. Minor changes.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 0.97</TD
><TD
ALIGN="LEFT"
>2002-06-19</TD
><TD
ALIGN="LEFT"
>Revised by: JYG</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Entered minor grammar and sentence level changes.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 0.96</TD
><TD
ALIGN="LEFT"
>2002-06-12</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Added bibliography. Corrected explanation of extern
functions and variables.</TD
></TR
><TR
><TD
ALIGN="LEFT"
>Revision 0.95</TD
><TD
ALIGN="LEFT"
>2002-06-11</TD
><TD
ALIGN="LEFT"
>Revised by: AI</TD
></TR
><TR
><TD
ALIGN="LEFT"
COLSPAN="3"
>Minor improvements.</TD
></TR
></TABLE
></DIV
><DIV
><DIV
CLASS="abstract"
><A
NAME="AEN47"
></A
><P
></P
><P
>How to dynamically load C++ functions and classes using
the <TT
CLASS="function"
>dlopen</TT
> API.</P
><P
></P
></DIV
></DIV
><HR></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1. <A
HREF="#intro"
>Introduction</A
></DT
><DD
><DL
><DT
>1.1. <A
HREF="#copyright"
>Copyright and License</A
></DT
><DT
>1.2. <A
HREF="#disclaimer"
>Disclaimer</A
></DT
><DT
>1.3. <A
HREF="#credits"
>Credits / Contributors</A
></DT
><DT
>1.4. <A
HREF="#feedback"
>Feedback</A
></DT
><DT
>1.5. <A
HREF="#AEN85"
>Terms Used in this Document</A
></DT
></DL
></DD
><DT
>2. <A
HREF="#theproblem"
>The Problem</A
></DT
><DD
><DL
><DT
>2.1. <A
HREF="#mangling"
>Name Mangling</A
></DT
><DT
>2.2. <A
HREF="#AEN131"
>Classes</A
></DT
></DL
></DD
><DT
>3. <A
HREF="#thesolution"
>The Solution</A
></DT
><DD
><DL
><DT
>3.1. <A
HREF="#externC"
><TT
CLASS="literal"
>extern "C"</TT
></A
></DT
><DT
>3.2. <A
HREF="#loadingfunctions"
>Loading Functions</A
></DT
><DT
>3.3. <A
HREF="#loadingclasses"
>Loading Classes</A
></DT
></DL
></DD
><DT
>4. <A
HREF="#faq"
>Frequently Asked Questions</A
></DT
><DT
>5. <A
HREF="#seealso"
>See Also</A
></DT
><DT
><A
HREF="#AEN295"
>Bibliography</A
></DT
></DL
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="intro"
></A
>1. Introduction</H1
><P
> A question which frequently arises among Unix C++ programmers is
how to load C++ functions and classes dynamically using the
<TT
CLASS="function"
>dlopen</TT
> API.
</P
><P
>In fact, that is not always simple and needs some
explanation. That's what this mini HOWTO does.</P
><P
>An average understanding of the <SPAN
CLASS="systemitem"
>C</SPAN
>
and <SPAN
CLASS="systemitem"
>C++</SPAN
> programming language and of the
<TT
CLASS="function"
>dlopen</TT
> API is necessary to understand this
document.</P
><P
>This HOWTO's master location is <A
HREF="http://www.isotton.com/howtos/C++-dlopen-mini-HOWTO/"
TARGET="_top"
>http://www.isotton.com/howtos/C++-dlopen-mini-HOWTO/</A
>.</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="copyright"
></A
>1.1. Copyright and License</H2
><P
> This document, <EM
>C++ dlopen mini HOWTO</EM
>, is
copyrighted (c) 2002 by <EM
>Aaron Isotton</EM
>.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, with no
Front-Cover Texts, and with no Back-Cover Texts.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="disclaimer"
></A
>1.2. Disclaimer</H2
><P
> No liability for the contents of this document can be
accepted. Use the concepts, examples and information at your
own risk. There may be errors and inaccuracies, that could be
damaging to your system. Proceed with caution, and although
this is highly unlikely, the author(s) do not take any
responsibility.
</P
><P
> All copyrights are held by their by their respective owners,
unless specifically noted otherwise. Use of a term in this
document should not be regarded as affecting the validity of
any trademark or service mark. Naming of particular products
or brands should not be seen as endorsements.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="credits"
></A
>1.3. Credits / Contributors</H2
><P
> In this document, I have the pleasure of acknowledging (in
alphabetic order):
</P
><P
></P
><UL
><LI
><P
>Joy Y Goodreau <TT
CLASS="email"
><<A
HREF="mailto:joyg (at) us.ibm.com"
>joyg (at) us.ibm.com</A
>></TT
> for
her editing.</P
></LI
><LI
><P
>D. Stimitis <TT
CLASS="email"
><<A
HREF="mailto:stimitis (at) idcomm.com"
>stimitis (at) idcomm.com</A
>></TT
>
for pointing out a few issues with the formatting and the
name mangling, as well as pointing out a few subtleties of
<TT
CLASS="literal"
>extern "C"</TT
>.</P
></LI
></UL
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="feedback"
></A
>1.4. Feedback</H2
><P
> Feedback is most certainly welcome for this document. Send
your additions, comments and criticisms to the following email
address: <TT
CLASS="email"
><<A
HREF="mailto:[email protected]"
>[email protected]</A
>></TT
>.
</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN85"
></A
>1.5. Terms Used in this Document</H2
><P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="function"
>dlopen</TT
> API</DT
><DD
><P
>The <TT
CLASS="function"
>dlclose</TT
>,
<TT
CLASS="function"
>dlerror</TT
>,
<TT
CLASS="function"
>dlopen</TT
> and
<TT
CLASS="function"
>dlsym</TT
> functions as described in the
<TT
CLASS="literal"
>dlopen(3)</TT
> man page.</P
><P
>Notice that we use
<SPAN
CLASS="QUOTE"
>"<TT
CLASS="function"
>dlopen</TT
>"</SPAN
> to refer to
the individual <TT
CLASS="function"
>dlopen</TT
>
<EM
>function</EM
>, and
<SPAN
CLASS="QUOTE"
>"<TT
CLASS="function"
>dlopen</TT
> API"</SPAN
> to refer
to the <EM
>entire API</EM
>.</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="theproblem"
></A
>2. The Problem</H1
><P
>At some time you might have to load a library (and use its
functions) at runtime; this happens most often when you are
writing some kind of plug-in or module architecture for your
program.</P
><P
>In the C language, loading a library is very simple (calling
<TT
CLASS="function"
>dlopen</TT
>, <TT
CLASS="function"
>dlsym</TT
> and
<TT
CLASS="function"
>dlclose</TT
> is enough), with C++ this is a bit
more complicated. The difficulties of loading a C++ library
dynamically are partially due to <A
HREF="#mangling"
>name
mangling</A
>, and partially due to the fact that the
<TT
CLASS="function"
>dlopen</TT
> API was written with C in mind, thus
not offering a suitable way to load classes.</P
><P
>Before explaining how to load libraries in C++, let's better
analyze the problem by looking at name mangling in more
detail. I recommend you read the explanation of name mangling,
even if you're not interested in it because it will help you
understanding why problems occur and how to solve them.</P
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="mangling"
></A
>2.1. Name Mangling</H2
><P
>In every C++ program (or library, or object file), all
non-static functions are represented in the binary file as
<EM
>symbols</EM
>. These symbols are special text
strings that uniquely identify a function in the program,
library, or object file.</P
><P
>In C, the symbol name is the same as the function name:
the symbol of <TT
CLASS="function"
>strcpy</TT
> will be
<TT
CLASS="computeroutput"
>strcpy</TT
>, and so on. This is
possible because in C no two non-static functions can have the
same name.</P
><P
>Because C++ allows overloading (different functions with
the same name but different arguments) and has many features C
does not — like classes, member functions, exception
specifications — it is not possible to simply use the
function name as the symbol name. To solve that, C++ uses
so-called <EM
>name mangling</EM
>, which transforms
the function name and all the necessary information (like the
number and size of the arguments) into some weird-looking
string which only the compiler knows about. The mangled name
of <TT
CLASS="function"
>foo</TT
> might look like
<TT
CLASS="computeroutput"
>foo@4%6^</TT
>, for example. Or it
might not even contain the word <SPAN
CLASS="QUOTE"
>"foo"</SPAN
>.</P
><P
> One of the problems with name mangling is that the C++
standard (currently [<SPAN
CLASS="citation"
>ISO14882</SPAN
>]) does not
define how names have to be mangled; thus every compiler
mangles names in its own way. Some compilers even change their
name mangling algorithm between different versions (notably
g++ 2.x and 3.x). Even if you worked out how your particular
compiler mangles names (and would thus be able to load
functions via <TT
CLASS="function"
>dlsym</TT
>), this would most
probably work with your compiler only, and might already be
broken with the next version.</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN131"
></A
>2.2. Classes</H2
><P
>Another problem with the <TT
CLASS="function"
>dlopen</TT
> API
is the fact that it only supports loading
<EM
>functions</EM
>. But in C++ a library often
exposes a class which you would like to use in your
program. Obviously, to use that class you need to create an
instance of it, but that cannot be easily done.</P
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="thesolution"
></A
>3. The Solution</H1
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="externC"
></A
>3.1. <TT
CLASS="literal"
>extern "C"</TT
></H2
><P
>C++ has a special keyword to declare a function with C
bindings: <TT
CLASS="literal"
>extern "C"</TT
>. A function declared
as <TT
CLASS="literal"
>extern "C"</TT
> uses the function name as
symbol name, just as a C function. For that reason, only
non-member functions can be declared as <TT
CLASS="literal"
>extern
"C"</TT
>, and they cannot be overloaded.</P
><P
>Although there are severe limitations, <TT
CLASS="literal"
>extern
"C"</TT
> functions are very useful because they can be
dynamically loaded using <TT
CLASS="function"
>dlopen</TT
> just like
a C function.</P
><P
>This does <EM
>not</EM
> mean that functions
qualified as <TT
CLASS="literal"
>extern "C"</TT
> cannot contain C++
code. Such a function is a full-featured C++ function which
can use C++ features and take any type of argument.</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="loadingfunctions"
></A
>3.2. Loading Functions</H2
><P
>In C++ functions are loaded just like in C, with
<TT
CLASS="function"
>dlsym</TT
>. The functions you want to load
must be qualified as <TT
CLASS="literal"
>extern "C"</TT
> to avoid
the symbol name being mangled.</P
><DIV
CLASS="example"
><A
NAME="AEN156"
></A
><P
><B
>Example 1. Loading a Function</B
></P
><P
>main.cpp:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>#include <iostream>
#include <dlfcn.h>
int main() {
using std::cout;
using std::cerr;
cout << "C++ dlopen demo\n\n";
// open the library
cout << "Opening hello.so...\n";
void* handle = dlopen("./hello.so", RTLD_LAZY);
if (!handle) {
cerr << "Cannot open library: " << dlerror() << '\n';
return 1;
}
// load the symbol
cout << "Loading symbol hello...\n";
typedef void (*hello_t)();
hello_t hello = (hello_t) dlsym(handle, "hello");
if (!hello) {
cerr << "Cannot load symbol 'hello': " << dlerror() <<
'\n';
dlclose(handle);
return 1;
}
// use it to do the calculation
cout << "Calling hello...\n";
hello();
// close the library
cout << "Closing library...\n";
dlclose(handle);
}
</PRE
></FONT
></TD
></TR
></TABLE
><P
>hello.cpp:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>#include <iostream>
extern "C" void hello() {
std::cout << "hello" << '\n';
}
</PRE
></FONT
></TD
></TR
></TABLE
></DIV
><P
>The function <TT
CLASS="function"
>hello</TT
> is defined in
<TT
CLASS="filename"
>hello.cpp</TT
>as <TT
CLASS="literal"
>extern
"C"</TT
>; it is loaded in <TT
CLASS="filename"
>main.cpp</TT
>
with the <TT
CLASS="function"
>dlsym</TT
> call. The function must be
qualified as <TT
CLASS="literal"
>extern "C"</TT
> because otherwise
we wouldn't know its symbol name.</P
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>There are two different forms of the
<TT
CLASS="literal"
>extern "C"</TT
> declaration: <TT
CLASS="literal"
>extern
"C"</TT
> as used above, and <TT
CLASS="literal"
>extern "C" {
… }</TT
> with the declarations between the
braces. The first (inline) form is a declaration with extern
linkage and with C language linkage; the second only affects
language linkage. The following two declarations are thus
equivalent:
<DIV
CLASS="informalexample"
><A
NAME="AEN174"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>extern "C" int foo;
extern "C" void bar();
</PRE
></FONT
></TD
></TR
></TABLE
><P
></P
></DIV
>
and
<DIV
CLASS="informalexample"
><A
NAME="AEN176"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>extern "C" {
extern int foo;
extern void bar();
}</PRE
></FONT
></TD
></TR
></TABLE
><P
></P
></DIV
>
As there is no difference between an
<TT
CLASS="literal"
>extern</TT
> and a
non-<TT
CLASS="literal"
>extern</TT
> <EM
>function</EM
>
declaration, this is no problem as long as you are not
declaring any variables. If you declare
<EM
>variables</EM
>, keep in mind that
<DIV
CLASS="informalexample"
><A
NAME="AEN182"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>extern "C" int foo;</PRE
></FONT
></TD
></TR
></TABLE
><P
></P
></DIV
>
and
<DIV
CLASS="informalexample"
><A
NAME="AEN184"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>extern "C" {
int foo;
}</PRE
></FONT
></TD
></TR
></TABLE
><P
></P
></DIV
>
are <EM
>not</EM
> the same thing.</P
><P
>For further clarifications, refer to
[<SPAN
CLASS="citation"
>ISO14882</SPAN
>], 7.5, with special attention
to paragraph 7, or to [<SPAN
CLASS="citation"
>STR2000</SPAN
>],
paragraph 9.2.4.</P
><P
>Before doing fancy things with extern variables, peruse
the documents listed in the <A
HREF="#seealso"
>see
also</A
> section.</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="loadingclasses"
></A
>3.3. Loading Classes</H2
><P
>Loading classes is a bit more difficult because we need
an <EM
>instance</EM
> of a class, not just a
pointer to a function.</P
><P
>We cannot create the instance of the class using
<TT
CLASS="literal"
>new</TT
> because the class is not defined in the
executable, and because (under some circumstances) we don't
even know its name.</P
><P
>The solution is achieved through polymorphism. We define a
base, <EM
>interface</EM
> class with virtual
members <EM
>in the executable</EM
>, and a derived,
<EM
>implementation</EM
> class <EM
>in the
module</EM
>. Generally the interface class is
abstract (a class is abstract if it has pure virtual
functions).</P
><P
>As dynamic loading of classes is generally used for
plug-ins — which must expose a clearly defined interface
— we would have had to define an interface and derived
implementation classes anyway.</P
><P
>Next, while still in the module, we define two additional helper
functions, known as <EM
>class factory
functions</EM
>. One of these functions creates an instance of the
class and returns a pointer to it. The other function takes a
pointer to a class created by the factory and destroys
it. These two functions are qualified as <TT
CLASS="literal"
>extern
"C"</TT
>.</P
><P
>To use the class from the module, load the two factory
functions using <TT
CLASS="function"
>dlsym</TT
> just <A
HREF="#loadingfunctions"
>as we loaded the the hello
function</A
>; then, we can create and destroy as many
instances as we wish.</P
><DIV
CLASS="example"
><A
NAME="AEN210"
></A
><P
><B
>Example 2. Loading a Class</B
></P
><P
>Here we use a generic <TT
CLASS="classname"
>polygon</TT
>
class as interface and the derived class
<TT
CLASS="classname"
>triangle</TT
> as implementation.</P
><P
>main.cpp:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>#include "polygon.h"
#include <iostream>
#include <dlfcn.h>
int main() {
using std::cout;
using std::cerr;
// load the triangle library
void* triangle = dlopen("./triangle.so", RTLD_LAZY);
if (!triangle) {
cerr << "Cannot load library: " << dlerror() << '\n';
return 1;
}
// load the symbols
create_t* create_triangle = (create_t*) dlsym(triangle, "create");
destroy_t* destroy_triangle = (destroy_t*) dlsym(triangle, "destroy");
if (!create_triangle || !destroy_triangle) {
cerr << "Cannot load symbols: " << dlerror() << '\n';
return 1;
}
// create an instance of the class
polygon* poly = create_triangle();
// use the class
poly->set_side_length(7);
cout << "The area is: " << poly->area() << '\n';
// destroy the class
destroy_triangle(poly);
// unload the triangle library
dlclose(triangle);
}
</PRE
></FONT
></TD
></TR
></TABLE
><P
>polygon.h:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>#ifndef POLYGON_HPP
#define POLYGON_HPP
class polygon {
protected:
double side_length_;
public:
polygon()
: side_length_(0) {}
void set_side_length(double side_length) {
side_length_ = side_length;
}
virtual double area() const = 0;
};
// the types of the class factories
typedef polygon* create_t();
typedef void destroy_t(polygon*);
#endif
</PRE
></FONT
></TD
></TR
></TABLE
><P
>triangle.cpp:</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>#include "polygon.h"
#include <cmath>
class triangle : public polygon {
public:
virtual double area() const {
return side_length_ * side_length_ * sqrt(3) / 2;
}
};
// the class factories
extern "C" polygon* create() {
return new triangle;
}
extern "C" void destroy(polygon* p) {
delete p;
}
</PRE
></FONT
></TD
></TR
></TABLE
></DIV
><P
>There are a few things to note when loading classes:</P
><P
></P
><UL
><LI
><P
>You must provide <EM
>both</EM
> a creation
and a destruction function; you must
<EM
>not</EM
> destroy the instances using
<TT
CLASS="literal"
>delete</TT
> from inside the executable, but
always pass it back to the module. This is due to the fact
that in C++ the operators <TT
CLASS="literal"
>new</TT
> and
<TT
CLASS="literal"
>delete</TT
> may be overloaded; this would
cause a non-matching <TT
CLASS="literal"
>new</TT
> and
<TT
CLASS="literal"
>delete</TT
> to be called, which could cause
anything from nothing to memory leaks and segmentation
faults. The same is true if different standard libraries
are used to link the module and the executable.</P
></LI
><LI
><P
>The destructor of the interface class should be
virtual in any case. There <EM
>might</EM
> be
very rare cases where that would not be necessary, but it
is not worth the risk, because the additional overhead can
generally be ignored.</P
><P
>If your base class needs no destructor, define an
empty (and <TT
CLASS="literal"
>virtual</TT
>) one anyway;
otherwise you <EM
>will have problems</EM
>
sooner or later; I can guarantee you that. You can read
more about this problem in the comp.lang.c++ FAQ at <A
HREF="http://www.parashift.com/c++-faq-lite/"
TARGET="_top"
>http://www.parashift.com/c++-faq-lite/</A
>, in
section 20.</P
></LI
></UL
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="faq"
></A
>4. Frequently Asked Questions</H1
><DIV
CLASS="qandaset"
><DL
><DT
>4.1. <A
HREF="#AEN243"
>I'm using Windows and I can't find the
<TT
CLASS="filename"
>dlfcn.h</TT
> header file on my PC! What's
the problem?</A
></DT
><DT
>4.2. <A
HREF="#AEN257"
>Is there some kind of <TT
CLASS="function"
>dlopen</TT
>-compatible
wrapper for the Windows <TT
CLASS="function"
>LoadLibrary</TT
>
API?</A
></DT
></DL
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN243"
></A
><B
>4.1. </B
>I'm using Windows and I can't find the
<TT
CLASS="filename"
>dlfcn.h</TT
> header file on my PC! What's
the problem?</P
></DIV
><DIV
CLASS="answer"
><P
><B
> </B
>The problem is, as usual, Windows. There is no
<TT
CLASS="filename"
>dlfcn.h</TT
> header on Windows,and there is
no <TT
CLASS="function"
>dlopen</TT
> API. There is a similar API
around the <TT
CLASS="function"
>LoadLibrary</TT
> function, and
most of what is written here applies to it, too.
Alternatively, you can use libltdl (included in libtool) to
<SPAN
CLASS="QUOTE"
>"emulate"</SPAN
> <TT
CLASS="function"
>dlopen</TT
> on a
variety of platforms.</P
><P
>You should also read section 4, <SPAN
CLASS="QUOTE"
>"Dynamically
Loaded (DL) Libraries"</SPAN
>, of the <A
HREF="http://www.dwheeler.com/program-library"
TARGET="_top"
>Program Library
HOWTO</A
> for more techniques to load libraries and
create classes independently of your platform.</P
></DIV
></DIV
><DIV
CLASS="qandaentry"
><DIV
CLASS="question"
><P
><A
NAME="AEN257"
></A
><B
>4.2. </B
>Is there some kind of <TT
CLASS="function"
>dlopen</TT
>-compatible
wrapper for the Windows <TT
CLASS="function"
>LoadLibrary</TT
>
API?</P
></DIV
><DIV
CLASS="answer"
><P
><B
> </B
>I don't know of any, and I don't think there'll ever be one
supporting all of <TT
CLASS="function"
>dlopen</TT
>'s options.</P
><P
>There are alternatives though: libtltdl (a part of libtool),
which wraps a variety of different dynamic loading APIs, among
others <TT
CLASS="function"
>dlopen</TT
> and
<TT
CLASS="function"
>LoadLibrary</TT
>. Another one is the <A
HREF="http://developer.gnome.org/doc/API/glib/glib-dynamic-loading-of-modules.html"
TARGET="_top"
>Dynamic
Module Loading functionality of GLib</A
>. You can use one
of these to ensure better possible cross-platform compatibility.
I've never used any of them, so I can't tell you how stable they
are and whether they really work.</P
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="section"
><HR><H1
CLASS="section"
><A
NAME="seealso"
></A
>5. See Also</H1
><P
></P
><UL
><LI
><P
>The <TT
CLASS="function"
>dlopen(3)</TT
> man page. It explains
the purpose and the use of the <TT
CLASS="function"
>dlopen</TT
>
API.</P
></LI
><LI
><P
>The article <A
HREF="http://www.linuxjournal.com/article.php?sid=3687"
TARGET="_top"
> <I
CLASS="citetitle"
>Dynamic Class Loading for C++ on
Linux</I
></A
> by James Norton published on the
<A
HREF="http://www.linuxjournal.com/"
TARGET="_top"
>Linux
Journal</A
>.</P
></LI
><LI
><P
>Your favorite C++ reference about <TT
CLASS="literal"
>extern
"C"</TT
>, inheritance, virtual functions,
<TT
CLASS="literal"
>new</TT
> and <TT
CLASS="literal"
>delete</TT
>. I
recommend [<SPAN
CLASS="citation"
>STR2000</SPAN
>].</P
></LI
><LI
><P
>[<SPAN
CLASS="citation"
>ISO14882</SPAN
>]</P
></LI
><LI
><P
>The <A
HREF="http://www.dwheeler.com/program-library"
TARGET="_top"
>Program Library
HOWTO</A
>, which tells you most things you'll ever need
about static, shared and dynamically loaded libraries and how
to create them. Highly recommended.</P
></LI
><LI
><P
>The <A
HREF="http://tldp.org/HOWTO/GCC-HOWTO/index.html"
TARGET="_top"
>Linux GCC
HOWTO</A
> to learn more about how to create libraries
with GCC.</P
></LI
></UL
></DIV
><A
NAME="AEN295"
></A
><HR><H1
><A
NAME="AEN295"
></A
>Bibliography</H1
><DIV
CLASS="bibliomixed"
><A
NAME="AEN296"
></A
><P
CLASS="bibliomixed"
> ISO14482 <I
>ISO/IEC 14482-1998 — The
C++ Programming Language</I
>. Available as
PDF and as printed book from <A
HREF="http://webstore.ansi.org/"
TARGET="_top"
>http://webstore.ansi.org/</A
>.
</P
></DIV
><DIV
CLASS="bibliomixed"
><A
NAME="AEN301"
></A
><P
CLASS="bibliomixed"
> STR2000
<SPAN
CLASS="AUTHOR"
>Bjarne Stroustrup</SPAN
>
<I
>The C++ Programming Language</I
>, Special
Edition.
ISBN 0-201-70073-5.
Addison-Wesley.
</P
></DIV
></DIV
>
</body>
</html>
|
