From patchwork Wed Apr 15 19:47:33 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Marchi X-Patchwork-Id: 6238 Received: (qmail 52878 invoked by alias); 15 Apr 2015 19:47:53 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 52823 invoked by uid 89); 15 Apr 2015 19:47:52 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=AWL, BAYES_00, SPF_PASS autolearn=ham version=3.3.2 X-HELO: usevmg21.ericsson.net Received: from usevmg21.ericsson.net (HELO usevmg21.ericsson.net) (198.24.6.65) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Wed, 15 Apr 2015 19:47:51 +0000 Received: from EUSAAHC001.ericsson.se (Unknown_Domain [147.117.188.75]) by usevmg21.ericsson.net (Symantec Mail Security) with SMTP id B5.E5.17241.A5D5E255; Wed, 15 Apr 2015 14:45:15 +0200 (CEST) Received: from elxcz23q12-y4.mo.ca.am.ericsson.se (147.117.188.8) by smtps-am.internal.ericsson.com (147.117.188.75) with Microsoft SMTP Server (TLS) id 14.3.210.2; Wed, 15 Apr 2015 15:47:46 -0400 From: Simon Marchi To: CC: Simon Marchi Subject: [PATCH v2 2/7] Cleanup some docs about memory write Date: Wed, 15 Apr 2015 15:47:33 -0400 Message-ID: <1429127258-1033-3-git-send-email-simon.marchi@ericsson.com> In-Reply-To: <1429127258-1033-1-git-send-email-simon.marchi@ericsson.com> References: <1429127258-1033-1-git-send-email-simon.marchi@ericsson.com> MIME-Version: 1.0 X-IsSubscribed: yes Some docs seemed outdated. In the case of target_write_memory, the docs in target.c and target/target.h diverged a bit, so I tried to find a reasonnable in-between version. gdb/ChangeLog: * corefile.c (write_memory): Update doc. * gdbcore.h (write_memory): Same. * target.c (target_write_memory): Same. * target/target.h (target_write_memory): Same. --- gdb/corefile.c | 4 ++-- gdb/gdbcore.h | 6 ++---- gdb/target.c | 6 +----- gdb/target/target.h | 10 +++++----- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/gdb/corefile.c b/gdb/corefile.c index a042e6d..83b0e80 100644 --- a/gdb/corefile.c +++ b/gdb/corefile.c @@ -383,8 +383,8 @@ read_memory_typed_address (CORE_ADDR addr, struct type *type) return extract_typed_address (buf, type); } -/* Same as target_write_memory, but report an error if can't - write. */ +/* See gdbcore.h. */ + void write_memory (CORE_ADDR memaddr, const bfd_byte *myaddr, ssize_t len) diff --git a/gdb/gdbcore.h b/gdb/gdbcore.h index 63a75f0..1106db8 100644 --- a/gdb/gdbcore.h +++ b/gdb/gdbcore.h @@ -101,10 +101,8 @@ extern void read_memory_string (CORE_ADDR, char *, int); CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type); -/* This takes a char *, not void *. This is probably right, because - passing in an int * or whatever is wrong with respect to - byteswapping, alignment, different sizes for host vs. target types, - etc. */ +/* Same as target_write_memory, but report an error if can't + write. */ extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, ssize_t len); diff --git a/gdb/target.c b/gdb/target.c index fcf7090..bd9a0eb 100644 --- a/gdb/target.c +++ b/gdb/target.c @@ -1464,11 +1464,7 @@ target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len) return TARGET_XFER_E_IO; } -/* Write LEN bytes from MYADDR to target memory at address MEMADDR. - Returns either 0 for success or TARGET_XFER_E_IO if any - error occurs. If an error occurs, no guarantee is made about how - much data got written. Callers that can deal with partial writes - should call target_write. */ +/* See target/target.h. */ int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, ssize_t len) diff --git a/gdb/target/target.h b/gdb/target/target.h index 05ac758..e0b7554 100644 --- a/gdb/target/target.h +++ b/gdb/target/target.h @@ -49,12 +49,12 @@ extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, extern int target_read_uint32 (CORE_ADDR memaddr, uint32_t *result); /* Write LEN bytes from MYADDR to target memory at address MEMADDR. - Return zero for success, nonzero if any error occurs. This + Return zero for success or TARGET_XFER_E_IO if any error occurs. This function must be provided by the client. Implementations of this - function may define and use their own error codes, but functions - in the common, nat and target directories must treat the return - code as opaque. No guarantee is made about the contents of the - data at MEMADDR if any error occurs. */ + function may define and use their own error codes, but functions in + the common, nat and target directories must treat the return code as + opaque. No guarantee is made about how much data got written if any + error occurs. */ extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, ssize_t len);