[patch] tsearch.3: dispose properly of allocated resources in example code

[patch] tsearch.3: dispose properly of allocated resources in example code

[André Goddard Rosa]

[-- Attachment #1: Type: text/plain, Size: 743 bytes --]

As there are many users who base their own code on these examples, we should avoid leaking memory when using functions of tsearch() family.
In the provided example, tsearch() leaks memory whenever it tries to insert a number which was already inserted before.

Please CC me, as I´m not subscribed.

Applies to man-pages-3.09.

--- man3/tsearch.3	2008-09-10 10:16:13.000000000 -0300
+++ man3/tsearch.3.goddard	2008-09-21 02:42:55.000000000 -0300
@@ -246,8 +246,11 @@
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
+        else if (!((*(int **) val) == ptr))
+            free(ptr);
     }
     twalk(root, action);
+    tdestroy(root, free);
     exit(EXIT_SUCCESS);
 }
 .fi
\0

[-- Attachment #2: tsearch3-free-allocated-resources.patch --]
[-- Type: text/x-patch, Size: 414 bytes --]

--- man3/tsearch.3	2008-09-10 10:16:13.000000000 -0300
+++ man3/tsearch.3.goddard	2008-09-21 02:42:55.000000000 -0300
@@ -246,8 +246,11 @@
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
+        else if (!((*(int **) val) == ptr))
+            free(ptr);
     }
     twalk(root, action);
+    tdestroy(root, free);
     exit(EXIT_SUCCESS);
 }
 .fi

Re: [patch] tsearch.3: dispose properly of allocated resources in example code

[Michael Kerrisk]

André,

On Sun, Sep 21, 2008 at 8:10 AM, André Goddard Rosa
<andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> As there are many users who base their own code on these examples, we
> should avoid leaking memory when using functions of tsearch() family.
> In the provided example, tsearch() leaks memory whenever it tries to
> insert a number which was already inserted before.

Thanks.  My first patch applied via 'git am'!

I applied this patch for man-pages-3.10.  (I added
#define _GNU_SOURCE
since that's required to expose the tdestroy() declaration.)

Cheers,

Michael

> --- man3/tsearch.3      2008-09-10 10:16:13.000000000 -0300
> +++ man3/tsearch.3.goddard      2008-09-21 02:42:55.000000000 -0300
> @@ -246,8 +246,11 @@
>         val = tsearch((void *) ptr, &root, compare);
>         if (val == NULL)
>             exit(EXIT_FAILURE);
> +        else if (!((*(int **) val) == ptr))
> +            free(ptr);
>     }
>     twalk(root, action);
> +    tdestroy(root, free);
>     exit(EXIT_SUCCESS);
>  }
>  .fi
>
>



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [patch] tsearch.3: dispose properly of allocated resources in example code

[André Goddard Rosa]

On Tue, Sep 23, 2008 at 3:28 AM, Michael Kerrisk
<mtk.manpages-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org> wrote:
> André,
>
> On Sun, Sep 21, 2008 at 8:10 AM, André Goddard Rosa
> <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>> As there are many users who base their own code on these examples, we
>> should avoid leaking memory when using functions of tsearch() family.
>> In the provided example, tsearch() leaks memory whenever it tries to
>> insert a number which was already inserted before.
>
> Thanks.  My first patch applied via 'git am'!
>
> I applied this patch for man-pages-3.10.  (I added
> #define _GNU_SOURCE
> since that's required to expose the tdestroy() declaration.)
>

Hi, Michael!

    Very nice, thank you! Good to know that you're using git.

    I appreciate your work in the man pages, they were improved a lot
since you've started working on them. Also, I appreciate your concerns
regarding paccept().

    Notice that I sent two different patches in a sequence (sorry for that).

This is the first one:

> +        else if (!((*(int **) val) == ptr))

and this is the second one:

+        else if ((*(int **) val) != ptr)

    They work the same, but second is cleaner and simpler ;-)

Kind regards,
-- 
[]s,
André Goddard
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [patch] tsearch.3: dispose properly of allocated resources in example code

[Michael Kerrisk]

André,

