Debugging390.txt
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:94k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1.               
  2.                           Debugging on Linux for s/390 & z/Architecture
  3.                by
  4. Denis Joseph Barrow (djbarrow@de.ibm.com,barrow_dj@yahoo.com)
  5. Copyright (C) 2000-2001 IBM Deutschland Entwicklung GmbH, IBM Corporation
  6.                               Best viewed with fixed width fonts 
  7. Overview of Document:
  8. =====================
  9. This document is intended to give an good overview of how to debug 
  10. Linux for s/390 & z/Architecture it isn't intended as a complete reference & not a
  11. tutorial on the fundamentals of C & assembly, it dosen't go into
  12. 390 IO in any detail. It is intended to compliment the documents in the
  13. reference section below & any other worthwhile references you get.
  14. It is intended like the Enterprise Systems Architecture/390 Reference Summary
  15. to be printed out & used as a quick cheat sheet self help style reference when
  16. problems occur.
  17. Contents
  18. ========
  19. Register Set
  20. Address Spaces on Intel Linux
  21. Address Spaces on Linux for s/390 & z/Architecture
  22. The Linux for s/390 & z/Architecture Kernel Task Structure
  23. Register Usage & Stackframes on Linux for s/390 & z/Architecture
  24. A sample program with comments
  25. Compiling programs for debugging on Linux for s/390 & z/Architecture
  26. Figuring out gcc compile errors
  27. Debugging Tools
  28. objdump
  29. strace
  30. Performance Debugging 
  31. Debugging under VM
  32. s/390 & z/Architecture IO Overview
  33. Debugging IO on s/390 & z/Architecture under VM
  34. GDB on s/390 & z/Architecture
  35. Stack chaining in gdb by hand
  36. Examining core dumps
  37. ldd
  38. Debugging modules
  39. The proc file system
  40. Starting points for debugging scripting languages etc.
  41. SysRq
  42. References
  43. Special Thanks
  44. Register Set
  45. ============
  46. The current architectures have the following registers.
  47.  
  48. 16  General propose registers, 32 bit on s/390 64 bit on z/Architecture, r0-r15 or gpr0-gpr15 used for arithmetic & addressing. 
  49. 16 Control registers, 32 bit on s/390 64 bit on z/Architecture, ( cr0-cr15 kernel usage only ) used for memory managment,
  50. interrupt control,debugging control etc.
  51. 16 Access registers ( ar0-ar15 ) 32 bit on s/390 & z/Architecture
  52. not used by normal programs but potentially could 
  53. be used as temporary storage. Their main purpose is their 1 to 1
  54. association with general purpose registers and are used in
  55. the kernel for copying data between kernel & user address spaces.
  56. Access register 0 ( & access register 1 on z/Architecture ( needs 64 bit 
  57. pointer ) ) is currently used by the pthread library as a pointer to
  58. the current running threads private area.
  59. 16 64 bit floating point registers (fp0-fp15 ) IEEE & HFP floating 
  60. point format compliant on G5 upwards & a Floating point control reg (FPC) 
  61. 4  64 bit registers (fp0,fp2,fp4 & fp6) HFP only on older machines.
  62. Note:
  63. Linux (currently) always uses IEEE & emulates G5 IEEE format on older machines,
  64. ( provided the kernel is configured for this ).
  65. The PSW is the most important register on the machine it
  66. is 64 bit on s/390 & 128 bit on z/Architecture & serves the roles of 
  67. a program counter (pc), condition code register,memory space designator.
  68. In IBM standard notation I am counting bit 0 as the MSB.
  69. It has several advantages over a normal program counter
  70. in that you can change address translation & program counter 
  71. in a single instruction. To change address translation,
  72. e.g. switching address translation off requires that you
  73. have a logical=physical mapping for the address you are
  74. currently running at.
  75.       Bit           Value
  76. s/390 z/Architecture
  77. 0       0     Reserved ( must be 0 ) otherwise specification exception occurs.
  78. 1       1     Program Event Recording 1 PER enabled, 
  79.       PER is used to facilititate debugging e.g. single stepping.
  80. 2-4    2-4    Reserved ( must be 0 ). 
  81. 5       5     Dynamic address translation 1=DAT on.
  82. 6       6     Input/Output interrupt Mask
  83. 7       7     External interrupt Mask used primarily for interprocessor signalling & 
  84.       clock interupts.
  85. 8-11  8-11    PSW Key used for complex memory protection mechanism not used under linux
  86. 12      12    1 on s/390 0 on z/Architecture
  87. 13      13    Machine Check Mask 1=enable machine check interrupts
  88. 14      14    Wait State set this to 1 to stop the processor except for interrupts & give 
  89.       time to other LPARS used in CPU idle in the kernel to increase overall 
  90.       usage of processor resources.
  91. 15      15    Problem state ( if set to 1 certain instructions are disabled )
  92.       all linux user programs run with this bit 1 
  93.       ( useful info for debugging under VM ).
  94. 16-17 16-17   Address Space Control
  95.       00 Primary Space Mode when DAT on
  96.       The linux kernel currently runs in this mode, CR1 is affiliated with 
  97.               this mode & points to the primary segment table origin etc.
  98.       01 Access register mode this mode is used in functions to 
  99.       copy data between kernel & user space.
  100.       10 Secondary space mode not used in linux however CR7 the
  101.       register affiliated with this mode is & this & normally
  102.       CR13=CR7 to allow us to copy data between kernel & user space.
  103.       We do this as follows:
  104.       We set ar2 to 0 to designate its
  105.       affiliated gpr ( gpr2 )to point to primary=kernel space.
  106.       We set ar4 to 1 to designate its
  107.       affiliated gpr ( gpr4 ) to point to secondary=home=user space
  108.       & then essentially do a memcopy(gpr2,gpr4,size) to
  109.       copy data between the address spaces, the reason we use home space for the
  110.       kernel & don't keep secondary space free is that code will not run in 
  111.       secondary space.
  112.       11 Home Space Mode all user programs run in this mode.
  113.       it is affiliated with CR13.
  114. 18-19 18-19   Condition codes (CC)
  115. 20    20      Fixed point overflow mask if 1=FPU exceptions for this event 
  116.               occur ( normally 0 ) 
  117. 21    21      Decimal overflow mask if 1=FPU exceptions for this event occur 
  118.               ( normally 0 )
  119. 22    22      Exponent underflow mask if 1=FPU exceptions for this event occur 
  120.               ( normally 0 )
  121. 23    23      Significance Mask if 1=FPU exceptions for this event occur 
  122.               ( normally 0 )
  123. 24-31 24-30   Reserved Must be 0.
  124.       31      Extended Addressing Mode
  125.       32      Basic Addressing Mode
  126.               Used to set addressing mode
  127.       PSW 31   PSW 32
  128.                 0         0        24 bit
  129.                 0         1        31 bit
  130.                 1         1        64 bit
  131. 32             1=31 bit addressing mode 0=24 bit addressing mode (for backward 
  132.                compatibility ), linux always runs with this bit set to 1
  133. 33-64          Instruction address.
  134.       33-63    Reserved must be 0
  135.       64-127   Address
  136.                In 24 bits mode bits 64-103=0 bits 104-127 Address 
  137.                In 31 bits mode bits 64-96=0 bits 97-127 Address
  138.                Note: unlike 31 bit mode on s/390 bit 96 must be zero
  139.        when loading the address with LPSWE otherwise a 
  140.                specification exception occurs, LPSW is fully backward
  141.                compatible.
  142.     
  143.   
  144. Prefix Page(s)
  145. --------------   
  146. This per cpu memory area is too intimately tied to the processor not to mention.
  147. It exists between the real addresses 0-4096 on s/390 & 0-8192 z/Architecture & is exchanged 
  148. with a 1 page on s/390 or 2 pages on z/Architecture in absolute storage by the set 
  149. prefix instruction in linux'es startup. 
  150. This page is mapped to a different prefix for each processor in an SMP configuration
  151. ( assuming the os designer is sane of course :-) ).
  152. Bytes 0-512 ( 200 hex ) on s/390 & 0-512,4096-4544,4604-5119 currently on z/Architecture 
  153. are used by the processor itself for holding such information as exception indications & 
  154. entry points for exceptions.
  155. Bytes after 0xc00 hex are used by linux for per processor globals on s/390 & z/Architecture 
  156. ( there is a gap on z/Architecure too currently between 0xc00 & 1000 which linux uses ).
  157. The closest thing to this on traditional architectures is the interrupt
  158. vector table. This is a good thing & does simplify some of the kernel coding
  159. however it means that we now cannot catch stray NULL pointers in the
  160. kernel without hard coded checks.
  161. Address Spaces on Intel Linux
  162. =============================
  163. The traditional Intel Linux is approximately mapped as follows forgive
  164. the ascii art.
  165. 0xFFFFFFFF 4GB Himem                        *****************
  166.                                             *               *
  167.                                             * Kernel Space  *
  168.                                             *               *
  169.                                             *****************          ****************
  170. User Space Himem (typically 0xC0000000 3GB )*  User Stack   *          *              *
  171.             *****************          *              *
  172.     *  Shared Libs  *          * Next Process *          
  173.                                             *****************          *     to       *  
  174.     *               *    <==   *     Run      *  <==
  175.     *  User Program *          *              *
  176.     *   Data BSS    *          *              *
  177.                                             *  Text       *          *              *
  178.                       *   Sections    *          *              *
  179. 0x00000000              *****************          ****************
  180. Now it is easy to see that on Intel it is quite easy to recognise a kernel address 
  181. as being one greater than user space himem ( in this case 0xC0000000).
  182. & addresses of less than this are the ones in the current running program on this
  183. processor ( if an smp box ).
  184. If using the virtual machine ( VM ) as a debugger it is quite difficult to
  185. know which user process is running as the address space you are looking at
  186. could be from any process in the run queue.
  187. The limitation of Intels addressing technique is that the linux
  188. kernel uses a very simple real address to virtual addressing technique
  189. of Real Address=Virtual Address-User Space Himem.
  190. This means that on Intel the kernel linux can typically only address
  191. Himem=0xFFFFFFFF-0xC0000000=1GB & this is all the RAM these machines
  192. can typically use.
  193. They can lower User Himem to 2GB or lower & thus be
  194. able to use 2GB of RAM however this shrinks the maximum size
  195. of User Space from 3GB to 2GB they have a no win limit of 4GB unless
  196. they go to 64 Bit.
  197. On 390 our limitations & strengths make us slightly different.
  198. For backward compatibility ( because of the psw address hi bit which
  199. indicates whether we are in 31 or 64 bit mode ) we are only allowed 
  200. use 31 bits (2GB) of our 32 bit addresses. However, 
  201. we use entirely separate address  spaces for the user & kernel.
  202. This means we can support 2GB of non Extended RAM on s/390, & more
  203. with the Extended memory managment swap device & 
  204. currently 4TB of physical memory currently on z/Architecture.
  205. Address Spaces on Linux for s/390 & z/Architecture
  206. ==================================================
  207. Our addressing scheme is as follows
  208. Himem 0x7fffffff 2GB on s/390    *****************          ****************
  209. currently 0x3ffffffffff (2^42)-1 *  User Stack   *          *              *
  210. on z/Architecture.  *****************          *              *
  211.                  *  Shared Libs  *          *              *      
  212.                                  *****************          *              *  
  213.          *               *          *    Kernel    *  
  214.                  *  User Program *          *              *
  215.                  *   Data BSS    *          *              *
  216.                                  *    Text       *          *              *
  217.               *   Sections    *          *              *
  218. 0x00000000                       *****************          ****************
  219. This also means that we need to look at the PSW problem state bit
  220. or the addressing mode to decide whether we are looking at
  221. user or kernel space.
  222. Virtual Addresses on s/390 & z/Architecture
  223. ===========================================
  224. A virtual address on s/390 is made up of 3 parts
  225. The SX ( segment index, roughly corresponding to the PGD & PMD in linux terminology ) 
  226. being bits 1-11.
  227. The PX ( page index, corresponding to the page table entry (pte) in linux terminology )
  228. being bits 12-19. 
  229. The remaining bits BX (the byte index are the offset in the page )
  230. i.e. bits 20 to 31.
  231. On z/Architecture in linux we currently make up an address from 4 parts.
  232. The region index bits (RX) 0-32 we currently use bits 22-32
  233. The segment index (SX) being bits 33-43
  234. The page index (PX) being bits  44-51
  235. The byte index (BX) being bits  52-63
  236. Notes:
  237. 1) s/390 has no PMD so the PMD is really the PGD also.
  238. A lot of this stuff is defined in pgtable.h.
  239. 2) Also seeing as s/390's page indexes are only 1k  in size 
  240. (bits 12-19 x 4 bytes per pte ) we use 1 ( page 4k )
  241. to make the best use of memory by updating 4 segment indices 
  242. entries each time we mess with a PMD & use offsets 
  243. 0,1024,2048 & 3072 in this page as for our segment indexes.
  244. On z/Architecture our page indexes are now 2k in size
  245. ( bits 12-19 x 8 bytes per pte ) we do a similar trick
  246. but only mess with 2 segment indices each time we mess with
  247. a PMD.
  248. 3) As z/Architecture supports upto a massive 5-level page table lookup we 
  249. can only use 3 currently on Linux ( as this is all the generic kernel
  250. currently supports ) however this may change in future
  251. this allows us to access ( according to my sums )
  252. 4TB of virtual storage per process i.e.
  253. 4096*512(PTES)*1024(PMDS)*2048(PGD) = 4398046511104 bytes,
  254. enough for another 2 or 3 of years I think :-).
  255. to do this we use a region-third-table designation type in
  256. our address space control registers.
  257.  
  258. The Linux for s/390 & z/Architecture Kernel Task Structure
  259. ==========================================================
  260. Each process/thread under Linux for S390 has its own kernel task_struct
  261. defined in linux/include/linux/sched.h
  262. The S390 on initialisation & resuming of a process on a cpu sets
  263. the __LC_KERNEL_STACK variable in the spare prefix area for this cpu
  264. ( which we use for per processor globals).
  265. The kernel stack pointer is intimately tied with the task stucture for
  266. each processor as follows.
  267.                       s/390
  268.             ************************
  269.             *  1 page kernel stack *
  270.     *        ( 4K )        *
  271.             ************************
  272.             *   1 page task_struct *        
  273.             *        ( 4K )        *
  274. 8K aligned  ************************ 
  275.                  z/Architecture
  276.             ************************
  277.             *  2 page kernel stack *
  278.     *        ( 8K )        *
  279.             ************************
  280.             *  2 page task_struct  *        
  281.             *        ( 8K )        *
  282. 16K aligned ************************ 
  283. What this means is that we don't need to dedicate any register or global variable
  284. to point to the current running process & can retrieve it with the following
  285. very simple construct for s/390 & one very similar for z/Architecture.
  286. static inline struct task_struct * get_current(void)
  287. {
  288.         struct task_struct *current;
  289.         __asm__("lhi   %0,-8192nt"
  290.                 "nr    %0,15"
  291.                 : "=r" (current) );
  292.         return current;
  293. }
  294. i.e. just anding the current kernel stack pointer with the mask -8192.
  295. Thankfully because Linux dosen't have support for nested IO interrupts
  296. & our devices have large buffers can survive interrupts being shut for 
  297. short amounts of time we don't need a separate stack for interrupts.
  298. Register Usage & Stackframes on Linux for s/390 & z/Architecture
  299. =================================================================
  300. Overview:
  301. ---------
  302. This is the code that gcc produces at the top & the bottom of
  303. each function, it usually is fairly consistent & similar from 
  304. function to function & if you know its layout you can probalby
  305. make some headway in finding the ultimate cause of a problem
  306. after a crash without a source level debugger.
  307. Note: To follow stackframes requires a knowledge of C or Pascal &
  308. limited knowledge of one assembly language.
  309. It should be noted that there are some differences between the
  310. s/390 & z/Architecture stack layouts as the z/Architecture stack layout didn't have
  311. to maintain compatibility with older linkage formats.
  312. Glossary:
  313. ---------
  314. alloca:
  315. This is a built in compiler function for runtime allocation
  316. of extra space on the callers stack which is obviously freed
  317. up on function exit ( e.g. the caller may choose to allocate nothing
  318. of a buffer of 4k if required for temporary purposes ), it generates 
  319. very efficent code ( a few cycles  ) when compared to alternatives 
  320. like malloc.
  321. automatics: These are local variables on the stack,
  322. i.e they aren't in registers & they aren't static.
  323. back-chain:
  324. This is a pointer to the stack pointer before entering a
  325. framed functions ( see frameless function ) prologue got by 
  326. deferencing the address of the current stack pointer,
  327.  i.e. got by accessing the 32 bit value at the stack pointers
  328. current location.
  329. base-pointer:
  330. This is a pointer to the back of the literal pool which
  331. is an area just behind each procedure used to store constants
  332. in each function.
  333. call-clobbered: The caller probably needs to save these registers if there 
  334. is something of value in them, on the stack or elsewhere before making a 
  335. call to another procedure so that it can restore it later.
  336. epilogue:
  337. The code generated by the compiler to return to the caller.
  338. frameless-function
  339. A frameless function in Linux for s390 & z/Architecture is one which doesn't 
  340. need more than the register save area ( 96 bytes on s/390, 160 on z/Architecture )
  341. given to it by the caller.
  342. A frameless function never:
  343. 1) Sets up a back chain.
  344. 2) Calls alloca.
  345. 3) Calls other normal functions
  346. 4) Has automatics.
  347. GOT-pointer:
  348. This is a pointer to the global-offset-table in ELF
  349. ( Executable Linkable Format, Linux'es most common executable format ),
  350. all globals & shared library objects are found using this pointer.
  351. lazy-binding
  352. ELF shared libraries are typically only loaded when routines in the shared
  353. library are actually first called at runtime. This is lazy binding.
  354. procedure-linkage-table
  355. This is a table found from the GOT which contains pointers to routines
  356. in other shared libraries which can't be called to by easier means.
  357. prologue:
  358. The code generated by the compiler to set up the stack frame.
  359. outgoing-args:
  360. This is extra area allocated on the stack of the calling function if the
  361. parameters for the callee's cannot all be put in registers, the same
  362. area can be reused by each function the caller calls.
  363. routine-descriptor:
  364. A COFF  executable format based concept of a procedure reference 
  365. actually being 8 bytes or more as opposed to a simple pointer to the routine.
  366. This is typically defined as follows
  367. Routine Descriptor offset 0=Pointer to Function
  368. Routine Descriptor offset 4=Pointer to Table of Contents
  369. The table of contents/TOC is roughly equivalent to a GOT pointer.
  370. & it means that shared libraries etc. can be shared between several
  371. environments each with their own TOC.
  372.  
  373. static-chain: This is used in nested functions a concept adopted from pascal 
  374. by gcc not used in ansi C or C++ ( although quite useful ), basically it
  375. is a pointer used to reference local variables of enclosing functions.
  376. You might come across this stuff once or twice in your lifetime.
  377. e.g.
  378. The function below should return 11 though gcc may get upset & toss warnings 
  379. about unused variables.
  380. int FunctionA(int a)
  381. {
  382. int b;
  383. FunctionC(int c)
  384. {
  385. b=c+1;
  386. }
  387. FunctionC(10);
  388. return(b);
  389. }
  390. s/390 & z/Architecture Register usage
  391. =====================================
  392. r0       used by syscalls/assembly                  call-clobbered
  393. r1  used by syscalls/assembly                  call-clobbered
  394. r2       argument 0 / return value 0                call-clobbered
  395. r3       argument 1 / return value 1 (if long long) call-clobbered
  396. r4       argument 2                                 call-clobbered
  397. r5       argument 3                                 call-clobbered
  398. r6  argument 5                                 saved
  399. r7       pointer-to arguments 5 to ...              saved      
  400. r8       this & that                                saved
  401. r9       this & that                                saved
  402. r10      static-chain ( if nested function )        saved
  403. r11      frame-pointer ( if function used alloca )  saved
  404. r12      got-pointer                                saved
  405. r13      base-pointer                               saved
  406. r14      return-address                             saved
  407. r15      stack-pointer                              saved
  408. f0       argument 0 / return value ( float/double ) call-clobbered
  409. f2       argument 1                                 call-clobbered
  410. f4       z/Architecture argument 2                  saved
  411. f6       z/Architecture argument 3                  saved
  412. The remaining floating points
  413. f1,f3,f5 f7-f15 are call-clobbered.
  414. Notes:
  415. ------
  416. 1) The only requirement is that registers which are used
  417. by the callee are saved, e.g. the compiler is perfectly
  418. capible of using r11 for purposes other than a frame a
  419. frame pointer if a frame pointer is not needed.
  420. 2) In functions with variable arguments e.g. printf the calling procedure 
  421. is identical to one without variable arguments & the same number of 
  422. parameters. However, the prologue of this function is somewhat more
  423. hairy owing to it having to move these parameters to the stack to
  424. get va_start, va_arg & va_end to work.
  425. 3) Access registers are currently unused by gcc but are used in
  426. the kernel. Possibilities exist to use them at the moment for
  427. temporary storage but it isn't recommended.
  428. 4) Only 4 of the floating point registers are used for
  429. parameter passing as older machines such as G3 only have only 4
  430. & it keeps the stack frame compatible with other compilers.
  431. However with IEEE floating point emulation under linux on the
  432. older machines you are free to use the other 12.
  433. 5) A long long or double parameter cannot be have the 
  434. first 4 bytes in a register & the second four bytes in the 
  435. outgoing args area. It must be purely in the outgoing args
  436. area if crossing this boundary.
  437. 6) Floating point parameters are mixed with outgoing args
  438. on the outgoing args area in the order the are passed in as parameters.
  439. 7) Floating point arguments 2 & 3 are saved in the outgoing args area for 
  440. z/Architecture
  441. Stack Frame Layout
  442. ------------------
  443. s/390     z/Architecture
  444. 0         0             back chain ( a 0 here signifies end of back chain )
  445. 4         8             eos ( end of stack, not used on Linux for S390 used in other linkage formats )
  446. 8         16            glue used in other s/390 linkage formats for saved routine descriptors etc.
  447. 12        24            glue used in other s/390 linkage formats for saved routine descriptors etc.
  448. 16        32            scratch area
  449. 20        40            scratch area
  450. 24        48            saved r6 of caller function
  451. 28        56            saved r7 of caller function
  452. 32        64            saved r8 of caller function
  453. 36        72            saved r9 of caller function
  454. 40        80            saved r10 of caller function
  455. 44        88            saved r11 of caller function
  456. 48        96            saved r12 of caller function
  457. 52        104           saved r13 of caller function
  458. 56        112           saved r14 of caller function
  459. 60        120           saved r15 of caller function
  460. 64        128           saved f4 of caller function
  461. 72        132           saved f6 of caller function
  462. 80                      undefined
  463. 96        160           outgoing args passed from caller to callee
  464. 96+x      160+x         possible stack alignment ( 8 bytes desirable )
  465. 96+x+y    160+x+y       alloca space of caller ( if used )
  466. 96+x+y+z  160+x+y+z     automatics of caller ( if used )
  467. 0                       back-chain
  468. A sample program with comments.
  469. ===============================
  470. Comments on the function test
  471. -----------------------------
  472. 1) It didn't need to set up a pointer to the constant pool gpr13 as it isn't used
  473. ( :-( ).
  474. 2) This is a frameless function & no stack is bought.
  475. 3) The compiler was clever enough to recognise that it could return the
  476. value in r2 as well as use it for the passed in parameter ( :-) ).
  477. 4) The basr ( branch relative & save ) trick works as follows the instruction 
  478. has a special case with r0,r0 with some instruction operands is understood as 
  479. the literal value 0, some risc architectures also do this ). So now
  480. we are branching to the next address & the address new program counter is
  481. in r13,so now we subtract the size of the function prologue we have executed
  482. + the size of the literal pool to get to the top of the literal pool
  483. 0040037c int test(int b)
  484. {                                                          # Function prologue below
  485.   40037c: 90 de f0 34  stm %r13,%r14,52(%r15) # Save registers r13 & r14
  486.   400380: 0d d0        basr %r13,%r0           # Set up pointer to constant pool using
  487.   400382: a7 da ff fa  ahi %r13,-6            # basr trick
  488. return(5+b);
  489.                                                    # Huge main program
  490.   400386: a7 2a 00 05  ahi %r2,5              # add 5 to r2
  491.                                                            # Function epilogue below 
  492.   40038a: 98 de f0 34  lm %r13,%r14,52(%r15) # restore registers r13 & 14
  493.   40038e: 07 fe        br %r14               # return
  494. }
  495. Comments on the function main
  496. -----------------------------
  497. 1) The compiler did this function optimally ( 8-) )
  498. Literal pool for main.
  499. 400390: ff ff ff ec  .long 0xffffffec
  500. main(int argc,char *argv[])
  501. {                                                          # Function prologue below
  502.   400394: 90 bf f0 2c  stm %r11,%r15,44(%r15) # Save necessary registers
  503.   400398: 18 0f        lr %r0,%r15           # copy stack pointer to r0
  504.   40039a: a7 fa ff a0  ahi %r15,-96           # Make area for callee saving 
  505.   40039e: 0d d0        basr %r13,%r0           # Set up r13 to point to
  506.   4003a0: a7 da ff f0  ahi %r13,-16           # literal pool
  507.   4003a4: 50 00 f0 00  st %r0,0(%r15)        # Save backchain
  508. return(test(5));                                   # Main Program Below
  509.   4003a8: 58 e0 d0 00  l %r14,0(%r13)       # load relative address of test from
  510.            # literal pool
  511.   4003ac: a7 28 00 05  lhi %r2,5              # Set first parameter to 5
  512.   4003b0: 4d ee d0 00  bas %r14,0(%r14,%r13)  # jump to test setting r14 as return
  513.    # address using branch & save instruction.
  514.    # Function Epilogue below
  515.   4003b4: 98 bf f0 8c  lm %r11,%r15,140(%r15)# Restore necessary registers.
  516.   4003b8: 07 fe        br %r14               # return to do program exit 
  517. }
  518. Compiler updates
  519. ----------------
  520. main(int argc,char *argv[])
  521. {
  522.   4004fc: 90 7f f0 1c        stm %r7,%r15,28(%r15)
  523.   400500: a7 d5 00 04        bras %r13,400508 <main+0xc>
  524.   400504: 00 40 04 f4        .long 0x004004f4 
  525.   # compiler now puts constant pool in code to so it saves an instruction 
  526.   400508: 18 0f              lr %r0,%r15
  527.   40050a: a7 fa ff a0        ahi %r15,-96
  528.   40050e: 50 00 f0 00        st %r0,0(%r15)
  529. return(test(5));
  530.   400512: 58 10 d0 00        l %r1,0(%r13)
  531.   400516: a7 28 00 05        lhi %r2,5
  532.   40051a: 0d e1              basr %r14,%r1
  533.   # compiler adds 1 extra instruction to epilogue this is done to
  534.   # avoid processor pipeline stalls owing to data dependencies on g5 &
  535.   # above as register 14 in the old code was needed directly after being loaded 
  536.   # by the lm %r11,%r15,140(%r15) for the br %14.
  537.   40051c: 58 40 f0 98        l %r4,152(%r15)
  538.   400520: 98 7f f0 7c        lm %r7,%r15,124(%r15)
  539.   400524: 07 f4              br %r4
  540. }
  541. Hartmut ( our compiler developer ) also has been threatening to take out the
  542. stack backchain in optimised code as this also causes pipeline stalls, you
  543. have been warned.
  544. 64 bit z/Architecture code disassembly
  545. --------------------------------------
  546. If you understand the stuff above you'll understand the stuff
  547. below too so I'll avoid repeating myself & just say that 
  548. some of the instructions have g's on the end of them to indicate
  549. they are 64 bit & the stack offsets are a bigger, 
  550. the only other difference you'll find between 32 & 64 bit is that
  551. we now use f4 & f6 for floating point arguments on 64 bit.
  552. 00000000800005b0 <test>:
  553. int test(int b)
  554. {
  555. return(5+b);
  556.     800005b0: a7 2a 00 05        ahi %r2,5
  557.     800005b4: b9 14 00 22        lgfr %r2,%r2 # downcast to integer
  558.     800005b8: 07 fe              br %r14
  559.     800005ba: 07 07              bcr 0,%r7
  560. }
  561. 00000000800005bc <main>:
  562. main(int argc,char *argv[])
  563.     800005bc: eb bf f0 58 00 24  stmg %r11,%r15,88(%r15)
  564.     800005c2: b9 04 00 1f        lgr %r1,%r15
  565.     800005c6: a7 fb ff 60        aghi %r15,-160
  566.     800005ca: e3 10 f0 00 00 24  stg %r1,0(%r15)
  567. return(test(5));
  568.     800005d0: a7 29 00 05        lghi %r2,5
  569.     # brasl allows jumps > 64k & is overkill here bras would do fune
  570.     800005d4: c0 e5 ff ff ff ee  brasl %r14,800005b0 <test> 
  571.     800005da: e3 40 f1 10 00 04  lg %r4,272(%r15)
  572.     800005e0: eb bf f0 f8 00 04  lmg %r11,%r15,248(%r15)
  573.     800005e6: 07 f4              br %r4
  574. }
  575. Compiling programs for debugging on Linux for s/390 & z/Architecture
  576. ====================================================================
  577. -gdwarf-2 now works it should be considered the default debugging
  578. format for s/390 & z/Architecture as it is more reliable for debugging
  579. shared libraries,  normal -g debugging works much better now
  580. Thanks to the IBM java compiler developers bug reports. 
  581. This is typically done adding/appending the flags -g or -gdwarf-2 to the 
  582. CFLAGS & LDFLAGS variables Makefile of the program concerned.
  583. If using gdb & you would like accurate displays of registers &
  584.  stack traces compile without optimisation i.e make sure
  585. that there is no -O2 or similar on the CFLAGS line of the Makefile &
  586. the emitted gcc commands, obviously this will produce worse code 
  587. ( not advisable for shipment ) but it is an  aid to the debugging process.
  588. This aids debugging because the compiler will copy parameters passed in
  589. in registers onto the stack so backtracing & looking at passed in
  590. parameters will work, however some larger programs which use inline functions
  591. will not compile without optimisation.
  592. Debugging with optimisation has since much improved after fixing
  593. some bugs, please make sure you are using gdb-5.0 or later developed 
  594. after Nov'2000.
  595. Figuring out gcc compile errors
  596. ===============================
  597. If you are getting a lot of syntax errors compiling a program & the problem
  598. isn't blatantly obvious from the source.
  599. It often helps to just preprocess the file, this is done with the -E
  600. option in gcc.
  601. What this does is that it runs through the very first phase of compilation
  602. ( compilation in gcc is done in several stages & gcc calls many programs to
  603. achieve its end result ) with the -E option gcc just calls the gcc preprocessor (cpp).
  604. The c preprocessor does the following, it joins all the files #included together
  605. recursively ( #include files can #include other files ) & also the c file you wish to compile.
  606. It puts a fully qualified path of the #included files in a comment & it
  607. does macro expansion.
  608. This is useful for debugging because
  609. 1) You can double check whether the files you expect to be included are the ones
  610. that are being included ( e.g. double check that you aren't going to the i386 asm directory ).
  611. 2) Check that macro definitions aren't clashing with typedefs,
  612. 3) Check that definitons aren't being used before they are being included.
  613. 4) Helps put the line emitting the error under the microscope if it contains macros.
  614. For convenience the Linux kernel's makefile will do preprocessing automatically for you
  615. by suffixing the file you want built with .i ( instead of .o )
  616. e.g.
  617. from the linux directory type
  618. make arch/s390/kernel/signal.i
  619. this will build
  620. s390-gcc -D__KERNEL__ -I/home1/barrow/linux/include -Wall -Wstrict-prototypes -O2 -fomit-frame-pointer
  621. -fno-strict-aliasing -D__SMP__ -pipe -fno-strength-reduce   -E arch/s390/kernel/signal.c
  622. > arch/s390/kernel/signal.i  
  623. Now look at signal.i you should see something like.
  624. # 1 "/home1/barrow/linux/include/asm/types.h" 1
  625. typedef unsigned short umode_t;
  626. typedef __signed__ char __s8;
  627. typedef unsigned char __u8;
  628. typedef __signed__ short __s16;
  629. typedef unsigned short __u16;
  630. If instead you are getting errors further down e.g.
  631. unknown instruction:2515 "move.l" or better still unknown instruction:2515 
  632. "Fixme not implemented yet, call Martin" you are probably are attempting to compile some code 
  633. meant for another architecture or code that is simply not implemented, with a fixme statement
  634. stuck into the inline assembly code so that the author of the file now knows he has work to do.
  635. To look at the assembly emitted by gcc just before it is about to call gas ( the gnu assembler )
  636. use the -S option.
  637. Again for your convenience the Linux kernel's Makefile will hold your hand &
  638. do all this donkey work for you also by building the file with the .s suffix.
  639. e.g.
  640. from the Linux directory type 
  641. make arch/s390/kernel/signal.s 
  642. s390-gcc -D__KERNEL__ -I/home1/barrow/linux/include -Wall -Wstrict-prototypes -O2 -fomit-frame-pointer
  643. -fno-strict-aliasing -D__SMP__ -pipe -fno-strength-reduce  -S arch/s390/kernel/signal.c 
  644. -o arch/s390/kernel/signal.s  
  645. This will output something like, ( please note the constant pool & the useful comments
  646. in the prologue to give you a hand at interpreting it ).
  647. .LC54:
  648. .string "misaligned (__u16 *) in __xchgn"
  649. .LC57:
  650. .string "misaligned (__u32 *) in __xchgn"
  651. .L$PG1: # Pool sys_sigsuspend
  652. .LC192:
  653. .long -262401
  654. .LC193:
  655. .long -1
  656. .LC194:
  657. .long schedule-.L$PG1
  658. .LC195:
  659. .long do_signal-.L$PG1
  660. .align 4
  661. .globl sys_sigsuspend
  662. .type  sys_sigsuspend,@function
  663. sys_sigsuspend:
  664. # leaf function           0
  665. # automatics              16
  666. # outgoing args           0
  667. # need frame pointer      0
  668. # call alloca             0
  669. # has varargs             0
  670. # incoming args (stack)   0
  671. # function length         168
  672. STM 8,15,32(15)
  673. LR 0,15
  674. AHI 15,-112
  675. BASR 13,0
  676. .L$CO1: AHI 13,.L$PG1-.L$CO1
  677. ST 0,0(15)
  678. LR    8,2
  679. N     5,.LC192-.L$PG1(13) 
  680. Adding -g to the above output makes the output even more useful
  681. e.g. typing
  682. make CC:="s390-gcc -g" kernel/sched.s
  683. which compiles.
  684. s390-gcc -g -D__KERNEL__ -I/home/barrow/linux-2.3/include -Wall -Wstrict-prototypes -O2 -fomit-frame-pointer -fno-strict-aliasing -pipe -fno-strength-reduce   -S kernel/sched.c -o kernel/sched.s 
  685. also outputs stabs ( debugger ) info, from this info you can find out the
  686. offsets & sizes of various elements in structures.
  687. e.g. the stab for the structure
  688. struct rlimit {
  689. unsigned long rlim_cur;
  690. unsigned long rlim_max;
  691. };
  692. is
  693. .stabs "rlimit:T(151,2)=s8rlim_cur:(0,5),0,32;rlim_max:(0,5),32,32;;",128,0,0,0
  694. from this stab you can see that 
  695. rlimit_cur starts at bit offset 0 & is 32 bits in size
  696. rlimit_max starts at bit offset 32 & is 32 bits in size.
  697. Debugging Tools:
  698. ================
  699. objdump
  700. =======
  701. This is a tool with many options the most useful being ( if compiled with -g).
  702. objdump --source <victim program or object file> > <victims debug listing >
  703. The whole kernel can be compiled like this ( Doing this will make a 17MB kernel
  704. & a 200 MB listing ) however you have to strip it before building the image
  705. using the strip command to make it a more reasonable size to boot it.
  706. A source/assembly mixed dump of the kernel can be done with the line
  707. objdump --source vmlinux > vmlinux.lst
  708. Also if the file isn't compiled -g this will output as much debugging information
  709. as it can ( e.g. function names ), however, this is very slow as it spends lots
  710. of time searching for debugging info, the following self explanitory line should be used 
  711. instead if the code isn't compiled -g.
  712. objdump --disassemble-all --syms vmlinux > vmlinux.lst  
  713. as it is much faster
  714. As hard drive space is valuble most of us use the following approach.
  715. 1) Look at the emitted psw on the console to find the crash address in the kernel.
  716. 2) Look at the file System.map ( in the linux directory ) produced when building 
  717. the kernel to find the closest address less than the current PSW to find the
  718. offending function.
  719. 3) use grep or similar to search the source tree looking for the source file
  720.  with this function if you don't know where it is.
  721. 4) rebuild this object file with -g on, as an example suppose the file was
  722. ( /arch/s390/kernel/signal.o ) 
  723. 5) Assuming the file with the erroneous function is signal.c Move to the base of the 
  724. Linux source tree.
  725. 6) rm /arch/s390/kernel/signal.o
  726. 7) make /arch/s390/kernel/signal.o
  727. 8) watch the gcc command line emitted
  728. 9) type it in again or alernatively cut & paste it on the console adding the -g option.
  729. 10) objdump --source arch/s390/kernel/signal.o > signal.lst
  730. This will output the source & the assembly intermixed, as the snippet below shows
  731. This will unfortunately output addresses which aren't the same
  732. as the kernel ones you should be able to get around the mental arithmetic
  733. by playing with the --adjust-vma parameter to objdump.
  734. extern inline void spin_lock(spinlock_t *lp)
  735. {
  736.       a0:       18 34           lr      %r3,%r4
  737.       a2:       a7 3a 03 bc     ahi     %r3,956
  738.         __asm__ __volatile("    lhi   1,-1n"
  739.       a6:       a7 18 ff ff     lhi     %r1,-1
  740.       aa:       1f 00           slr     %r0,%r0
  741.       ac:       ba 01 30 00     cs      %r0,%r1,0(%r3)
  742.       b0:       a7 44 ff fd     jm      aa <sys_sigsuspend+0x2e>
  743.         saveset = current->blocked;
  744.       b4:       d2 07 f0 68     mvc     104(8,%r15),972(%r4)
  745.       b8:       43 cc
  746.         return (set->sig[0] & mask) != 0;
  747. 6) If debugging under VM go down to that section in the document for more info.
  748. I now have a tool which takes the pain out of --adjust-vma
  749. & you are able to do something like
  750. make /arch/s390/kernel/traps.lst
  751. & it automatically generates the correctly relocated entries for
  752. the text segment in traps.lst.
  753. This tool is now standard in linux distro's in scripts/makelst
  754. strace:
  755. -------
  756. Q. What is it ?
  757. A. It is a tool for intercepting calls to the kernel & logging them
  758. to a file & on the screen.
  759. Q. What use is it ?
  760. A. You can used it to find out what files a particular program opens.
  761. Example 1
  762. ---------
  763. If you wanted to know does ping work but didn't have the source 
  764. strace ping -c 1 127.0.0.1  
  765. & then look at the man pages for each of the syscalls below,
  766. ( In fact this is sometimes easier than looking at some spagetti
  767. source which conditionally compiles for several architectures )
  768. Not everything that it throws out needs to make sense immeadiately
  769. Just looking quickly you can see that it is making up a RAW socket
  770. for the ICMP protocol.
  771. Doing an alarm(10) for a 10 second timeout
  772. & doing a gettimeofday call before & after each read to see 
  773. how long the replies took, & writing some text to stdout so the user
  774. has an idea what is going on.
  775. socket(PF_INET, SOCK_RAW, IPPROTO_ICMP) = 3
  776. getuid()                                = 0
  777. setuid(0)                               = 0
  778. stat("/usr/share/locale/C/libc.cat", 0xbffff134) = -1 ENOENT (No such file or directory)
  779. stat("/usr/share/locale/libc/C", 0xbffff134) = -1 ENOENT (No such file or directory)
  780. stat("/usr/local/share/locale/C/libc.cat", 0xbffff134) = -1 ENOENT (No such file or directory)
  781. getpid()                                = 353
  782. setsockopt(3, SOL_SOCKET, SO_BROADCAST, [1], 4) = 0
  783. setsockopt(3, SOL_SOCKET, SO_RCVBUF, [49152], 4) = 0
  784. fstat(1, {st_mode=S_IFCHR|0620, st_rdev=makedev(3, 1), ...}) = 0
  785. mmap(0, 4096, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0) = 0x40008000
  786. ioctl(1, TCGETS, {B9600 opost isig icanon echo ...}) = 0
  787. write(1, "PING 127.0.0.1 (127.0.0.1): 56 d"..., 42PING 127.0.0.1 (127.0.0.1): 56 data bytes
  788. ) = 42
  789. sigaction(SIGINT, {0x8049ba0, [], SA_RESTART}, {SIG_DFL}) = 0 
  790. sigaction(SIGALRM, {0x8049600, [], SA_RESTART}, {SIG_DFL}) = 0
  791. gettimeofday({948904719, 138951}, NULL) = 0
  792. sendto(3, "10D201a117#217830736"..., 64, 0, {sin_family=AF_INET,
  793. sin_port=htons(0), sin_addr=inet_addr("127.0.0.1")}, 16) = 64
  794. sigaction(SIGALRM, {0x8049600, [], SA_RESTART}, {0x8049600, [], SA_RESTART}) = 0
  795. sigaction(SIGALRM, {0x8049ba0, [], SA_RESTART}, {0x8049600, [], SA_RESTART}) = 0
  796. alarm(10)                               = 0
  797. recvfrom(3, "ET005@1|r1771177"..., 192, 0, 
  798. {sin_family=AF_INET, sin_port=htons(50882), sin_addr=inet_addr("127.0.0.1")}, [16]) = 84
  799. gettimeofday({948904719, 160224}, NULL) = 0
  800. recvfrom(3, "ET0063771275p177"..., 192, 0, 
  801. {sin_family=AF_INET, sin_port=htons(50882), sin_addr=inet_addr("127.0.0.1")}, [16]) = 84
  802. gettimeofday({948904719, 166952}, NULL) = 0
  803. write(1, "64 bytes from 127.0.0.1: icmp_se"..., 
  804. 5764 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=28.0 ms
  805. Example 2
  806. ---------
  807. strace passwd 2>&1 | grep open
  808. produces the following output
  809. open("/etc/ld.so.cache", O_RDONLY)      = 3
  810. open("/opt/kde/lib/libc.so.5", O_RDONLY) = -1 ENOENT (No such file or directory)
  811. open("/lib/libc.so.5", O_RDONLY)        = 3
  812. open("/dev", O_RDONLY)                  = 3
  813. open("/var/run/utmp", O_RDONLY)         = 3
  814. open("/etc/passwd", O_RDONLY)           = 3
  815. open("/etc/shadow", O_RDONLY)           = 3
  816. open("/etc/login.defs", O_RDONLY)       = 4
  817. open("/dev/tty", O_RDONLY)              = 4 
  818. The 2>&1 is done to redirect stderr to stdout & grep is then filtering this input 
  819. through the pipe for each line containing the string open.
  820. Example 3
  821. ---------
  822. Getting sophistocated
  823. telnetd crashes on & I don't know why
  824. Steps
  825. -----
  826. 1) Replace the following line in /etc/inetd.conf
  827. telnet  stream  tcp     nowait  root    /usr/sbin/in.telnetd -h 
  828. with
  829. telnet  stream  tcp     nowait  root    /blah
  830. 2) Create the file /blah with the following contents to start tracing telnetd 
  831. #!/bin/bash
  832. /usr/bin/strace -o/t1 -f /usr/sbin/in.telnetd -h 
  833. 3) chmod 700 /blah to make it executable only to root
  834. 4)
  835. killall -HUP inetd
  836. or ps aux | grep inetd
  837. get inetd's process id
  838. & kill -HUP inetd to restart it.
  839. Important options
  840. -----------------
  841. -o is used to tell strace to output to a file in our case t1 in the root directory
  842. -f is to follow children i.e.
  843. e.g in our case above telnetd will start the login process & subsequently a shell like bash.
  844. You will be able to tell which is which from the process ID's listed on the left hand side
  845. of the strace output.
  846. -p<pid> will tell strace to attach to a running process, yup this can be done provided
  847.  it isn't being traced or debugged already & you have enough privileges,
  848. the reason 2 processes cannot trace or debug the same program is that strace
  849. becomes the parent process of the one being debugged & processes ( unlike people )
  850. can have only one parent.
  851. However the file /t1 will get big quite quickly
  852. to test it telnet 127.0.0.1
  853. now look at what files in.telnetd execve'd
  854. 413   execve("/usr/sbin/in.telnetd", ["/usr/sbin/in.telnetd", "-h"], [/* 17 vars */]) = 0
  855. 414   execve("/bin/login", ["/bin/login", "-h", "localhost", "-p"], [/* 2 vars */]) = 0 
  856. Whey it worked!.
  857. Other hints:
  858. ------------
  859. If the program is not very interactive ( i.e. not much keyboard input )
  860. & is crashing in one architecture but not in another you can do 
  861. an strace of both programs under as identical a scenario as you can
  862. on both architectures outputting to a file then.
  863. do a diff of the two traces using the diff program
  864. i.e.
  865. diff output1 output2
  866. & maybe you'll be able to see where the call paths differed, this
  867. is possibly near the cause of the crash. 
  868. More info
  869. ---------
  870. Look at man pages for strace & the various syscalls
  871. e.g. man strace, man alarm, man socket.
  872. Performance Debugging
  873. =====================
  874. gcc is capible of compiling in profiling code just add the -p option
  875. to the CFLAGS, this obviously affects program size & performance.
  876. This can be used by the gprof gnu profiling tool or the
  877. gcov the gnu code coverage tool ( code coverage is a means of testing
  878. code quality by checking if all the code in an executable in exercised by
  879. a tester ).
  880. Using top to find out where processes are sleeping in the kernel
  881. ----------------------------------------------------------------
  882. To do this copy the System.map from the root directory where
  883. the linux kernel was built to the /boot directory on your 
  884. linux machine.
  885. Start top
  886. Now type fU<return>
  887. You should see a new field called WCHAN which
  888. tells you where each process is sleeping here is a typical output.
  889.  
  890.  6:59pm  up 41 min,  1 user,  load average: 0.00, 0.00, 0.00
  891. 28 processes: 27 sleeping, 1 running, 0 zombie, 0 stopped
  892. CPU states:  0.0% user,  0.1% system,  0.0% nice, 99.8% idle
  893. Mem:   254900K av,   45976K used,  208924K free,       0K shrd,   28636K buff
  894. Swap:       0K av,       0K used,       0K free                    8620K cached
  895.   PID USER     PRI  NI  SIZE  RSS SHARE WCHAN     STAT  LIB %CPU %MEM   TIME COMMAND
  896.   750 root      12   0   848  848   700 do_select S       0  0.1  0.3   0:00 in.telnetd
  897.   767 root      16   0  1140 1140   964           R       0  0.1  0.4   0:00 top
  898.     1 root       8   0   212  212   180 do_select S       0  0.0  0.0   0:00 init
  899.     2 root       9   0     0    0     0 down_inte SW      0  0.0  0.0   0:00 kmcheck
  900. The time command
  901. ----------------
  902. Another related command is the time command which gives you an indication
  903. of where a process is spending the majority of its time.
  904. e.g.
  905. time ping -c 5 nc
  906. outputs
  907. real 0m4.054s
  908. user 0m0.010s
  909. sys 0m0.010s
  910. Debugging under VM
  911. ==================
  912. Notes
  913. -----
  914. Addresses & values in the VM debugger are always hex never decimal
  915. Address ranges are of the format <HexValue1>-<HexValue2> or <HexValue1>.<HexValue2> 
  916. e.g. The address range  0x2000 to 0x3000 can be described described as
  917. 2000-3000 or 2000.1000
  918. The VM Debugger is case insensitive.
  919. VM's strengths are usually other debuggers weaknesses you can get at any resource
  920. no matter how sensitive e.g. memory managment resources,change address translation
  921. in the PSW. For kernel hacking you will reap dividends if you get good at it.
  922. The VM Debugger displays operators but not operands, probably because some
  923. of it was written when memory was expensive & the programmer was probably proud that
  924. it fitted into 2k of memory & the programmers & didn't want to shock hardcore VM'ers by
  925. changing the interface :-), also the debugger displays useful information on the same line & 
  926. the author of the code probably felt that it was a good idea not to go over 
  927. the 80 columns on the screen. 
  928. As some of you are probably in a panic now this isn't as unintuitive as it may seem
  929. as the 390 instructions are easy to decode mentally & you can make a good guess at a lot 
  930. of them as all the operands are nibble ( half byte aligned ) & if you have an objdump listing
  931. also it is quite easy to follow, if you don't have an objdump listing keep a copy of
  932. the s/390 Reference Summary & look at between pages 2 & 7 or alternatively the
  933. s/390 principles of operation.
  934. e.g. even I can guess that 
  935. 0001AFF8' LR    180F        CC 0
  936. is a ( load register ) lr r0,r15 
  937. Also it is very easy to tell the length of a 390 instruction from the 2 most significant
  938. bits in the instruction ( not that this info is really useful except if you are trying to
  939. make sense of a hexdump of code ).
  940. Here is a table
  941. Bits                    Instruction Length
  942. ------------------------------------------
  943. 00                          2 Bytes
  944. 01                          4 Bytes
  945. 10                          4 Bytes
  946. 11                          6 Bytes
  947. The debugger also displays other useful info on the same line such as the
  948. addresses being operated on destination addresses of branches & condition codes.
  949. e.g.  
  950. 00019736' AHI   A7DAFF0E    CC 1
  951. 000198BA' BRC   A7840004 -> 000198C2'   CC 0
  952. 000198CE' STM   900EF068 >> 0FA95E78    CC 2
  953. Useful VM debugger commands
  954. ---------------------------
  955. I suppose I'd better mention this before I start
  956. to list the current active traces do 
  957. Q TR
  958. there can be a maximum of 255 of these per set
  959. ( more about trace sets later ).
  960. To stop traces issue a
  961. TR END.
  962. To delete a particular breakpoint issue
  963. TR DEL <breakpoint number>
  964. The PA1 key drops to CP mode so you can issue debugger commands,
  965. Doing alt c (on my 3270 console at least ) clears the screen. 
  966. hitting b <enter> comes back to the running operating system
  967. from cp mode ( in our case linux ).
  968. It is typically useful to add shortcuts to your profile.exec file
  969. if you have one ( this is roughly equivalent to autoexec.bat in DOS ).
  970. file here are a few from mine.
  971. /* this gives me command history on issuing f12 */
  972. set pf12 retrieve 
  973. /* this continues */
  974. set pf8 imm b
  975. /* goes to trace set a */
  976. set pf1 imm tr goto a
  977. /* goes to trace set b */
  978. set pf2 imm tr goto b
  979. /* goes to trace set c */
  980. set pf3 imm tr goto c
  981. Instruction Tracing
  982. -------------------
  983. Setting a simple breakpoint
  984. TR I PSWA <address>
  985. To debug a particular function try
  986. TR I R <function address range>
  987. TR I on its own will single step.
  988. TR I DATA <MNEMONIC> <OPTIONAL RANGE> will trace for particular mnemonics
  989. e.g.
  990. TR I DATA 4D R 0197BC.4000
  991. will trace for BAS'es ( opcode 4D ) in the range 0197BC.4000
  992. if you were inclined you could add traces for all branch instructions &
  993. suffix them with the run prefix so you would have a backtrace on screen 
  994. when a program crashes.
  995. TR BR <INTO OR FROM> will trace branches into or out of an address.
  996. e.g.
  997. TR BR INTO 0 is often quite useful if a program is getting awkward & deciding
  998. to branch to 0 & crashing as this will stop at the address before in jumps to 0.
  999. TR I R <address range> RUN cmd d g
  1000. single steps a range of addresses but stays running &
  1001. displays the gprs on each step.
  1002. Displaying & modifying Registers
  1003. --------------------------------
  1004. D G will display all the gprs
  1005. Adding a extra G to all the commands is neccessary to access the full 64 bit 
  1006. content in VM on z/Architecture obviously this isn't required for access registers
  1007. as these are still 32 bit.
  1008. e.g. DGG instead of DG 
  1009. D X will display all the control registers
  1010. D AR will display all the access registers
  1011. D AR4-7 will display access registers 4 to 7
  1012. CPU ALL D G will display the GRPS of all CPUS in the configuration
  1013. D PSW will display the current PSW
  1014. st PSW 2000 will put the value 2000 into the PSW &
  1015. cause crash your machine.
  1016. D PREFIX displays the prefix offset
  1017. Displaying Memory
  1018. -----------------
  1019. To display memory mapped using the current PSW's mapping try
  1020. D <range>
  1021. To make VM display a message each time it hits a particular address & continue try
  1022. D I<range> will disassemble/display a range of instructions.
  1023. ST addr 32 bit word will store a 32 bit aligned address
  1024. D T<range> will display the EBCDIC in an address ( if you are that way inclined )
  1025. D R<range> will display real addresses ( without DAT ) but with prefixing.
  1026. There are other complex options to display if you need to get at say home space
  1027. but are in primary space the easiest thing to do is to temporarily
  1028. modify the PSW to the other addressing mode, display the stuff & then
  1029. restore it.
  1030.  
  1031. Hints
  1032. -----
  1033. If you want to issue a debugger command without halting your virtual machine with the
  1034. PA1 key try prefixing the command with #CP e.g.
  1035. #cp tr i pswa 2000
  1036. also suffixing most debugger commands with RUN will cause them not
  1037. to stop just display the mnemonic at the current instruction on the console.
  1038. If you have several breakpoints you want to put into your program &
  1039. you get fed up of cross referencing with System.map
  1040. you can do the following trick for several symbols.
  1041. grep do_signal System.map 
  1042. which emits the following among other things
  1043. 0001f4e0 T do_signal 
  1044. now you can do
  1045. TR I PSWA 0001f4e0 cmd msg * do_signal
  1046. This sends a message to your own console each time do_signal is entered.
  1047. ( As an aside I wrote a perl script once which automatically generated a REXX
  1048. script with breakpoints on every kernel procedure, this isn't a good idea
  1049. because there are thousands of these routines & VM can only set 255 breakpoints
  1050. at a time so you nearly had to spend as long pruning the file down as you would 
  1051. entering the msg's by hand ),however, the trick might be useful for a single object file.
  1052. On linux'es 3270 emulator x3270 there is a very useful option under the file ment
  1053. Save Screens In File this is very good of keeping a copy of traces. 
  1054. From CMS help <command name> will give you online help on a particular command. 
  1055. e.g. 
  1056. HELP DISPLAY
  1057. Also CP has a file called profile.exec which automatically gets called
  1058. on startup of CMS ( like autoexec.bat ), keeping on a DOS analogy session
  1059. CP has a feature similar to doskey, it may be useful for you to
  1060. use profile.exec to define some keystrokes. 
  1061. e.g.
  1062. SET PF9 IMM B
  1063. This does a single step in VM on pressing F8. 
  1064. SET PF10  ^
  1065. This sets up the ^ key.
  1066. which can be used for ^c (ctrl-c),^z (ctrl-z) which can't be typed directly into some 3270 consoles.
  1067. SET PF11 ^-
  1068. This types the starting keystrokes for a sysrq see SysRq below.
  1069. SET PF12 RETRIEVE
  1070. This retrieves command history on pressing F12.
  1071. Sometimes in VM the display is set up to scroll automatically this
  1072. can be very annoying if there are messages you wish to look at
  1073. to stop this do
  1074. TERM MORE 255 255
  1075. This will nearly stop automatic screen updates, however it will
  1076. cause a denial of service if lots of messages go to the 3270 console,
  1077. so it would be foolish to use this as the default on a production machine.
  1078.  
  1079. Tracing particular processes
  1080. ----------------------------
  1081. The kernels text segment is intentionally at an address in memory that it will
  1082. very seldom collide with text segments of user programs ( thanks Martin ),
  1083. this simplifies debugging the kernel.
  1084. However it is quite common for user processes to have addresses which collide
  1085. this can make debugging a particular process under VM painful under normal
  1086. circumstances as the process may change when doing a 
  1087. TR I R <address range>.
  1088. Thankfully after reading VM's online help I figured out how to debug
  1089. particular processes in 31 bit mode, however, according to the current 
  1090. VM online help documentation the method described below uses 
  1091. TR STO or STD which don't currently work on  z/Series while in 
  1092. 64-bit mode.
  1093. Your first problem is to find the STD ( segment table designation )
  1094. of the program you wish to debug.
  1095. There are several ways you can do this here are a few
  1096. 1) objdump --syms <program to be debugged> | grep main
  1097. To get the address of main in the program.
  1098. tr i pswa <address of main>
  1099. Start the program, if VM drops to CP on what looks like the entry
  1100. point of the main function this is most likely the process you wish to debug.
  1101. Now do a D X13 or D XG13 on z/Architecture.
  1102. On 31 bit the STD is bits 1-19 ( the STO segment table origin ) 
  1103. & 25-31 ( the STL segment table length ) of CR13.
  1104. now type
  1105. TR I R STD <CR13's value> 0.7fffffff
  1106. e.g.
  1107. TR I R STD 8F32E1FF 0.7fffffff
  1108. Another very useful variation is
  1109. TR STORE INTO STD <CR13's value> <address range>
  1110. for finding out when a particular variable changes.
  1111. An alternative way of finding the STD of a currently running process 
  1112. is to do the following, ( this method is more complex but
  1113. could be quite convient if you aren't updating the kernel much &
  1114. so your kernel structures will stay constant for a reasonable period of
  1115. time ).
  1116. grep task /proc/<pid>/status
  1117. from this you should see something like
  1118. task: 0f160000 ksp: 0f161de8 pt_regs: 0f161f68
  1119. This now gives you a pointer to the task structure.
  1120. Now make CC:="s390-gcc -g" kernel/sched.s
  1121. To get the task_struct stabinfo.
  1122. ( task_struct is defined in include/linux/sched.h ).
  1123. Now we want to look at
  1124. task->active_mm->pgd
  1125. on my machine the active_mm in the task structure stab is
  1126. active_mm:(4,12),672,32
  1127. its offset is 672/8=84=0x54
  1128. the pgd member in the mm_struct stab is
  1129. pgd:(4,6)=*(29,5),96,32
  1130. so its offset is 96/8=12=0xc
  1131. so we'll
  1132. hexdump -s 0xf160054 /dev/mem | more
  1133. i.e. task_struct+active_mm offset
  1134. to look at the active_mm member
  1135. f160054 0fee cc60 0019 e334 0000 0000 0000 0011
  1136. hexdump -s 0x0feecc6c /dev/mem | more
  1137. i.e. active_mm+pgd offset
  1138. feecc6c 0f2c 0000 0000 0001 0000 0001 0000 0010
  1139. we get something like
  1140. now do 
  1141. TR I R STD <pgd|0x7f> 0.7fffffff
  1142. i.e. the 0x7f is added because the pgd only
  1143. gives the page table origin & we need to set the low bits
  1144. to the maximum possible segment table length.
  1145. TR I R STD 0f2c007f 0.7fffffff
  1146. on z/Architecture you'll probably need to do
  1147. TR I R STD <pgd|0x7> 0.ffffffffffffffff
  1148. to set the TableType to 0x1 & the Table length to 3.
  1149. Tracing Program Exceptions
  1150. --------------------------
  1151. If you get a crash which says something like
  1152. illegal operation or specification exception followed by a register dump
  1153. You can restart linux & trace these using the tr prog <range or value> trace option.
  1154. The most common ones you will normally be tracing for is
  1155. 1=operation exception
  1156. 2=privileged operation exception
  1157. 4=protection exception
  1158. 5=addressing exception
  1159. 6=specification exception
  1160. 10=segment translation exception
  1161. 11=page translation exception
  1162. The full list of these is on page 22 of the current s/390 Reference Summary.
  1163. e.g.
  1164. tr prog 10 will trace segment translation exceptions.
  1165. tr prog on its own will trace all program interruption codes.
  1166. Trace Sets
  1167. ----------
  1168. On starting VM you are initially in the INITIAL trace set.
  1169. You can do a Q TR to verify this.
  1170. If you have a complex tracing situation where you wish to wait for instance 
  1171. till a driver is open before you start tracing IO, but know in your
  1172. heart that you are going to have to make several runs through the code till you
  1173. have a clue whats going on. 
  1174. What you can do is
  1175. TR I PSWA <Driver open address>
  1176. hit b to continue till breakpoint
  1177. reach the breakpoint
  1178. now do your
  1179. TR GOTO B 
  1180. TR IO 7c08-7c09 inst int run 
  1181. or whatever the IO channels you wish to trace are & hit b
  1182. To got back to the initial trace set do
  1183. TR GOTO INITIAL
  1184. & the TR I PSWA <Driver open address> will be the only active breakpoint again.
  1185. Tracing linux syscalls under VM
  1186. -------------------------------
  1187. Syscalls are implemented on Linux for S390 by the Supervisor call instruction (SVC) there 256 
  1188. possibilities of these as the instruction is made up of a  0xA opcode & the second byte being
  1189. the syscall number. They are traced using the simple command.
  1190. TR SVC  <Optional value or range>
  1191. the syscalls are defined in linux/include/asm-s390/unistd.h
  1192. e.g. to trace all file opens just do
  1193. TR SVC 5 ( as this is the syscall number of open )
  1194. SMP Specific commands
  1195. ---------------------
  1196. To find out how many cpus you have
  1197. Q CPUS displays all the CPU's available to your virtual machine
  1198. To find the cpu that the current cpu VM debugger commands are being directed at do
  1199. Q CPU to change the current cpu cpu VM debugger commands are being directed at do
  1200. CPU <desired cpu no>
  1201. On a SMP guest issue a command to all CPUs try prefixing the command with cpu all.
  1202. To issue a command to a particular cpu try cpu <cpu number> e.g.
  1203. CPU 01 TR I R 2000.3000
  1204. If you are running on a guest with several cpus & you have a IO related problem
  1205. & cannot follow the flow of code but you know it isnt smp related.
  1206. from the bash prompt issue
  1207. shutdown -h now or halt.
  1208. do a Q CPUS to find out how many cpus you have
  1209. detach each one of them from cp except cpu 0 
  1210. by issueing a 
  1211. DETACH CPU 01-(number of cpus in configuration)
  1212. & boot linux again.
  1213. TR SIGP will trace inter processor signal processor instructions.
  1214. DEFINE CPU 01-(number in configuration) 
  1215. will get your guests cpus back.
  1216. Help for displaying ascii textstrings
  1217. -------------------------------------
  1218. On the very latest VM Nucleus'es VM can now display ascii
  1219. ( thanks Neale for the hint ) by doing
  1220. D TX<lowaddr>.<len>
  1221. e.g.
  1222. D TX0.100
  1223. Alternatively
  1224. =============
  1225. Under older VM debuggers ( I love EBDIC too ) you can use this little program I wrote which
  1226. will convert a command line of hex digits to ascii text which can be compiled under linux & 
  1227. you can copy the hex digits from your x3270 terminal to your xterm if you are debugging
  1228. from a linuxbox.
  1229. This is quite useful when looking at a parameter passed in as a text string
  1230. under VM ( unless you are good at decoding ASCII in your head ).
  1231. e.g. consider tracing an open syscall
  1232. TR SVC 5
  1233. We have stopped at a breakpoint
  1234. 000151B0' SVC   0A05     -> 0001909A'   CC 0
  1235. D 20.8 to check the SVC old psw in the prefix area & see was it from userspace
  1236. ( for the layout of the prefix area consult P18 of the s/390 390 Reference Summary 
  1237. if you have it available ).
  1238. V00000020  070C2000 800151B2
  1239. The problem state bit wasn't set &  it's also too early in the boot sequence
  1240. for it to be a userspace SVC if it was we would have to temporarily switch the 
  1241. psw to user space addressing so we could get at the first parameter of the open in
  1242. gpr2.
  1243. Next do a 
  1244. D G2
  1245. GPR  2 =  00014CB4
  1246. Now display what gpr2 is pointing to
  1247. D 00014CB4.20
  1248. V00014CB4  2F646576 2F636F6E 736F6C65 00001BF5
  1249. V00014CC4  FC00014C B4001001 E0001000 B8070707
  1250. Now copy the text till the first 00 hex ( which is the end of the string
  1251. to an xterm & do hex2ascii on it.
  1252. hex2ascii 2F646576 2F636F6E 736F6C65 00 
  1253. outputs
  1254. Decoded Hex:=/ d e v / c o n s o l e 0x00 
  1255. We were opening the console device,
  1256. You can compile the code below yourself for practice :-),
  1257. /*
  1258.  *    hex2ascii.c
  1259.  *    a useful little tool for converting a hexadecimal command line to ascii
  1260.  *
  1261.  *    Author(s): Denis Joseph Barrow (djbarrow@de.ibm.com,barrow_dj@yahoo.com)
  1262.  *    (C) 2000 IBM Deutschland Entwicklung GmbH, IBM Corporation.
  1263.  */   
  1264. #include <stdio.h>
  1265. int main(int argc,char *argv[])
  1266. {
  1267.   int cnt1,cnt2,len,toggle=0;
  1268.   int startcnt=1;
  1269.   unsigned char c,hex;
  1270.   
  1271.   if(argc>1&&(strcmp(argv[1],"-a")==0))
  1272.      startcnt=2;
  1273.   printf("Decoded Hex:=");
  1274.   for(cnt1=startcnt;cnt1<argc;cnt1++)
  1275.   {
  1276.     len=strlen(argv[cnt1]);
  1277.     for(cnt2=0;cnt2<len;cnt2++)
  1278.     {
  1279.        c=argv[cnt1][cnt2];
  1280.        if(c>='0'&&c<='9')
  1281.   c=c-'0';
  1282.        if(c>='A'&&c<='F')
  1283.   c=c-'A'+10;
  1284.        if(c>='a'&&c<='F')
  1285.   c=c-'a'+10;
  1286.        switch(toggle)
  1287.        {
  1288.   case 0:
  1289.      hex=c<<4;
  1290.      toggle=1;
  1291.   break;
  1292.   case 1:
  1293.      hex+=c;
  1294.      if(hex<32||hex>127)
  1295.      {
  1296. if(startcnt==1)
  1297.    printf("0x%02X ",(int)hex);
  1298. else
  1299.    printf(".");
  1300.      }
  1301.      else
  1302.      {
  1303.        printf("%c",hex);
  1304.        if(startcnt==1)
  1305.   printf(" ");
  1306.      }
  1307.      toggle=0;
  1308.   break;
  1309.        }
  1310.     }
  1311.   }
  1312.   printf("n");
  1313. }
  1314. Stack tracing under VM
  1315. ----------------------
  1316. A basic backtrace
  1317. -----------------
  1318. Here are the tricks I use 9 out of 10 times it works pretty well,
  1319. When your backchain reaches a dead end
  1320. --------------------------------------
  1321. This can happen when an exception happens in the kernel & the kernel is entered twice
  1322. if you reach the NULL pointer at the end of the back chain you should be
  1323. able to sniff further back if you follow the following tricks.
  1324. 1) A kernel address should be easy to recognise since it is in
  1325. primary space & the problem state bit isn't set & also
  1326. The Hi bit of the address is set.
  1327. 2) Another backchain should also be easy to recognise since it is an 
  1328. address pointing to another address approximately 100 bytes or 0x70 hex
  1329. behind the current stackpointer.
  1330. Here is some practice.
  1331. boot the kernel & hit PA1 at some random time
  1332. d g to display the gprs, this should display something like
  1333. GPR  0 =  00000001  00156018  0014359C  00000000
  1334. GPR  4 =  00000001  001B8888  000003E0  00000000
  1335. GPR  8 =  00100080  00100084  00000000  000FE000
  1336. GPR 12 =  00010400  8001B2DC  8001B36A  000FFED8
  1337. Note that GPR14 is a return address but as we are real men we are going to
  1338. trace the stack.
  1339. display 0x40 bytes after the stack pointer.
  1340. V000FFED8  000FFF38 8001B838 80014C8E 000FFF38
  1341. V000FFEE8  00000000 00000000 000003E0 00000000
  1342. V000FFEF8  00100080 00100084 00000000 000FE000
  1343. V000FFF08  00010400 8001B2DC 8001B36A 000FFED8
  1344. Ah now look at whats in sp+56 (sp+0x38) this is 8001B36A our saved r14 if
  1345. you look above at our stackframe & also agrees with GPR14.
  1346. now backchain 
  1347. d 000FFF38.40
  1348. we now are taking the contents of SP to get our first backchain.
  1349. V000FFF38  000FFFA0 00000000 00014995 00147094
  1350. V000FFF48  00147090 001470A0 000003E0 00000000
  1351. V000FFF58  00100080 00100084 00000000 001BF1D0
  1352. V000FFF68  00010400 800149BA 80014CA6 000FFF38
  1353. This displays a 2nd return address of 80014CA6
  1354. now do d 000FFFA0.40 for our 3rd backchain
  1355. V000FFFA0  04B52002 0001107F 00000000 00000000
  1356. V000FFFB0  00000000 00000000 FF000000 0001107F
  1357. V000FFFC0  00000000 00000000 00000000 00000000
  1358. V000FFFD0  00010400 80010802 8001085A 000FFFA0
  1359. our 3rd return address is 8001085A
  1360. as the 04B52002 looks suspiciously like rubbish it is fair to assume that the kernel entry routines
  1361. for the sake of optimisation dont set up a backchain.
  1362. now look at System.map to see if the addresses make any sense.
  1363. grep -i 0001b3 System.map
  1364. outputs among other things
  1365. 0001b304 T cpu_idle 
  1366. so 8001B36A
  1367. is cpu_idle+0x66 ( quiet the cpu is asleep, don't wake it )
  1368. grep -i 00014 System.map 
  1369. produces among other things
  1370. 00014a78 T start_kernel  
  1371. so 0014CA6 is start_kernel+some hex number I can't add in my head.
  1372. grep -i 00108 System.map 
  1373. this produces
  1374. 00010800 T _stext
  1375. so   8001085A is _stext+0x5a
  1376. Congrats you've done your first backchain.
  1377. s/390 & z/Architecture IO Overview
  1378. ==================================
  1379. I am not going to give a course in 390 IO architecture as this would take me quite a
  1380. while & I'm no expert. Instead I'll give a 390 IO architecture summary for Dummies if you have 
  1381. the s/390 principles of operation available read this instead. If nothing else you may find a few 
  1382. useful keywords in here & be able to use them on a web search engine like altavista to find 
  1383. more useful information.
  1384. Unlike other bus architectures modern 390 systems do their IO using mostly
  1385. fibre optics & devices such as tapes & disks can be shared between several mainframes,
  1386. also S390 can support upto 65536 devices while a high end PC based system might be choking 
  1387. with around 64. Here is some of the common IO terminology
  1388. Subchannel:
  1389. This is the logical number most IO commands use to talk to an IO device there can be upto
  1390. 0x10000 (65536) of these in a configuration typically there is a few hundred. Under VM
  1391. for simplicity they are allocated contiguously, however on the native hardware they are not
  1392. they typically stay consistent between boots provided no new hardware is inserted or removed.
  1393. Under Linux for 390 we use these as IRQ's & also when issuing an IO command (CLEAR SUBCHANNEL,
  1394. HALT SUBCHANNEL,MODIFY SUBCHANNEL,RESUME SUBCHANNEL,START SUBCHANNEL,STORE SUBCHANNEL & 
  1395. TEST SUBCHANNEL ) we use this as the ID of the device we wish to talk to, the most
  1396. important of these instructions are START SUBCHANNEL ( to start IO ), TEST SUBCHANNEL ( to check
  1397. whether the IO completed successfully ), & HALT SUBCHANNEL ( to kill IO ), a subchannel
  1398. can have up to 8 channel paths to a device this offers redunancy if one is not available.
  1399. Device Number:
  1400. This number remains static & Is closely tied to the hardware, there are 65536 of these
  1401. also they are made up of a CHPID ( Channel Path ID, the most significant 8 bits ) 
  1402. & another lsb 8 bits. These remain static even if more devices are inserted or removed
  1403. from the hardware, there is a 1 to 1 mapping between Subchannels & Device Numbers provided
  1404. devices arent inserted or removed.
  1405. Channel Control Words:
  1406. CCWS are linked lists of instructions initially pointed to by an operation request block (ORB),
  1407. which is initially given to Start Subchannel (SSCH) command along with the subchannel number
  1408. for the IO subsystem to process while the CPU continues executing normal code.
  1409. These come in two flavours, Format 0 ( 24 bit for backward )
  1410. compatibility & Format 1 ( 31 bit ). These are typically used to issue read & write 
  1411. ( & many other instructions ) they consist of a length field & an absolute address field.
  1412. For each IO typically get 1 or 2 interrupts one for channel end ( primary status ) when the
  1413. channel is idle & the second for device end ( secondary status ) sometimes you get both
  1414. concurrently, you check how the IO went on by issueing a TEST SUBCHANNEL at each interrupt,
  1415. from which you receive an Interruption response block (IRB). If you get channel & device end 
  1416. status in the IRB without channel checks etc. your IO probably went okay. If you didn't you
  1417. probably need a doctorto examine the IRB & extended status word etc.
  1418. If an error occurs more sophistocated control units have a facitity known as
  1419. concurrent sense this means that if an error occurs Extended sense information will
  1420. be presented in the Extended status word in the IRB if not you have to issue a
  1421. subsequent SENSE CCW command after the test subchannel. 
  1422. TPI( Test pending interrupt) can also be used for polled IO but in multitasking multiprocessor
  1423. systems it isn't recommended except for checking special cases ( i.e. non looping checks for
  1424. pending IO etc. ).
  1425. Store Subchannel & Modify Subchannel can be used to examine & modify operating characteristics
  1426. of a subchannel ( e.g. channel paths ).
  1427. Other IO related Terms:
  1428. Sysplex: S390's Clustering Technology
  1429. QDIO: S390's new high speed IO architecture to support devices such as gigabit ethernet,
  1430. this architecture is also designed to be forward compatible with up & coming 64 bit machines.
  1431. General Concepts 
  1432. Input Output Processors (IOP's) are responsible for communicating between
  1433. the mainframe CPU's & the channel & relieve the mainframe CPU's from the
  1434. burden of communicating with IO devices directly, this allows the CPU's to 
  1435. concentrate on data processing. 
  1436. IOP's can use one or more links ( known as channel paths ) to talk to each 
  1437. IO device. It first checks for path availability & chooses an available one,
  1438. then starts ( & sometimes terminates IO ).
  1439. There are two types of channel path ESCON & the Paralell IO interface.
  1440. IO devices are attached to control units, control units provide the
  1441. logic to interface the channel paths & channel path IO protocols to 
  1442. the IO devices, they can be integrated with the devices or housed separately
  1443. & often talk to several similar devices ( typical examples would be raid 
  1444. controllers or a control unit which connects to 1000 3270 terminals ).
  1445.     +---------------------------------------------------------------+
  1446.     | +-----+ +-----+ +-----+ +-----+  +----------+  +----------+   |
  1447.     | | CPU | | CPU | | CPU | | CPU |  |  Main    |  | Expanded |   |
  1448.     | |     | |     | |     | |     |  |  Memory  |  |  Storage |   |
  1449.     | +-----+ +-----+ +-----+ +-----+  +----------+  +----------+   | 
  1450.     |---------------------------------------------------------------+
  1451.     |   IOP        |      IOP      |       IOP                      |
  1452.     |---------------------------------------------------------------
  1453.     | C | C | C | C | C | C | C | C | C | C | C | C | C | C | C | C | 
  1454.     ----------------------------------------------------------------
  1455.          ||                                              ||
  1456.          ||  Bus & Tag Channel Path                      || ESCON
  1457.          ||  ======================                      || Channel
  1458.          ||  ||                  ||                      || Path
  1459.     +----------+               +----------+         +----------+
  1460.     |          |               |          |         |          |
  1461.     |    CU    |               |    CU    |         |    CU    |
  1462.     |          |               |          |         |          |
  1463.     +----------+               +----------+         +----------+
  1464.        |      |                     |                |       |
  1465. +----------+ +----------+      +----------+   +----------+ +----------+
  1466. |I/O Device| |I/O Device|      |I/O Device|   |I/O Device| |I/O Device|
  1467. +----------+ +----------+      +----------+   +----------+ +----------+
  1468.   CPU = Central Processing Unit    
  1469.   C = Channel                      
  1470.   IOP = IP Processor               
  1471.   CU = Control Unit
  1472. The 390 IO systems come in 2 flavours the current 390 machines support both
  1473. The Older 360 & 370 Interface,sometimes called the paralell I/O interface,
  1474. sometimes called Bus-and Tag & sometimes Original Equipment Manufacturers
  1475. Interface (OEMI).
  1476. This byte wide paralell channel path/bus has parity & data on the "Bus" cable 
  1477. & control lines on the "Tag" cable. These can operate in byte multiplex mode for
  1478. sharing between several slow devices or burst mode & monopolize the channel for the
  1479. whole burst. Upto 256 devices can be addressed  on one of these cables. These cables are
  1480. about one inch in diameter. The maximum unextended length supported by these cables is
  1481. 125 Meters but this can be extended up to 2km with a fibre optic channel extended 
  1482. such as a 3044. The maximum burst speed supported is 4.5 megabytes per second however
  1483. some really old processors support only transfer rates of 3.0, 2.0 & 1.0 MB/sec.
  1484. One of these paths can be daisy chained to up to 8 control units.
  1485. ESCON if fibre optic it is also called FICON 
  1486. Was introduced by IBM in 1990. Has 2 fibre optic cables & uses either leds or lasers
  1487. for communication at a signaling rate of upto 200 megabits/sec. As 10bits are transferred
  1488. for every 8 bits info this drops to 160 megabits/sec & to 18.6 Megabytes/sec once
  1489. control info & CRC are added. ESCON only operates in burst mode.
  1490.  
  1491. ESCONs typical max cable length is 3km for the led version & 20km for the laser version
  1492. known as XDF ( extended distance facility ). This can be further extended by using an
  1493. ESCON director which triples the above mentioned ranges. Unlike Bus & Tag as ESCON is
  1494. serial it uses a packet switching architecture the standard Bus & Tag control protocol
  1495. is however present within the packets. Upto 256 devices can be attached to each control 
  1496. unit that uses one of these interfaces.
  1497. Common 390 Devices include:
  1498. Network adapters typically OSA2,3172's,2116's & OSA-E gigabit ethernet adapters,
  1499. Consoles 3270 & 3215 ( a teletype emulated under linux for a line mode console ).
  1500. DASD's direct access storage devices ( otherwise known as hard disks ).
  1501. Tape Drives.
  1502. CTC ( Channel to Channel Adapters ),
  1503. ESCON or Paralell Cables used as a very high speed serial link
  1504. between 2 machines. We use 2 cables under linux to do a bi-directional serial link.
  1505. Debugging IO on s/390 & z/Architecture under VM
  1506. ===============================================
  1507. Now we are ready to go on with IO tracing commands under VM
  1508. A few self explanatory queries:
  1509. Q OSA
  1510. Q CTC
  1511. Q DISK ( This command is CMS specific )
  1512. Q DASD
  1513. Q OSA on my machine returns
  1514. OSA  7C08 ON OSA   7C08 SUBCHANNEL = 0000
  1515. OSA  7C09 ON OSA   7C09 SUBCHANNEL = 0001
  1516. OSA  7C14 ON OSA   7C14 SUBCHANNEL = 0002
  1517. OSA  7C15 ON OSA   7C15 SUBCHANNEL = 0003
  1518. If you have a guest with certain priviliges you may be able to see devices
  1519. which don't belong to you to avoid this do add the option V.
  1520. e.g.
  1521. Q V OSA
  1522. Now using the device numbers returned by this command we will
  1523. Trace the io starting up on the first device 7c08 & 7c09
  1524. In our simplest case we can trace the 
  1525. start subchannels
  1526. like TR SSCH 7C08-7C09
  1527. or the halt subchannels
  1528. or TR HSCH 7C08-7C09
  1529. MSCH's ,STSCH's I think you can guess the rest
  1530. Ingo's favourite trick is tracing all the IO's & CCWS & spooling them into the reader of another
  1531. VM guest so he can ftp the logfile back to his own machine.I'll do a small bit of this & give you
  1532.  a look at the output.
  1533. 1) Spool stdout to VM reader
  1534. SP PRT TO (another vm guest ) or * for the local vm guest
  1535. 2) Fill the reader with the trace
  1536. TR IO 7c08-7c09 INST INT CCW PRT RUN
  1537. 3) Start up linux 
  1538. i 00c  
  1539. 4) Finish the trace
  1540. TR END
  1541. 5) close the reader
  1542. C PRT
  1543. 6) list reader contents
  1544. RDRLIST
  1545. 7) copy it to linux4's minidisk 
  1546. RECEIVE / LOG TXT A1 ( replace
  1547. 8)
  1548. filel & press F11 to look at it
  1549. You should see someting like.
  1550. 00020942' SSCH  B2334000    0048813C    CC 0    SCH 0000    DEV 7C08
  1551.           CPA 000FFDF0   PARM 00E2C9C4    KEY 0  FPI C0  LPM 80
  1552.           CCW    000FFDF0  E4200100 00487FE8   0000  E4240100 ........
  1553.           IDAL                                      43D8AFE8
  1554.           IDAL                                      0FB76000
  1555. 00020B0A'   I/O DEV 7C08 -> 000197BC'   SCH 0000   PARM 00E2C9C4
  1556. 00021628' TSCH  B2354000 >> 00488164    CC 0    SCH 0000    DEV 7C08
  1557.           CCWA 000FFDF8   DEV STS 0C  SCH STS 00  CNT 00EC
  1558.            KEY 0   FPI C0  CC 0   CTLS 4007
  1559. 00022238' STSCH B2344000 >> 00488108    CC 0    SCH 0000    DEV 7C08
  1560. If you don't like messing up your readed ( because you possibly booted from it )
  1561. you can alternatively spool it to another readers guest.
  1562. Other common VM device related commands
  1563. ---------------------------------------------
  1564. These commands are listed only because they have
  1565. been of use to me in the past & may be of use to
  1566. you too. For more complete info on each of the commands
  1567. use type HELP <command> from CMS.
  1568. detaching devices
  1569. DET <devno range>
  1570. ATT <devno range> <guest> 
  1571. attach a device to guest * for your own guest
  1572. READY <devno> cause VM to issue a fake interrupt.
  1573. The VARY command is normally only available to VM administrators.
  1574. VARY ON PATH <path> TO <devno range>
  1575. VARY OFF PATH <PATH> FROM <devno range>
  1576. This is used to switch on or off channel paths to devices.
  1577. Q CHPID <channel path ID>
  1578. This displays state of devices using this channel path
  1579. D SCHIB <subchannel>
  1580. This displays the subchannel information SCHIB block for the device.
  1581. this I believe is also only available to administrators.
  1582. DEFINE CTC <devno>
  1583. defines a virtual CTC channel to channel connection
  1584. 2 need to be defined on each guest for the CTC driver to use.
  1585. COUPLE  devno userid remote devno
  1586. Joins a local virtual device to a remote virtual device
  1587. ( commonly used for the CTC driver ).
  1588. Building a VM ramdisk under CMS which linux can use
  1589. def vfb-<blocksize> <subchannel> <number blocks>
  1590. blocksize is commonly 4096 for linux.
  1591. Formatting it
  1592. format <subchannel> <driver letter e.g. x> (blksize <blocksize>
  1593. Sharing a disk between multiple guests
  1594. LINK userid devno1 devno2 mode password
  1595. GDB on S390
  1596. ===========
  1597. N.B. if compiling for debugging gdb works better without optimisation 
  1598. ( see Compiling programs for debugging )
  1599. invocation
  1600. ----------
  1601. gdb <victim program> <optional corefile>
  1602. Online help
  1603. -----------
  1604. help: gives help on commands
  1605. e.g.
  1606. help
  1607. help display
  1608. Note gdb's online help is very good use it.
  1609. Assembly
  1610. --------
  1611. info registers: displays registers other than floating point.
  1612. info all-registers: displays floating points as well.
  1613. disassemble: dissassembles
  1614. e.g.
  1615. disassemble without parameters will disassemble the current function
  1616. disassemble $pc $pc+10 
  1617. Viewing & modifying variables
  1618. -----------------------------
  1619. print or p: displays variable or register
  1620. e.g. p/x $sp will display the stack pointer
  1621. display: prints variable or register each time program stops
  1622. e.g.
  1623. display/x $pc will display the program counter
  1624. display argc
  1625. undisplay : undo's display's
  1626. info breakpoints: shows all current breakpoints
  1627. info stack: shows stack back trace ( if this dosent work too well, I'll show you the
  1628. stacktrace by hand below ).
  1629. info locals: displays local variables.
  1630. info args: display current procedure arguments.
  1631. set args: will set argc & argv each time the victim program is invoked.
  1632. set <variable>=value
  1633. set argc=100
  1634. set $pc=0
  1635. Modifying execution
  1636. -------------------
  1637. step: steps n lines of sourcecode
  1638. step steps 1 line.
  1639. step 100 steps 100 lines of code.
  1640. next: like step except this will not step into subroutines
  1641. stepi: steps a single machine code instruction.
  1642. e.g. stepi 100
  1643. nexti: steps a single machine code instruction but will not step into subroutines.
  1644. finish: will run until exit of the current routine
  1645. run: (re)starts a program
  1646. cont: continues a program
  1647. quit: exits gdb.
  1648. breakpoints
  1649. ------------
  1650. break
  1651. sets a breakpoint
  1652. e.g.
  1653. break main
  1654. break *$pc
  1655. break *0x400618
  1656. heres a really useful one for large programs
  1657. rbr
  1658. Set a breakpoint for all functions matching REGEXP
  1659. e.g.
  1660. rbr 390
  1661. will set a breakpoint with all functions with 390 in their name.
  1662. info breakpoints
  1663. lists all breakpoints
  1664. delete: delete breakpoint by number or delete them all
  1665. e.g.
  1666. delete 1 will delete the first breakpoint
  1667. delete will delete them all
  1668. watch: This will set a watchpoint ( usually hardware assisted ),
  1669. This will watch a variable till it changes
  1670. e.g.
  1671. watch cnt, will watch the variable cnt till it changes.
  1672. As an aside unfortunately gdb's, architecture independent watchpoint code
  1673. is inconsistent & not very good, watchpoints usually work but not always.
  1674. info watchpoints: Display currently active watchpoints
  1675. condition: ( another useful one )
  1676. Specify breakpoint number N to break only if COND is true.
  1677. Usage is `condition N COND', where N is an integer and COND is an
  1678. expression to be evaluated whenever breakpoint N is reached.
  1679. User defined functions/macros
  1680. -----------------------------
  1681. define: ( Note this is very very useful,simple & powerful )
  1682. usage define <name> <list of commands> end
  1683. examples which you should consider putting into .gdbinit in your home directory
  1684. define d
  1685. stepi
  1686. disassemble $pc $pc+10
  1687. end
  1688. define e
  1689. nexti
  1690. disassemble $pc $pc+10
  1691. end
  1692. Other hard to classify stuff
  1693. ----------------------------
  1694. signal n:
  1695. sends the victim program a signal.
  1696. e.g. signal 3 will send a SIGQUIT.
  1697. info signals:
  1698. what gdb does when the victim receives certain signals.
  1699. list:
  1700. e.g.
  1701. list lists current function source
  1702. list 1,10 list first 10 lines of curret file.
  1703. list test.c:1,10
  1704. directory:
  1705. Adds directories to be searched for source if gdb cannot find the source.
  1706. (note it is a bit sensititive about slashes ) 
  1707. e.g. To add the root of the filesystem to the searchpath do
  1708. directory //
  1709. call <function>
  1710. This calls a function in the victim program, this is pretty powerful
  1711. e.g.
  1712. (gdb) call printf("hello world")
  1713. outputs:
  1714. $1 = 11 
  1715. You might now be thinking that the line above didn't work, something extra had to be done.
  1716. (gdb) call fflush(stdout)
  1717. hello world$2 = 0
  1718. As an aside the debugger also calls malloc & free under the hood 
  1719. to make space for the "hello world" string.
  1720. hints
  1721. -----
  1722. 1) command completion works just like bash 
  1723. ( if you are a bad typist like me this really helps )
  1724. e.g. hit br <TAB> & cursor up & down :-).
  1725. 2) if you have a debugging problem that takes a few steps to recreate
  1726. put the steps into a file called .gdbinit in your current working directory
  1727. if you have defined a few extra useful user defined commands put these in 
  1728. your home directory & they will be read each time gdb is launched.
  1729. A typical .gdbinit file might be.
  1730. break main
  1731. run
  1732. break runtime_exception
  1733. cont 
  1734. stack chaining in gdb by hand
  1735. -----------------------------
  1736. This is done using a the same trick described for VM 
  1737. p/x (*($sp+56))&0x7fffffff get the first backchain.
  1738. For z/Architecture
  1739. Replace 56 with 112 & ignore the &0x7fffffff
  1740. in the macros below & do nasty casts to longs like the following
  1741. as gdb unfortunately deals with printed arguments as ints which
  1742. messes up everything.
  1743. i.e. here is a 3rd backchain dereference
  1744. p/x *(long *)(***(long ***)$sp+112)
  1745. this outputs 
  1746. $5 = 0x528f18 
  1747. on my machine.
  1748. Now you can use 
  1749. info symbol (*($sp+56))&0x7fffffff 
  1750. you might see something like.
  1751. rl_getc + 36 in section .text  telling you what is located at address 0x528f18
  1752. Now do.
  1753. p/x (*(*$sp+56))&0x7fffffff 
  1754. This outputs
  1755. $6 = 0x528ed0
  1756. Now do.
  1757. info symbol (*(*$sp+56))&0x7fffffff
  1758. rl_read_key + 180 in section .text
  1759. now do
  1760. p/x (*(**$sp+56))&0x7fffffff
  1761. & so on.
  1762. Another good trick to look at addresses on the stack if you've somehow lost 
  1763. the backchain is.
  1764. x/500xa $sp
  1765. This displays anything the name of any known functions above the stack pointer
  1766. for 500 bytes.
  1767. Disassembling instructions without debug info
  1768. ---------------------------------------------
  1769. gdb typically compains if there is a lack of debugging
  1770. symbols in  the disassemble command with 
  1771. "No function contains specified address." to get around
  1772. this do 
  1773. x/<number lines to disassemble>xi <address>
  1774. e.g.
  1775. x/20xi 0x400730
  1776. Note: Remember gdb has history just like bash you don't need to retype the
  1777. whole line just use the up & down arrows.
  1778. For more info
  1779. -------------
  1780. From your linuxbox do 
  1781. man gdb or info gdb.
  1782. core dumps
  1783. ----------
  1784. What a core dump ?,
  1785. A core dump is a file generated by the kernel ( if allowed ) which contains the registers,
  1786. & all active pages of the program which has crashed.
  1787. From this file gdb will allow you to look at the registers & stack trace & memory of the
  1788. program as if it just crashed on your system, it is usually called core & created in the
  1789. current working directory.
  1790. This is very useful in that a customer can mail a core dump to a technical support department
  1791. & the technical support department can reconstruct what happened.
  1792. Provided the have an indentical copy of this program with debugging symbols compiled in & 
  1793. the source base of this build is available.
  1794. In short it is far more useful than something like a crash log could ever hope to be.
  1795. In theory all that is missing to restart a core dumped program is a kernel patch which
  1796. will do the following.
  1797. 1) Make a new kernel task structure
  1798. 2) Reload all the dumped pages back into the kernels memory managment structures.
  1799. 3) Do the required clock fixups
  1800. 4) Get all files & network connections for the process back into an identical state ( really difficult ).
  1801. 5) A few more difficult things I haven't thought of.
  1802. Why have I never seen one ?.
  1803. Probably because you haven't used the command 
  1804. ulimit -c unlimited in bash
  1805. to allow core dumps, now do 
  1806. ulimit -a 
  1807. to verify that the limit was accepted.
  1808. A sample core dump
  1809. To create this I'm going to do
  1810. ulimit -c unlimited
  1811. gdb 
  1812. to launch gdb (my victim app. ) now be bad & do the following from another 
  1813. telnet/xterm session to the same machine
  1814. ps -aux | grep gdb
  1815. kill -SIGSEGV <gdb's pid>
  1816. or alternatively use killall -SIGSEGV gdb if you have the killall command.
  1817. Now look at the core dump.
  1818. ./gdb ./gdb core
  1819. Displays the following
  1820. GNU gdb 4.18
  1821. Copyright 1998 Free Software Foundation, Inc.
  1822. GDB is free software, covered by the GNU General Public License, and you are
  1823. welcome to change it and/or distribute copies of it under certain conditions.
  1824. Type "show copying" to see the conditions.
  1825. There is absolutely no warranty for GDB.  Type "show warranty" for details.
  1826. This GDB was configured as "s390-ibm-linux"...
  1827. Core was generated by `./gdb'.
  1828. Program terminated with signal 11, Segmentation fault.
  1829. Reading symbols from /usr/lib/libncurses.so.4...done.
  1830. Reading symbols from /lib/libm.so.6...done.
  1831. Reading symbols from /lib/libc.so.6...done.
  1832. Reading symbols from /lib/ld-linux.so.2...done.
  1833. #0  0x40126d1a in read () from /lib/libc.so.6
  1834. Setting up the environment for debugging gdb.
  1835. Breakpoint 1 at 0x4dc6f8: file utils.c, line 471.
  1836. Breakpoint 2 at 0x4d87a4: file top.c, line 2609.
  1837. (top-gdb) info stack
  1838. #0  0x40126d1a in read () from /lib/libc.so.6
  1839. #1  0x528f26 in rl_getc (stream=0x7ffffde8) at input.c:402
  1840. #2  0x528ed0 in rl_read_key () at input.c:381
  1841. #3  0x5167e6 in readline_internal_char () at readline.c:454
  1842. #4  0x5168ee in readline_internal_charloop () at readline.c:507
  1843. #5  0x51692c in readline_internal () at readline.c:521
  1844. #6  0x5164fe in readline (prompt=0x7ffff810 "177