Modular Debugger Guide
PreviousNext

Document Information

1. Modular Debugger Overview

2. Debugger Concepts

3. MDB Language Syntax

4. Using MDB Commands Interactively

5. Built-In Commands

6. Execution Control

7. Kernel Execution Control

8. Kernel Debugging Modules

9. Debugging With the Kernel Memory Allocator

10. Module Programming API

Appendix 1: Options

Appendix 2: Notes

Appendix 3: Transition From adb and kadb

Appendix 4: Transition From crash

Appendix 5: Document License

Preface

The Modular Debugger (MDB) is a highly extensible, general purpose debugging tool for the illumosTM Operating System. The Modular Debugger Guide describes how to use MDB to debug complex software systems, with a particular emphasis on the facilities available for debugging the illumos kernel and associated device drivers and modules. It also includes a complete reference for and discussion of the MDB language syntax, debugger features, and MDB Module Programming API.


Note -

This illumos release supports systems that use the SPARCTM and x86 families of processor architectures: UltraSPARCTM, SPARC64, AMD64, Pentium, and Xeon EM64T. In this document the term “x86” refers to 64-bit and 32-bit systems manufactured using processors compatible with the AMD64 or Intel Xeon/Pentium product families. For supported systems, see the illumos Hardware Compatibility Lists at http://illumos.org/hcl/. This document cites any implementation differences between the platform types.


What's New in MDB

Aug 2012 kmdb supports ttyc and ttyd

May 2012 Added tab completion support

Mar 2012 ::printf dcmd added

Aug 2011 Added 16-bit disassembler support

Who Should Use This Book

If you were a detective and were investigating at the scene of a crime, you might interview the witnesses and ask them to describe what happened and who they saw. However, if there were no witnesses or these descriptions proved insufficient, you might consider collecting fingerprints and forensic evidence that could be examined for DNA to help solve the case. Often, software program failures divide into analogous categories: problems that can be solved with source-level debugging tools, and problems that require low-level debugging facilities, examination of core files, and knowledge of assembly language to diagnose and correct. MDB facilitates analysis of this second class of problems.

MDB is most useful when you are programming a complex low-level software system such as an operating system. The MDB debugging framework allows you to construct your own custom analysis tools to aid in the diagnosis of these low-level problems. MDB also provides a powerful set of built-in commands that enable you to analyze the state of your program at the assembly language level.

Before You Read This Book

If you are not familiar with assembly language programming and debugging, Related Books and Papers provides references to materials that you might find useful.

You should disassemble various functions of interest in the programs you will be debugging in order to familiarize yourself with the relationship between your program's source code and the corresponding assembly language code. If you are planning to use MDB for debugging illumos kernel software, read carefully Chapter 8, Kernel Debugging Modules and Chapter 9, Debugging With the Kernel Memory Allocator. These chapters provide more detailed information on the MDB commands and facilities provided for debugging illumos kernel software.

How This Book Is Organized

Chapter 1, Modular Debugger Overview provides an overview of the debugger.

Chapter 2, Debugger Concepts describes the MDB architecture and explains the terminology for the debugger concepts used throughout this book.

Chapter 3, MDB Language Syntax describes the syntax, operators and evaluation rules for the MDB language.

Chapter 4, Using MDB Commands Interactively describes the MDB interactive command-line editing facilities and output pager.

Chapter 5, Built-In Commands describes the set of built-in debugger commands that are always available.

Chapter 6, Execution Control describes the MDB facilities for controlling the execution of live running programs. This chapter is intended for application developers and device driver developers. Execution control features might also be useful for system administrators.

Chapter 7, Kernel Execution Control describes the MDB facilities for controlling the execution of the live operating system kernel that are specific to kmdb. This chapter is intended for operating system kernel developers and device driver developers.

Chapter 8, Kernel Debugging Modules describes the set of loadable debugger commands that are provided for debugging the illumos kernel. This chapter is intended for users who intend to examine illumos kernel crash dumps and for kernel software developers.

Chapter 9, Debugging With the Kernel Memory Allocator describes the debugging features of the illumos kernel memory allocator and the MDB commands provided to take advantage of these features. This chapter is intended for advanced programmers and kernel software developers.

Chapter 10, Module Programming API describes the facilities for writing loadable debugger modules. This chapter is intended for advanced programmers and software developers who intend to develop custom debugging support for MDB.

Appendix A, Options provides a reference for MDB command-line options.

Appendix B, Notes provides warnings and notes about using the debugger.

Appendix C, Transition From adb and kadb provides a reference for adb commands and their MDB equivalents. The adb command is implemented by mdb.

Appendix D, Transition From crash provides a reference for crash commands and their MDB equivalents. The crash command is no longer present in illumos.

Related Books and Papers

The following books and papers are recommended and related to the tasks that you need to perform:

  • Vahalia, Uresh. UNIX Internals: The New Frontiers. Prentice Hall, 2007. ISBN 0-13-021034-0

  • Mauro, Jim and McDougall, Richard. Solaris Performance and Tools: DTrace and MDB Techniques for Solaris 10 and OpenSolaris. Prentice Hall PTR, 2006. ISBN 0-13-156819-8

  • Mauro, Jim and McDougall, Richard. Solaris Internals: Core Kernel Architecture. Prentice Hall PTR, 2000. ISBN 0-13-022496-5

  • The SPARC Architecture Manual, Version 9. Prentice Hall, 2000. ISBN 0–13–825001–4

  • AMD64 Architecture Programmer's Manual. Advanced Micro Devices, 2006. Available at .

  • Pentium Pro Family Developer's Manual, Volumes 1-3. Intel Corporation, 1996. ISBN 1-55512-259-0 (Volume 1) , ISBN 1-55512-260-4 (Volume 2) , ISBN 1-55512-261-2 (Volume 3)

  • Bonwick, Jeff, and Jonathan Adams. Magazines and Vmem: Extending the Slab Allocator to Many CPUs and Arbitrary Resourceso. Proceedings of the 2001 USENIX Annual Technical Conference, 2001. Available at .

  • Bonwick, Jeff. The Slab Allocator: An Object-Caching Kernel Memory Allocator. Proceedings of the Summer 1994 Usenix Conference, 1994. ISBN 9–99–452010–5. Available at .

  • SPARC Assembly Language Reference Manual. Sun Microsystems, 2002.

  • x86 Assembly Language Reference Manual. Sun Microsystems, 2005.

  • Writing Device Drivers. Sun Microsystems, 2008.

  • STREAMS Programming Guide. Sun Microsystems, 2000.

  • Solaris 64-bit Developer’s Guide. Sun Microsystems, 2000.

  • Linker and Libraries Guide. Sun Microsystems, 2007.

Third-party URLs are referenced in this document and provide additional, related information.


Note -

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.


Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Typographic Conventions

Typeface

Meaning

Example

AaBbCc123

The names of commands, files, and directories, and onscreen computer output

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.

AaBbCc123

What you type, contrasted with onscreen computer output

machine_name% su

Password:

aabbcc123

Placeholder: replace with a real name or value

The command to remove a file is rm filename.

AaBbCc123

Book titles, new terms, and terms to be emphasized

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Note: Some emphasized items appear bold online.

Shell Prompts in Command Examples

The following table shows the default UNIXTM system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Shell Prompts

Shell

Prompt

C shell

machine_name%

C shell for superuser

machine_name#

Bourne shell and Korn shell

$

Bourne shell and Korn shell for superuser

#

PreviousNext