Ignore (this directory's copy of) MCS-PROTOCOL.asn
[obnox/wireshark/wip.git] / version_info.c
1 /* version_info.c
2  * Routines to report version information for stuff used by Wireshark
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <glib.h>
30
31 #include <stdlib.h>
32 #include <stdio.h>
33 #include <string.h>
34 #include <errno.h>
35
36 #ifdef HAVE_LIBZ
37 #include <zlib.h>       /* to get the libz version number */
38 #endif
39
40 #ifdef HAVE_SYS_UTSNAME_H
41 #include <sys/utsname.h>
42 #endif
43
44 #include "version_info.h"
45 #include "capture-pcap-util.h"
46 #include <wsutil/unicode-utils.h>
47
48 #include "svnversion.h"
49
50 #ifdef HAVE_WINDOWS_H
51 #include <windows.h>
52 #endif
53
54 #ifdef HAVE_OS_X_FRAMEWORKS
55 #include <CoreServices/CoreServices.h>
56 #endif
57
58 #ifdef HAVE_LIBCAP
59 # include <sys/capability.h>
60 #endif
61
62 #ifdef SVNVERSION
63         const char *wireshark_svnversion = " (" SVNVERSION " from " SVNPATH ")";
64 #else
65         const char *wireshark_svnversion = "";
66 #endif
67
68 /*
69  * If the string doesn't end with a newline, append one.
70  * Then word-wrap it to 80 columns.
71  */
72 static void
73 end_string(GString *str)
74 {
75         size_t point;
76         char *p, *q;
77
78         point = str->len;
79         if (point == 0 || str->str[point - 1] != '\n')
80                 g_string_append(str, "\n");
81         p = str->str;
82         while (*p != '\0') {
83                 q = strchr(p, '\n');
84                 if (q - p > 80) {
85                         /*
86                          * Break at or before this point.
87                          */
88                         q = p + 80;
89                         while (q > p && *q != ' ')
90                                 q--;
91                         if (q != p)
92                                 *q = '\n';
93                 }
94                 p = q + 1;
95         }
96 }
97
98 /*
99  * Get various library compile-time versions and append them to
100  * the specified GString.
101  *
102  * "additional_info" is called at the end to append any additional
103  * information; this is required in order to, for example, put the
104  * Portaudio information at the end of the string, as we currently
105  * don't use Portaudio in TShark.
106  */
107 void
108 get_compiled_version_info(GString *str, void (*prepend_info)(GString *),
109                           void (*append_info)(GString *))
110 {
111         if (sizeof(str) == 4)
112                 g_string_append(str, "(32-bit) ");
113         else
114                 g_string_append(str, "(64-bit) ");
115
116         if (prepend_info)
117                 (*prepend_info)(str);
118
119         /* GLIB */
120         g_string_append(str, "with ");
121         g_string_append_printf(str,
122 #ifdef GLIB_MAJOR_VERSION
123             "GLib %d.%d.%d", GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION,
124             GLIB_MICRO_VERSION);
125 #else
126             "GLib (version unknown)");
127 #endif
128
129         /* Libpcap */
130         g_string_append(str, ", ");
131         get_compiled_pcap_version(str);
132
133         /* LIBZ */
134         g_string_append(str, ", ");
135 #ifdef HAVE_LIBZ
136         g_string_append(str, "with libz ");
137 #ifdef ZLIB_VERSION
138         g_string_append(str, ZLIB_VERSION);
139 #else /* ZLIB_VERSION */
140         g_string_append(str, "(version unknown)");
141 #endif /* ZLIB_VERSION */
142 #else /* HAVE_LIBZ */
143         g_string_append(str, "without libz");
144 #endif /* HAVE_LIBZ */
145
146         /* LIBCAP */
147         g_string_append(str, ", ");
148 #ifdef HAVE_LIBCAP
149         g_string_append(str, "with POSIX capabilities");
150 #ifdef _LINUX_CAPABILITY_VERSION
151         g_string_append(str, " (Linux)");
152 #endif /* _LINUX_CAPABILITY_VERSION */
153 #else /* HAVE_LIBCAP */
154         g_string_append(str, "without POSIX capabilities");
155 #endif /* HAVE_LIBCAP */
156 #ifdef USE_THREADS
157         g_string_append_printf(str, ", with threads support");
158 #else
159         g_string_append_printf(str, ", without threads support");
160 #endif
161
162         /* Additional application-dependent information */
163         if (append_info)
164                 (*append_info)(str);
165         g_string_append(str, ".");
166
167         end_string(str);
168 }
169
170 #ifdef _WIN32
171 typedef void (WINAPI *nativesi_func_ptr)(LPSYSTEM_INFO);
172 #endif
173
174 /*
175  * Get various library run-time versions, and the OS version, and append
176  * them to the specified GString.
177  */
178 void
179 get_runtime_version_info(GString *str, void (*additional_info)(GString *))
180 {
181 #if defined(_WIN32)
182         OSVERSIONINFOEX info;
183         SYSTEM_INFO system_info;
184         nativesi_func_ptr nativesi_func;
185 #elif defined(HAVE_SYS_UTSNAME_H)
186         struct utsname name;
187 #endif
188 #if HAVE_OS_X_FRAMEWORKS
189         SInt32 macosx_ver, macosx_major_ver, macosx_minor_ver, macosx_bugfix_ver;
190 #endif
191 #ifndef _WIN32
192         gchar *lang;
193 #endif
194
195         g_string_append(str, "on ");
196
197 #if defined(_WIN32)
198         /*
199          * See
200          *
201          *      http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/getting_the_system_version.asp
202          *
203          * for more than you ever wanted to know about determining the
204          * flavor of Windows on which you're running.  Implementing more
205          * of that is left as an exercise to the reader - who should
206          * check any copyright information about code samples on MSDN
207          * before cutting and pasting into Wireshark.
208          *
209          * They should also note that you need an OSVERSIONINFOEX structure
210          * to get some of that information, and that not only is that
211          * structure not supported on older versions of Windows, you might
212          * not even be able to compile code that *uses* that structure with
213          * older versions of the SDK.
214          */
215
216         memset(&info, '\0', sizeof info);
217         info.dwOSVersionInfoSize = sizeof info;
218         if (!GetVersionEx((OSVERSIONINFO *)&info)) {
219                 /*
220                  * XXX - get the failure reason.
221                  */
222                 g_string_append(str, "unknown Windows version");
223                 return;
224         }
225
226         memset(&system_info, '\0', sizeof system_info);
227         /* Look for and use the GetNativeSystemInfo() function if available to get the correct processor
228          * architecture even when running 32-bit Wireshark in WOW64 (x86 emulation on 64-bit Windows) */
229         nativesi_func = (nativesi_func_ptr)GetProcAddress(GetModuleHandle(_T("kernel32.dll")), "GetNativeSystemInfo");
230         if(nativesi_func)
231                 nativesi_func(&system_info);
232         else
233                 GetSystemInfo(&system_info);
234
235         switch (info.dwPlatformId) {
236
237         case VER_PLATFORM_WIN32s:
238                 /* Shyeah, right. */
239                 g_string_append_printf(str, "Windows 3.1 with Win32s");
240                 break;
241
242         case VER_PLATFORM_WIN32_WINDOWS:
243                 /* Windows OT */
244                 switch (info.dwMajorVersion) {
245
246                 case 4:
247                         /* 3 cheers for Microsoft marketing! */
248                         switch (info.dwMinorVersion) {
249
250                         case 0:
251                                 g_string_append_printf(str, "Windows 95");
252                                 break;
253
254                         case 10:
255                                 g_string_append_printf(str, "Windows 98");
256                                 break;
257
258                         case 90:
259                                 g_string_append_printf(str, "Windows Me");
260                                 break;
261
262                         default:
263                                 g_string_append_printf(str, "Windows OT, unknown version %lu.%lu",
264                                     info.dwMajorVersion, info.dwMinorVersion);
265                                 break;
266                         }
267                         break;
268
269                 default:
270                         g_string_append_printf(str, "Windows OT, unknown version %lu.%lu",
271                             info.dwMajorVersion, info.dwMinorVersion);
272                         break;
273                 }
274                 break;
275
276         case VER_PLATFORM_WIN32_NT:
277                 /* Windows NT */
278                 switch (info.dwMajorVersion) {
279
280                 case 3:
281                 case 4:
282                         g_string_append_printf(str, "Windows NT %lu.%lu",
283                             info.dwMajorVersion, info.dwMinorVersion);
284                         break;
285
286                 case 5:
287                         /* 3 cheers for Microsoft marketing! */
288                         switch (info.dwMinorVersion) {
289
290                         case 0:
291                                 g_string_append_printf(str, "Windows 2000");
292                                 break;
293
294                         case 1:
295                                 g_string_append_printf(str, "Windows XP");
296                                 break;
297
298                         case 2:
299                                 if ((info.wProductType == VER_NT_WORKSTATION) &&
300                                     (system_info.wProcessorArchitecture == PROCESSOR_ARCHITECTURE_AMD64)) {
301                                         g_string_append_printf(str, "Windows XP Professional x64 Edition");
302                                 } else {
303                                         g_string_append_printf(str, "Windows Server 2003");
304                                         if (system_info.wProcessorArchitecture == PROCESSOR_ARCHITECTURE_AMD64)
305                                                 g_string_append_printf(str, " x64 Edition");
306                                 }
307                                 break;
308
309                         default:
310                                 g_string_append_printf(str, "Windows NT, unknown version %lu.%lu",
311                                                        info.dwMajorVersion, info.dwMinorVersion);
312                                 break;
313                         }
314                         break;
315
316                 case 6: {
317                         gboolean is_nt_workstation;
318
319                         if (system_info.wProcessorArchitecture == PROCESSOR_ARCHITECTURE_AMD64)
320                                 g_string_append(str, "64-bit ");
321                         else if (system_info.wProcessorArchitecture == PROCESSOR_ARCHITECTURE_INTEL)
322                                 g_string_append(str, "32-bit ");
323 #ifndef VER_NT_WORKSTATION
324 #define VER_NT_WORKSTATION 0x01
325                         is_nt_workstation = ((info.wReserved[1] & 0xff) == VER_NT_WORKSTATION);
326 #else
327                         is_nt_workstation = (info.wProductType == VER_NT_WORKSTATION);
328 #endif
329                         switch (info.dwMinorVersion) {
330                         case 0:
331                                 g_string_append_printf(str, is_nt_workstation ? "Windows Vista" : "Windows Server 2008");
332                                 break;
333                         case 1:
334                                 g_string_append_printf(str, is_nt_workstation ? "Windows 7" : "Windows Server 2008 R2");
335                                 break;
336                         default:
337                                 g_string_append_printf(str, "Windows NT, unknown version %lu.%lu",
338                                                        info.dwMajorVersion, info.dwMinorVersion);
339                                 break;
340                         }
341                         break;
342                 }  /* case 6 */
343                 default:
344                         g_string_append_printf(str, "Windows NT, unknown version %lu.%lu",
345                             info.dwMajorVersion, info.dwMinorVersion);
346                         break;
347                 } /* info.dwMajorVersion */
348                 break;
349
350         default:
351                 g_string_append_printf(str, "Unknown Windows platform %lu version %lu.%lu",
352                     info.dwPlatformId, info.dwMajorVersion, info.dwMinorVersion);
353                 break;
354         }
355         if (info.szCSDVersion[0] != '\0')
356                 g_string_append_printf(str, " %s", utf_16to8(info.szCSDVersion));
357         g_string_append_printf(str, ", build %lu", info.dwBuildNumber);
358 #elif defined(HAVE_SYS_UTSNAME_H)
359         /*
360          * We have <sys/utsname.h>, so we assume we have "uname()".
361          */
362         if (uname(&name) < 0) {
363                 g_string_append_printf(str, "unknown OS version (uname failed - %s)",
364                     g_strerror(errno));
365                 return;
366         }
367
368         if (strcmp(name.sysname, "AIX") == 0) {
369                 /*
370                  * Yay, IBM!  Thanks for doing something different
371                  * from most of the other UNIXes out there, and
372                  * making "name.version" apparently be the major
373                  * version number and "name.release" be the minor
374                  * version number.
375                  */
376                 g_string_append_printf(str, "%s %s.%s", name.sysname, name.version,
377                     name.release);
378         } else {
379                 /*
380                  * XXX - get "version" on any other platforms?
381                  *
382                  * On Digital/Tru64 UNIX, it's something unknown.
383                  * On Solaris, it's some kind of build information.
384                  * On HP-UX, it appears to be some sort of subrevision
385                  * thing.
386                  * On *BSD and Darwin/OS X, it's a long string giving
387                  * a build date, config file name, etc., etc., etc..
388                  */
389 #ifdef HAVE_OS_X_FRAMEWORKS
390                 /*
391                  * On Mac OS X, report the Mac OS X version number as
392                  * the OS, and put the Darwin information in parentheses.
393                  *
394                  * XXX - can we get the build name?  There's no API to
395                  * get it; it's currently in
396                  * /System/Library/CoreServices/SystemVersion.plist
397                  * but there's no guarantee that it will continue to
398                  * be there.
399                  */
400                 Gestalt(gestaltSystemVersion, &macosx_ver);
401
402                 /* The following functions are only available in Mac OS 10.4+ */
403                 if(macosx_ver >= 0x1040) {
404                         Gestalt(gestaltSystemVersionMajor, &macosx_major_ver);
405                         Gestalt(gestaltSystemVersionMinor, &macosx_minor_ver);
406                         Gestalt(gestaltSystemVersionBugFix, &macosx_bugfix_ver);
407
408                         g_string_append_printf(str, "Mac OS %ld.%ld.%ld",
409                                           (long)macosx_major_ver,
410                                           (long)macosx_minor_ver,
411                                           (long)macosx_bugfix_ver);
412                 } else {
413                         g_string_append_printf(str, "Mac OS X < 10.4 [%lx]",
414                                           (long)macosx_ver);
415                         /* See Apple's Gestalt Manager Reference for meanings
416                          * of the macosx_ver values. */
417                 }
418                 g_string_append_printf(str, " (%s %s)", name.sysname, name.release);
419 #else /* HAVE_OS_X_FRAMEWORKS */
420                 /*
421                  * XXX - on Linux, are there any APIs to get the distribution
422                  * name and version number?  I think some distributions have
423                  * that.
424                  *
425                  * At least on Linux Standard Base-compliant distributions,
426                  * there's an "lsb_release" command.  However:
427                  *
428                  *      http://forums.fedoraforum.org/showthread.php?t=220885
429                  *
430                  * seems to suggest that if you don't have the redhat-lsb
431                  * package installed, you don't have lsb_release, and that
432                  * /etc/fedora-release has the release information on
433                  * Fedora.
434                  *
435                  *      http://linux.die.net/man/1/lsb_release
436                  *
437                  * suggests that there's an /etc/distrib-release file, but
438                  * it doesn't indicate whether "distrib" is literally
439                  * "distrib" or is the name for the distribution, and
440                  * also speaks of an /etc/debian_version file.
441                  *
442                  * "lsb_release" apparently parses /etc/lsb-release, which
443                  * has shell-style assignments, assigning to, among other
444                  * values, DISTRIB_ID (distributor/distribution name),
445                  * DISTRIB_RELEASE (release number of the distribution),
446                  * DISTRIB_DESCRIPTION (*might* be name followed by version,
447                  * but the manpage for lsb_release seems to indicate that's
448                  * not guaranteed), and DISTRIB_CODENAME (code name, e.g.
449                  * "licentious" for the Ubuntu Licentious Lemur release).
450                  * the lsb_release man page also speaks of the distrib-release
451                  * file, but Debian doesn't have one, and Ubuntu 7's
452                  * lsb_release command doesn't look for one.
453                  *
454                  * I've seen references to /etc/redhat-release as well.
455                  *
456                  * At least on my Ubuntu 7 system, /etc/debian_version
457                  * doesn't contain anything interesting (just some Debian
458                  * codenames).
459                  *
460                  * See also
461                  *
462                  *      http://bugs.python.org/issue1322
463                  *
464                  *      http://www.novell.com/coolsolutions/feature/11251.html
465                  *
466                  *      http://linuxmafia.com/faq/Admin/release-files.html
467                  *
468                  * and the Lib/Platform.py file in recent Python 2.x
469                  * releases.
470                  */
471                 g_string_append_printf(str, "%s %s", name.sysname, name.release);
472 #endif /* HAVE_OS_X_FRAMEWORKS */
473         }
474 #else
475         g_string_append(str, "an unknown OS");
476 #endif
477
478 #ifndef _WIN32
479         /* Locale */
480         if ((lang = getenv ("LANG")) != NULL)
481                 g_string_append_printf(str, ", with locale %s", lang);
482         else
483                 g_string_append(str, ", without locale");
484 #endif
485
486         /* Libpcap */
487         g_string_append(str, ", ");
488         get_runtime_pcap_version(str);
489
490         /* zlib */
491 #if defined(HAVE_LIBZ) && !defined(_WIN32)
492         g_string_append_printf(str, ", with libz %s", zlibVersion());
493 #endif
494
495         /* Additional application-dependent information */
496         if (additional_info)
497                 (*additional_info)(str);
498
499         g_string_append(str, ".");
500
501         /* Compiler info */
502
503         /*
504          * See https://sourceforge.net/apps/mediawiki/predef/index.php?title=Compilers
505          * information on various defined strings.
506          *
507          * GCC's __VERSION__ is a nice text string for humans to
508          * read.  The page at sourceforge.net largely describes
509          * numeric #defines that encode the version; if the compiler
510          * doesn't also offer a nice printable string, we try prettifying
511          * the number somehow.
512          */
513 #if defined(__GNUC__) && defined(__VERSION__)
514         /*
515          * Clang and llvm-gcc also define __GNUC__ and __VERSION__;
516          * distinguish between them.
517          */
518 #if defined(__clang__)
519         g_string_append_printf(str, "\n\nBuilt using clang %s.\n", __VERSION__);
520 #elif defined(__llvm__)
521         g_string_append_printf(str, "\n\nBuilt using llvm-gcc %s.\n", __VERSION__);
522 #else /* boring old GCC */
523         g_string_append_printf(str, "\n\nBuilt using gcc %s.\n", __VERSION__);
524 #endif /* llvm */
525 #elif defined(__HP_aCC)
526         g_string_append_printf(str, "\n\nBuilt using HP aCC %d.\n", __HP_aCC);
527 #elif defined(__xlC__)
528         g_string_append_printf(str, "\n\nBuilt using IBM XL C %d.%d\n",
529             (__xlC__ >> 8) & 0xFF, __xlC__ & 0xFF);
530 #ifdef __IBMC__
531         if ((__IBMC__ % 10) != 0)
532                 g_string_append_printf(str, " patch %d", __IBMC__ % 10);
533 #endif /* __IBMC__ */
534         g_string_append_printf(str, "\n");
535 #elif defined(__INTEL_COMPILER)
536         g_string_append_printf(str, "\n\nBuilt using Intel C %d.%d",
537             __INTEL_COMPILER / 100, (__INTEL_COMPILER / 10) % 10);
538         if ((__INTEL_COMPILER % 10) != 0)
539                 g_string_append_printf(str, " patch %d", __INTEL_COMPILER % 10);
540 #ifdef __INTEL_COMPILER_BUILD_DATE
541         g_string_sprinta(str, ", compiler built %04d-%02d-%02d",
542             __INTEL_COMPILER_BUILD_DATE / 10000,
543             (__INTEL_COMPILER_BUILD_DATE / 100) % 100,
544             __INTEL_COMPILER_BUILD_DATE % 100);
545 #endif /* __INTEL_COMPILER_BUILD_DATE */
546         g_string_append_printf(str, "\n");
547 #elif defined(_MSC_FULL_VER)
548 # if _MSC_FULL_VER > 99999999
549         g_string_append_printf(str, "\n\nBuilt using Microsoft Visual C++ %d.%d",
550                                (_MSC_FULL_VER / 10000000) - 6,
551                                (_MSC_FULL_VER / 100000) % 100);
552 #  if (_MSC_FULL_VER % 100000) != 0
553         g_string_append_printf(str, " build %d",
554                                _MSC_FULL_VER % 100000);
555 #  endif
556 # else
557         g_string_append_printf(str, "\n\nBuilt using Microsoft Visual C++ %d.%d",
558                                (_MSC_FULL_VER / 1000000) - 6,
559                                (_MSC_FULL_VER / 10000) % 100);
560 #  if (_MSC_FULL_VER % 10000) != 0
561         g_string_append_printf(str, " build %d",
562                                _MSC_FULL_VER % 10000);
563 #  endif
564 # endif
565         g_string_append_printf(str, "\n");
566 #elif defined(_MSC_VER)
567         /* _MSC_FULL_VER not defined, but _MSC_VER defined */
568         g_string_append_printf(str, "\n\nBuilt using Microsoft Visual C++ %d.%d\n",
569             (_MSC_VER / 100) - 6, _MSC_VER % 100);
570 #elif defined(__SUNPRO_C)
571         g_string_append_printf(str, "\n\nBuilt using Sun C %d.%d",
572             (__SUNPRO_C >> 8) & 0xF, (__SUNPRO_C >> 4) & 0xF);
573         if ((__SUNPRO_C & 0xF) != 0)
574                 g_string_append_printf(str, " patch %d", __SUNPRO_C & 0xF);
575         g_string_append_printf(str, "\n");
576 #endif
577
578         end_string(str);
579 }
580
581 /*
582  * Get copyright information.
583  */
584 const char *
585 get_copyright_info(void)
586 {
587         return
588 "Copyright 1998-2011 Gerald Combs <gerald@wireshark.org> and contributors.\n"
589 "This is free software; see the source for copying conditions. There is NO\n"
590 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n";
591 }
592
593 #if defined(_WIN32)
594 /*
595  * Get the major OS version.
596  */
597 /* XXX - Should this return the minor version as well, e.g. 0x00050002? */
598 guint32
599 get_os_major_version()
600 {
601         OSVERSIONINFO info;
602         info.dwOSVersionInfoSize = sizeof info;
603         if (GetVersionEx(&info)) {
604                 return info.dwMajorVersion;
605         }
606         return 0;
607 }
608 #endif
609
610 /*
611  * Editor modelines
612  *
613  * Local Variables:
614  * c-basic-offset: 8
615  * tab-width: 8
616  * indent-tabs-mode: t
617  * End:
618  *
619  * ex: set shiftwidth=8 tabstop=8 noexpandtab:
620  * :indentSize=8:tabSize=8:noTabs=false:
621  */