On Tue, Sep 23, 2008 at 3:23 PM, André Goddard Rosa
<andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> On Tue, Sep 23, 2008 at 3:28 AM, Michael Kerrisk
> <mtk.manpages-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org> wrote:
>> André,
>>
>> On Sun, Sep 21, 2008 at 8:10 AM, André Goddard Rosa
>> <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>>> As there are many users who base their own code on these examples, we
>>> should avoid leaking memory when using functions of tsearch() family.
>>> In the provided example, tsearch() leaks memory whenever it tries to
>>> insert a number which was already inserted before.
>>
>> Thanks.  My first patch applied via 'git am'!
>>
>> I applied this patch for man-pages-3.10.  (I added
>> #define _GNU_SOURCE
>> since that's required to expose the tdestroy() declaration.)
>>
>
> Hi, Michael!
>
>    Very nice, thank you! Good to know that you're using git.

(At last... '-).)

>    I appreciate your work in the man pages, they were improved a lot
> since you've started working on them.

Thanks!

> Also, I appreciate your concerns
> regarding paccept().
>
>    Notice that I sent two different patches in a sequence (sorry for that).

It's a good thing you mentioned this, since I did _not_ notice that:
you sent two mails at almost the same, with the same description, and
which looked otherwise identical (unless one looked very close), so I
assumed you had accidentally sent the same mail twice.  (Best to
change the description a little so I know you are resending a
different patch.)

> This is the first one:
>
>> +        else if (!((*(int **) val) == ptr))
>
> and this is the second one:
>
> +        else if ((*(int **) val) != ptr)
>
>    They work the same, but second is cleaner and simpler ;-)

Okay -- I've fixed the page to use the second version.  And you only
just got that one in in time for 3.10!

Thanks,

Michael
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[patch] hsearch.3: Call hdestroy() after using hash table created by hcreate(), for the sake of completeness

[André Goddard Rosa]

[-- Attachment #1: Type: text/plain, Size: 868 bytes --]

From dc0f26d3112519229671c621832f87a48e972642 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard@gmail.com>
Date: Wed, 24 Sep 2008 10:59:37 -0300
Subject: [PATCH] Call hdestroy() after using hash table created by hcreate(), for the sake of completeness.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

Signed-off-by: André Goddard Rosa <andre.goddard@gmail.com>
---
 man3/hsearch.3 |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/man3/hsearch.3 b/man3/hsearch.3
index 16e3b6b..d5ae21c 100644
--- a/man3/hsearch.3
+++ b/man3/hsearch.3
@@ -325,6 +325,7 @@ main(void)
         printf("%9.9s \-> %9.9s:%d\\n", e.key,
                ep ? ep\->key : "NULL", ep ? (int)(ep\->data) : 0);
     }
+    hdestroy();
     exit(EXIT_SUCCESS);
 }
 .fi
-- 
1.6.0.2.508.g24593

\0

[-- Attachment #2: 0001-Call-hdestroy-after-using-hash-table-created-by-hc.patch --]
[-- Type: text/x-patch, Size: 924 bytes --]

From dc0f26d3112519229671c621832f87a48e972642 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard@gmail.com>
Date: Wed, 24 Sep 2008 10:59:37 -0300
Subject: [PATCH] Call hdestroy() after using hash table created by hcreate(), for the sake of completeness.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

Signed-off-by: André Goddard Rosa <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 man3/hsearch.3 |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/man3/hsearch.3 b/man3/hsearch.3
index 16e3b6b..d5ae21c 100644
--- a/man3/hsearch.3
+++ b/man3/hsearch.3
@@ -325,6 +325,7 @@ main(void)
         printf("%9.9s \-> %9.9s:%d\\n", e.key,
                ep ? ep\->key : "NULL", ep ? (int)(ep\->data) : 0);
     }
+    hdestroy();
     exit(EXIT_SUCCESS);
 }
 .fi
-- 
1.6.0.2.508.g24593

Re: [patch] hsearch.3: Call hdestroy() after using hash table created by hcreate(), for the sake of completeness

[Michael Kerrisk]

Andre,

On Wed, Sep 24, 2008 at 4:01 PM, André Goddard Rosa
<andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> From dc0f26d3112519229671c621832f87a48e972642 Mon Sep 17 00:00:00 2001
> From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> Date: Wed, 24 Sep 2008 10:59:37 -0300
> Subject: [PATCH] Call hdestroy() after using hash table created by hcreate(), for the sake of completeness.
> MIME-Version: 1.0
> Content-Type: text/plain; charset=utf-8
> Content-Transfer-Encoding: 8bit
>
> Signed-off-by: André Goddard Rosa <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> ---
>  man3/hsearch.3 |    1 +
>  1 files changed, 1 insertions(+), 0 deletions(-)
>
> diff --git a/man3/hsearch.3 b/man3/hsearch.3
> index 16e3b6b..d5ae21c 100644
> --- a/man3/hsearch.3
> +++ b/man3/hsearch.3
> @@ -325,6 +325,7 @@ main(void)
>         printf("%9.9s \-> %9.9s:%d\\n", e.key,
>                ep ? ep\->key : "NULL", ep ? (int)(ep\->data) : 0);
>     }
> +    hdestroy();
>     exit(EXIT_SUCCESS);
>  }
>  .fi

Yes, good idea.  Thanks.  Applied for 3.11.

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[patch] strcpy.3: Avoid redundantly filling the position 'n - 1' two times in strncpy() example code

[André Goddard Rosa]

[-- Attachment #1: Type: text/plain, Size: 980 bytes --]

From 88a02845c606413444bfb055935303b4896d0271 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard@gmail.com>
Date: Wed, 24 Sep 2008 10:25:08 -0300
Subject: [PATCH] Avoid redundantly filling the position 'n - 1' two times in strncpy() example code.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

When we use 'strncpy(buf, str, n)', strncpy() will fill chars from 0..(n - 1).
As we force the character at position 'n - 1' to be '\0' anyway, don't fill it in strncpy() before.

Signed-off-by: André Goddard Rosa <andre.goddard@gmail.com>
---
 man3/strcpy.3 |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/man3/strcpy.3 b/man3/strcpy.3
index 7a8091f..d2e08a3 100644
--- a/man3/strcpy.3
+++ b/man3/strcpy.3
@@ -115,7 +115,7 @@ as follows:
 .in +4n
 .nf
 
-strncpy(buf, str, n);
+strncpy(buf, str, n \- 1);
 if (n > 0)
     buf[n \- 1]= \(aq\\0\(aq;
 .fi
-- 
1.6.0.2.508.g24593

\0

[-- Attachment #2: 0001-Avoid-redundantly-filling-the-position-n-1-two-t.patch --]
[-- Type: text/x-patch, Size: 1040 bytes --]

From 88a02845c606413444bfb055935303b4896d0271 Mon Sep 17 00:00:00 2001
From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard@gmail.com>
Date: Wed, 24 Sep 2008 10:25:08 -0300
Subject: [PATCH] Avoid redundantly filling the position 'n - 1' two times in strncpy() example code.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

When we use 'strncpy(buf, str, n)', strncpy() will fill chars from 0..(n - 1).
As we force the character at position 'n - 1' to be '\0' anyway, don't fill it in strncpy() before.

Signed-off-by: André Goddard Rosa <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 man3/strcpy.3 |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/man3/strcpy.3 b/man3/strcpy.3
index 7a8091f..d2e08a3 100644
--- a/man3/strcpy.3
+++ b/man3/strcpy.3
@@ -115,7 +115,7 @@ as follows:
 .in +4n
 .nf
 
-strncpy(buf, str, n);
+strncpy(buf, str, n \- 1);
 if (n > 0)
     buf[n \- 1]= \(aq\\0\(aq;
 .fi
-- 
1.6.0.2.508.g24593

Re: [patch] strcpy.3: Avoid redundantly filling the position 'n - 1' two times in strncpy() example code

[Michael Kerrisk]

Hi Andre,

On Wed, Sep 24, 2008 at 4:01 PM, André Goddard Rosa
<andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> From 88a02845c606413444bfb055935303b4896d0271 Mon Sep 17 00:00:00 2001
> From: =?utf-8?q?Andr=C3=A9=20Goddard=20Rosa?= <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> Date: Wed, 24 Sep 2008 10:25:08 -0300
> Subject: [PATCH] Avoid redundantly filling the position 'n - 1' two times in strncpy() example code.
> MIME-Version: 1.0
> Content-Type: text/plain; charset=utf-8
> Content-Transfer-Encoding: 8bit
>
> When we use 'strncpy(buf, str, n)', strncpy() will fill chars from 0..(n - 1).
> As we force the character at position 'n - 1' to be '\0' anyway, don't fill it in strncpy() before.

Thanks!  Applied for 3.11.

Cheers,

Michael

> Signed-off-by: André Goddard Rosa <andre.goddard-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
> ---
>  man3/strcpy.3 |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/man3/strcpy.3 b/man3/strcpy.3
> index 7a8091f..d2e08a3 100644
> --- a/man3/strcpy.3
> +++ b/man3/strcpy.3
> @@ -115,7 +115,7 @@ as follows:
>  .in +4n
>  .nf
>
> -strncpy(buf, str, n);
> +strncpy(buf, str, n \- 1);
>  if (n > 0)
>     buf[n \- 1]= \(aq\\0\(aq;
>  .fi
> --
> 1.6.0.2.508.g24593
>
>
>



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html